Global application settings controlling how Visualization Library behaves. More...
#include <GlobalSettings.hpp>
Inheritance diagram for vl::GlobalSettings:
Public Member Functions | |
| GlobalSettings () | |
| void | setCheckOpenGLStates (bool check_clean) |
If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL. More... | |
| bool | checkOpenGLStates () const |
If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL. More... | |
| void | setVerbosityLevel (EVerbosityLevel verb_level) |
| The verbosity level of VL. More... | |
| EVerbosityLevel | verbosityLevel () const |
| The verbosity level of VL. More... | |
| const String & | defaultLogPath () const |
| The path of the default log file. More... | |
| const String & | defaultDataPath () const |
| The path of the default data directory. More... | |
| Public Member Functions inherited from vl::Object | |
| Object () | |
| Constructor. More... | |
| Object (const Object &other) | |
| Copy constructor: copies the name, ref count mutex and user data. More... | |
| Object & | operator= (const Object &other) |
| Copy operator: copies the object's name, ref count mutex and user data. More... | |
| const std::string & | objectName () const |
| The name of the object, by default set to the object's class name. More... | |
| void | setObjectName (const char *name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setObjectName (const std::string &name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setRefCountMutex (IMutex *mutex) |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| IMutex * | refCountMutex () |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| const IMutex * | refCountMutex () const |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| int | referenceCount () const |
| Returns the number of references of an object. More... | |
| void | incReference () const |
| Increments the reference count of an object. More... | |
| void | decReference () |
Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More... | |
| void | setAutomaticDelete (bool autodel_on) |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| bool | automaticDelete () const |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| template<class T > | |
| T * | as () |
| Casts an Object to the specified class. More... | |
| template<class T > | |
| const T * | as () const |
| Casts an Object to the specified class. More... | |
Protected Attributes | |
| EVerbosityLevel | mVerbosityLevel |
| bool | mCheckOpenGLStates |
| String | mDefaultLogPath |
| String | mDefaultDataPath |
| Protected Attributes inherited from vl::Object | |
| std::string | mObjectName |
| IMutex * | mRefCountMutex |
| int | mReferenceCount |
| bool | mAutomaticDelete |
Friends | |
| class | VisualizationLibrary |
Additional Inherited Members | |
| Protected Member Functions inherited from vl::Object | |
| virtual | ~Object () |
Detailed Description
Global application settings controlling how Visualization Library behaves.
Definition at line 41 of file GlobalSettings.hpp.
Constructor & Destructor Documentation
◆ GlobalSettings()
| GlobalSettings::GlobalSettings | ( | ) |
Definition at line 39 of file GlobalSettings.cpp.
References mCheckOpenGLStates, mDefaultDataPath, mDefaultLogPath, mVerbosityLevel, NULL, setCheckOpenGLStates(), setVerbosityLevel(), vl::VEL_VERBOSITY_DEBUG, vl::VEL_VERBOSITY_ERROR, vl::VEL_VERBOSITY_NORMAL, and vl::VEL_VERBOSITY_SILENT.
Member Function Documentation
◆ checkOpenGLStates()
|
inline |
If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.
If the test fails it can mean that either there is a bug in VL or that the user did not restore the OpenGL states to a VL friendly state after modifying them.
- Note
- This can slow down the rendering. Enabled by default in DEBUG mode only.
Definition at line 62 of file GlobalSettings.hpp.
◆ defaultDataPath()
|
inline |
The path of the default data directory.
Definition at line 74 of file GlobalSettings.hpp.
◆ defaultLogPath()
|
inline |
The path of the default log file.
Definition at line 71 of file GlobalSettings.hpp.
◆ setCheckOpenGLStates()
|
inline |
If true VL checks at the beginning of each rendering that the OpenGL states are clean and ready to be used by VL.
If the test fails it can mean that either there is a bug in VL or that the user did not restore the OpenGL states to a VL friendly state after modifying them.
- Note
- This can slow down the rendering. Enabled by default in DEBUG mode only.
Definition at line 55 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
◆ setVerbosityLevel()
|
inline |
The verbosity level of VL.
This applies to all the logs generated via vl::Log::*.
Definition at line 65 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
◆ verbosityLevel()
|
inline |
The verbosity level of VL.
This applies to all the logs generated via vl::Log::*.
Definition at line 68 of file GlobalSettings.hpp.
Friends And Related Function Documentation
◆ VisualizationLibrary
|
friend |
Definition at line 43 of file GlobalSettings.hpp.
Member Data Documentation
◆ mCheckOpenGLStates
|
protected |
Definition at line 78 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
◆ mDefaultDataPath
|
protected |
Definition at line 80 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
◆ mDefaultLogPath
|
protected |
Definition at line 79 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
◆ mVerbosityLevel
|
protected |
Definition at line 77 of file GlobalSettings.hpp.
Referenced by GlobalSettings().
The documentation for this class was generated from the following files:
- C:/git/VL/src/vlCore/GlobalSettings.hpp
- C:/git/VL/src/vlCore/GlobalSettings.cpp