cee::vis::VisualizationComponent Class Reference

Static class for initialization of the Visualization component. More...

Static Public Member Functions

static bool initialize (Instance *instance)
 One time initialization of the Visualization component. More...
 
static bool isInitialized ()
 Returns true if the Visualization Component has been properly initialized. More...
 
static bool isNoLicense ()
 Returns true if no license was provided (license code (0,0)). More...
 
static unsigned int version ()
 Returns the component version as a single unsigned integer. More...
 
static Str versionString ()
 Returns the component version as a string. More...
 
static PtrRef< OpenGLContextGroupcreateOpenGLContextGroup ()
 Creates an OpenGL context group to use in the viewers. More...
 
static PtrRef< OpenGLContextGroupcreateOpenGLContextGroup (OpenGLFunctionsBackend *functionsBackend)
 Creates an OpenGL context group to use in the viewers. More...
 

Detailed Description

Static class for initialization of the Visualization component.

Member Function Documentation

PtrRef< OpenGLContextGroup > cee::vis::VisualizationComponent::createOpenGLContextGroup ( )
static

Creates an OpenGL context group to use in the viewers.

Note
This method must be called after initialize() and can only be called once. Only one context group is allowed.
PtrRef< OpenGLContextGroup > cee::vis::VisualizationComponent::createOpenGLContextGroup ( OpenGLFunctionsBackend *  functionsBackend)
static

Creates an OpenGL context group to use in the viewers.

Accepts a user defined OpenGL functions back-end that will be used for this context group.

Note
The passed functions back-end will be owned and deleted by the context group. This method must be called after initialize() and can only be called once. Only one context group is allowed.
bool cee::vis::VisualizationComponent::initialize ( Instance instance)
static

One time initialization of the Visualization component.

Initialization should be done once per process. After successful initialization, any subsequent calls to this function will do nothing and silently return true.

bool cee::vis::VisualizationComponent::isInitialized ( )
static

Returns true if the Visualization Component has been properly initialized.

bool cee::vis::VisualizationComponent::isNoLicense ( )
static

Returns true if no license was provided (license code (0,0)).

unsigned int cee::vis::VisualizationComponent::version ( )
static

Returns the component version as a single unsigned integer.

Version is returned on the form 0xMMNNPP (MM=major, NN=minor, PP=patch)

Str cee::vis::VisualizationComponent::versionString ( )
static

Returns the component version as a string.