VR-Engage  2.2
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | List of all members
makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator > Class Template Reference

Detailed Description

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
class makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >
Template Parameters
VreGlstudioUpdaterUpdater class to create
GlstudioUpdaterCreatorBase creator class

Factory template that creates instances of GLStudio updaters with simulation state awareness. It allows replacing existing updaters or creating new ones.

#include <vreGlstudioUpdater.h>

Inheritance diagram for makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >:
[legend]

Public Member Functions

 DtVreGlstudioUpdaterCreator (const std::string &stateAttribute)
 
 DtVreGlstudioUpdaterCreator (const std::string &stateAttribute, const std::string &name)
 
virtual ~DtVreGlstudioUpdaterCreator ()
 
virtual makVrv::DtGlStudioAttributeUpdater * create () const
 

Public Attributes

std::string myStateAttribute
 

Private Member Functions

 DtVreGlstudioUpdaterCreator ()
 

Constructor & Destructor Documentation

◆ DtVreGlstudioUpdaterCreator() [1/3]

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::DtVreGlstudioUpdaterCreator ( const std::string & stateAttribute)
inline

Constructor for replacing an existing updater.

Parameters
stateAttributeName of the state attribute to associate with

Use this constructor to replace an existing updater with a VRE-aware version.

References myStateAttribute.

◆ DtVreGlstudioUpdaterCreator() [2/3]

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::DtVreGlstudioUpdaterCreator ( const std::string & stateAttribute,
const std::string & name )
inline

Constructor for creating a new updater with a custom name.

Parameters
stateAttributeName of the state attribute to associate with
nameCustom name for the updater

Use this constructor to install this updater with a new name, instead of replacing the base class updater.

References myStateAttribute.

◆ ~DtVreGlstudioUpdaterCreator()

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
virtual makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::~DtVreGlstudioUpdaterCreator ( )
inlinevirtual

Virtual destructor.

◆ DtVreGlstudioUpdaterCreator() [3/3]

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::DtVreGlstudioUpdaterCreator ( )
private

Member Function Documentation

◆ create()

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
virtual makVrv::DtGlStudioAttributeUpdater * makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::create ( ) const
inlinevirtual

Creates a new instance of the updater.

Returns
Pointer to a newly created updater

Creates a new VRE GLStudio updater instance and configures its state attribute.

References myStateAttribute.

Member Data Documentation

◆ myStateAttribute

template<typename VreGlstudioUpdater, typename GlstudioUpdaterCreator>
std::string makVre::DtVreGlstudioUpdaterCreator< VreGlstudioUpdater, GlstudioUpdaterCreator >::myStateAttribute

Referenced by create(), DtVreGlstudioUpdaterCreator(), and DtVreGlstudioUpdaterCreator().

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