VR-Forces 4.0.4 Class Documentation
Public Member Functions
makVrv::DtObserverSettingsInterface Class Reference

This is the interface for the DtObserverSettingsPage. More...

Inheritance diagram for makVrv::DtObserverSettingsInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~DtObserverSettingsInterface ()
 DTOR.
virtual int currentObserverIndex () const =0
 Get the current observer index, if there are no observer instances this function returns -1.
virtual std::string currentObserverName () const =0
 Get the current observer instance name.
virtual int findObserverInstanceIndex (const std::string &instanceName)=0
 Find the index for an observer instance name.
virtual void setObserverInstanceNames (const std::list< std::string > &instanceNames)=0
 Set the current observer instance names.
virtual void setCurrentObserverIndex (int i)=0
 Set the current observer instance by index.
virtual void setCurrentObserverInstanceName (const std::string &instanceName)=0
 Uses find instance index to set the current index by name.
virtual void addObserverInstance (std::string name, int index=-1)=0
 Adds a new observer instance.
virtual void removeObserverInstance (int i)=0
 Removes the observer instance at i.
virtual void setDeleteObserverEnabled (bool enabled)=0
 enable/disable observer deletion
virtual int currentObserverModeIndex () const =0
 Get the current observer mode index, if there are no observer mode instances this functionreturns -1.
virtual std::string currentObserverModeName () const =0
 Get the current observer mode instance name.
virtual int findObserverModeInstanceIndex (const std::string &instanceName)=0
 Find the index for an observer mode instance name.
virtual void setObserverModeInstanceNames (const std::list< std::string > &instanceNames)=0
 Set the current observer mode instance names.
virtual void setCurrentObserverModeIndex (int i)=0
 Set the current observer mode instance by index.
virtual void setCurrentObserverModeInstanceName (const std::string &instanceName)=0
 Uses find instance index to set the current index by name.
virtual void addObserverModeInstance (std::string name, int index=-1)=0
 Adds a new observer mode instance.
virtual void removeObserverModeInstance (int i)=0
 Removes the observer mode instance at i.
virtual void observerCreateRequestFailed (const std::string &observerName)=0
virtual void addModelSet (int modelSet, const std::string &displayName)=0
virtual void setCurrentModelSet (int modelSet)=0
virtual void addProjection (const std::string &projectionName)=0
virtual void setCurrentProjection (const std::string &projectionName)=0
virtual void addKeyMap (const std::string &keyMapName)=0
virtual void setCurrentKeyMap (const std::string &keyMapName)=0
virtual void setModelScaleFactorSlider (int factor)=0
virtual void enableModelScaleFactorSlider (bool enable)=0
virtual void setModelScaleFactorSliderMaximum (int maximum)=0
virtual void setModelScaleTypeSelector (DtObserverObject::ScaleType scaleType)=0
virtual void enableModelScaleTypeSelector (bool enable)=0
virtual void setMaxModelScaleFactorSpinBox (double maxScaleFactor)=0
virtual void enableMaxModelScaleFactorSpinBox (bool enable)=0
virtual void setOrbitSpeedGainSlider (int gain)=0
virtual void setRotationSpeedGainSlider (int gain)=0
virtual void setLinearSpeedGainSlider (int gain)=0
virtual void setSliderGainPrecision (int precision)=0
virtual void clearObserverSettings ()=0
virtual void addObserverSetting (int key, const std::string &displayName)=0
virtual void setObserverSetting (const std::string &displayName, bool checked)=0

Detailed Description

This is the interface for the DtObserverSettingsPage.


Constructor & Destructor Documentation

DTOR.


Member Function Documentation

virtual int makVrv::DtObserverSettingsInterface::currentObserverIndex ( ) const [pure virtual]

Get the current observer index, if there are no observer instances this function returns -1.

Implemented in makVrv::DtObserverSettingsPage.

virtual std::string makVrv::DtObserverSettingsInterface::currentObserverName ( ) const [pure virtual]

Get the current observer instance name.

If there is no instances this function returns an empty string.

Implemented in makVrv::DtObserverSettingsPage.

virtual int makVrv::DtObserverSettingsInterface::findObserverInstanceIndex ( const std::string &  instanceName) [pure virtual]

Find the index for an observer instance name.

Returns -1 if the instance is invalid.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setObserverInstanceNames ( const std::list< std::string > &  instanceNames) [pure virtual]

Set the current observer instance names.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setCurrentObserverIndex ( int  i) [pure virtual]

Set the current observer instance by index.

If the index is out of range the current index will not change

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setCurrentObserverInstanceName ( const std::string &  instanceName) [pure virtual]

Uses find instance index to set the current index by name.

If the observer instance name does not exist this function will not change The index.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::addObserverInstance ( std::string  name,
int  index = -1 
) [pure virtual]

Adds a new observer instance.

Parameters:
Input
nameis the name of the instance to display.
indexis the optional index of the instance, -1 means append to end.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::removeObserverInstance ( int  i) [pure virtual]

Removes the observer instance at i.

The current index will change based upon the following conditions: If # of instance = 0, current index -> -1 if current index was 0, current index -> 0 else, current index -> current index - 1

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setDeleteObserverEnabled ( bool  enabled) [pure virtual]

enable/disable observer deletion

Implemented in makVrv::DtObserverSettingsPage.

Get the current observer mode index, if there are no observer mode instances this functionreturns -1.

Implemented in makVrv::DtObserverSettingsPage.

virtual std::string makVrv::DtObserverSettingsInterface::currentObserverModeName ( ) const [pure virtual]

Get the current observer mode instance name.

If there is no instances this function returns an empty string.

Implemented in makVrv::DtObserverSettingsPage.

virtual int makVrv::DtObserverSettingsInterface::findObserverModeInstanceIndex ( const std::string &  instanceName) [pure virtual]

Find the index for an observer mode instance name.

Returns -1 if the instance is invalid.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setObserverModeInstanceNames ( const std::list< std::string > &  instanceNames) [pure virtual]

Set the current observer mode instance names.

Implemented in makVrv::DtObserverSettingsPage.

Set the current observer mode instance by index.

If the index is out of range the current index will not change

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::setCurrentObserverModeInstanceName ( const std::string &  instanceName) [pure virtual]

Uses find instance index to set the current index by name.

If the observer mode instance name does not exist this function will not change The index.

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::addObserverModeInstance ( std::string  name,
int  index = -1 
) [pure virtual]

Adds a new observer mode instance.

Parameters:
Input
nameis the name of the instance to display.
indexis the optional index of the instance, -1 means append to end.

Implemented in makVrv::DtObserverSettingsPage.

Removes the observer mode instance at i.

The current index will change based upon the following conditions: If # of instance = 0, current index -> -1 if current index was 0, current index -> 0 else, current index -> current index - 1

Implemented in makVrv::DtObserverSettingsPage.

virtual void makVrv::DtObserverSettingsInterface::observerCreateRequestFailed ( const std::string &  observerName) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::addModelSet ( int  modelSet,
const std::string &  displayName 
) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setCurrentModelSet ( int  modelSet) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::addProjection ( const std::string &  projectionName) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setCurrentProjection ( const std::string &  projectionName) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::addKeyMap ( const std::string &  keyMapName) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setCurrentKeyMap ( const std::string &  keyMapName) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setModelScaleFactorSlider ( int  factor) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setModelScaleFactorSliderMaximum ( int  maximum) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setMaxModelScaleFactorSpinBox ( double  maxScaleFactor) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setOrbitSpeedGainSlider ( int  gain) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setRotationSpeedGainSlider ( int  gain) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setLinearSpeedGainSlider ( int  gain) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setSliderGainPrecision ( int  precision) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::addObserverSetting ( int  key,
const std::string &  displayName 
) [pure virtual]
virtual void makVrv::DtObserverSettingsInterface::setObserverSetting ( const std::string &  displayName,
bool  checked 
) [pure virtual]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)