vl::Settings Class Reference

Global application settings controlling how Visualization Library behaves. More...

#include <VisualizationLibrary.hpp>

Inheritance diagram for vl::Settings:

List of all members.

Public Member Functions
	Settings ()
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.
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.
void	setCheckTransformSiblings (bool check_on)
	If true VL checks that there are no duplicates in a Transform children list.
bool	checkTransformSiblings () const
	If true VL checks that there are no duplicates in a Transform children list.
void	setVerbosityLevel (EVerbosityLevel verb_level)
	The verbosity level of VL.
EVerbosityLevel	verbosityLevel () const
	The verbosity level of VL.
const String &	defaultLogPath () const
	The path of the default log file.
const String &	defaultDataPath () const
	The path of the default data directory.
Protected Attributes
EVerbosityLevel	mVerbosityLevel
bool	mCheckOpenGLStates
bool	mCheckTransformSiblings
String	mDefaultLogPath
String	mDefaultDataPath
Friends
class	VisualizationLibrary

---

Detailed Description

Global application settings controlling how Visualization Library behaves.

---

Constructor & Destructor Documentation

vl::Settings::Settings

(

)

[inline]

---

Member Function Documentation

void vl::Settings::setCheckOpenGLStates

(

bool

check_clean )

[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.

bool vl::Settings::checkOpenGLStates

(

)

const [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.

void vl::Settings::setCheckTransformSiblings

(

bool

check_on )

[inline]

If true VL checks that there are no duplicates in a Transform children list.

Note:

This can slow down considerably the insertion of new child Transforms. Enabled by default in DEBUG mode only.

bool vl::Settings::checkTransformSiblings

(

)

const [inline]

If true VL checks that there are no duplicates in a Transform children list.

Note:

This can slow down considerably the insertion of new child Transforms. Enabled by default in DEBUG mode only.

void vl::Settings::setVerbosityLevel

(

EVerbosityLevel

verb_level )

[inline]

The verbosity level of VL.

This applies to all the logs generated via vl::Log::*.

EVerbosityLevel vl::Settings::verbosityLevel

(

)

const [inline]

The verbosity level of VL.

This applies to all the logs generated via vl::Log::*.

const String& vl::Settings::defaultLogPath

(

)

const [inline]

The path of the default log file.

const String& vl::Settings::defaultDataPath

(

)

const [inline]

The path of the default data directory.

---

Friends And Related Function Documentation

friend class VisualizationLibrary [friend]

---

Member Data Documentation

EVerbosityLevel vl::Settings::mVerbosityLevel [protected]

bool vl::Settings::mCheckOpenGLStates [protected]

bool vl::Settings::mCheckTransformSiblings [protected]

String vl::Settings::mDefaultLogPath [protected]

String vl::Settings::mDefaultDataPath [protected]

---

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

• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/VisualizationLibrary.hpp