Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | Friends | List of all members
vl::GlobalSettings Class Reference

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 StringdefaultLogPath () const
 The path of the default log file. More...
 
const StringdefaultDataPath () 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...
 
Objectoperator= (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...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () 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
 
IMutexmRefCountMutex
 
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 ( )

Member Function Documentation

◆ checkOpenGLStates()

bool vl::GlobalSettings::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.

Definition at line 62 of file GlobalSettings.hpp.

◆ defaultDataPath()

const String& vl::GlobalSettings::defaultDataPath ( ) const
inline

The path of the default data directory.

Definition at line 74 of file GlobalSettings.hpp.

◆ defaultLogPath()

const String& vl::GlobalSettings::defaultLogPath ( ) const
inline

The path of the default log file.

Definition at line 71 of file GlobalSettings.hpp.

◆ setCheckOpenGLStates()

void vl::GlobalSettings::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.

Definition at line 55 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

◆ setVerbosityLevel()

void vl::GlobalSettings::setVerbosityLevel ( EVerbosityLevel  verb_level)
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()

EVerbosityLevel vl::GlobalSettings::verbosityLevel ( ) const
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 class VisualizationLibrary
friend

Definition at line 43 of file GlobalSettings.hpp.

Member Data Documentation

◆ mCheckOpenGLStates

bool vl::GlobalSettings::mCheckOpenGLStates
protected

Definition at line 78 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

◆ mDefaultDataPath

String vl::GlobalSettings::mDefaultDataPath
protected

Definition at line 80 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

◆ mDefaultLogPath

String vl::GlobalSettings::mDefaultLogPath
protected

Definition at line 79 of file GlobalSettings.hpp.

Referenced by GlobalSettings().

◆ mVerbosityLevel

EVerbosityLevel vl::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: