Blue Brain BioExplorer
Public Member Functions | List of all members
core::ParametersManager Class Reference

#include <ParametersManager.h>

Public Member Functions

 ParametersManager (int argc, const char **argv)
 
PLATFORM_API void registerParameters (AbstractParameters *parameters)
 
PLATFORM_API void usage ()
 
PLATFORM_API void print ()
 
PLATFORM_API AnimationParameters & getAnimationParameters ()
 
PLATFORM_API const AnimationParameters & getAnimationParameters () const
 
PLATFORM_API RenderingParameters & getRenderingParameters ()
 
PLATFORM_API const RenderingParameters & getRenderingParameters () const
 
PLATFORM_API GeometryParameters & getGeometryParameters ()
 
PLATFORM_API const GeometryParameters & getGeometryParameters () const
 
PLATFORM_API ApplicationParameters & getApplicationParameters ()
 
PLATFORM_API const ApplicationParameters & getApplicationParameters () const
 
PLATFORM_API VolumeParameters & getVolumeParameters ()
 
PLATFORM_API const VolumeParameters & getVolumeParameters () const
 
PLATFORM_API FieldParameters & getFieldParameters ()
 
PLATFORM_API const FieldParameters & getFieldParameters () const
 
void resetModified ()
 
bool isAnyModified () const
 

Detailed Description

Class managing all parameters registered by the application. By default this class create an instance of Application, Rendering, and Geometry parameters are registered. Other parameters can also be added using the registerParameters method for as long as they are inherited from AbstractParameters.

Definition at line 43 of file ParametersManager.h.

Constructor & Destructor Documentation

◆ ParametersManager()

core::ParametersManager::ParametersManager ( int  argc,
const char **  argv 
)

Definition at line 112 of file ParametersManager.cpp.

Member Function Documentation

◆ getAnimationParameters() [1/2]

AnimationParameters & core::ParametersManager::getAnimationParameters ( )

Gets animation parameters

Returns
Animation parameters for the current scene

Definition at line 209 of file ParametersManager.cpp.

◆ getAnimationParameters() [2/2]

const AnimationParameters & core::ParametersManager::getAnimationParameters ( ) const

Definition at line 214 of file ParametersManager.cpp.

◆ getApplicationParameters() [1/2]

ApplicationParameters & core::ParametersManager::getApplicationParameters ( )

Gets application parameters

Returns
Application parameters for the current scene

Definition at line 219 of file ParametersManager.cpp.

◆ getApplicationParameters() [2/2]

const ApplicationParameters & core::ParametersManager::getApplicationParameters ( ) const

Definition at line 224 of file ParametersManager.cpp.

◆ getFieldParameters() [1/2]

FieldParameters & core::ParametersManager::getFieldParameters ( )

Gets field parameters

Returns
Parameters for the current field

Definition at line 259 of file ParametersManager.cpp.

◆ getFieldParameters() [2/2]

const FieldParameters & core::ParametersManager::getFieldParameters ( ) const

Definition at line 264 of file ParametersManager.cpp.

◆ getGeometryParameters() [1/2]

GeometryParameters & core::ParametersManager::getGeometryParameters ( )

Gets geometry parameters

Returns
Geometry parameters for the current scene

Definition at line 239 of file ParametersManager.cpp.

◆ getGeometryParameters() [2/2]

const GeometryParameters & core::ParametersManager::getGeometryParameters ( ) const

Definition at line 244 of file ParametersManager.cpp.

◆ getRenderingParameters() [1/2]

RenderingParameters & core::ParametersManager::getRenderingParameters ( )

Gets rendering parameters

Returns
Rendering parameters for the current scene

Definition at line 229 of file ParametersManager.cpp.

◆ getRenderingParameters() [2/2]

const RenderingParameters & core::ParametersManager::getRenderingParameters ( ) const

Definition at line 234 of file ParametersManager.cpp.

◆ getVolumeParameters() [1/2]

VolumeParameters & core::ParametersManager::getVolumeParameters ( )

Gets volume parameters

Returns
Parameters for the current volume

Definition at line 249 of file ParametersManager.cpp.

◆ getVolumeParameters() [2/2]

const VolumeParameters & core::ParametersManager::getVolumeParameters ( ) const

Definition at line 254 of file ParametersManager.cpp.

◆ isAnyModified()

bool core::ParametersManager::isAnyModified ( ) const
Returns
true if any of the parameters has been modified since the last resetModified().

Definition at line 199 of file ParametersManager.cpp.

◆ print()

void core::ParametersManager::print ( )

Displays values registered parameters

Definition at line 187 of file ParametersManager.cpp.

◆ registerParameters()

void core::ParametersManager::registerParameters ( AbstractParameters *  parameters)

Registers specific parameters to the manager

Parameters
parametersto be registered

Definition at line 126 of file ParametersManager.cpp.

◆ resetModified()

void core::ParametersManager::resetModified ( )

Call resetModified on all parameters.

Definition at line 193 of file ParametersManager.cpp.

◆ usage()

void core::ParametersManager::usage ( )

Displays usage of registered parameters

Definition at line 182 of file ParametersManager.cpp.

The documentation for this class was generated from the following files: