VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
makVrv::DtObserverMode Class Reference

DtObserverMode is the class used to represent a single Visual Mode Visual Modes may be saved and restored via the makArchives DtObserverModesRecordEntry and DtObserverModesRecord classes and. More...

List of all members.

Public Member Functions

 DtObserverMode ()
 default constructor; not normally called by users (use DtObserverModeManager::createObserverMode)
 DtObserverMode (const DtObserverMode &orig)
 Copy constructor.
virtual ~DtObserverMode ()
 DTOR.
DtObserverModeoperator= (const DtObserverMode &orig)
 Assignment operator.
void setIntKey (int intKey)
 Set the ID assigned to this visual mode.
int intKey () const
 Get the ID assigned to this visual mode.
void setName (const std::string &name)
 Set the display name of the visual mode.
const std::string & name () const
 Get the display name of the visual mode.
void setIs2D (bool trueOrFalse)
 Set if this visual mode is a 2D (plan view) mode If false, the mode is for 3D use.
bool is2D () const
 Get if this visual mode is a 2D (plan view) mode.
void setModelSet (int modelSet)
 Set the model set used for this visual mode.
int modelSet () const
 Get the model set used for this visual mode.
void setKeyMap (const std::string &keyMap)
 Set the key map used for this mode.
const std::string & keyMap () const
 Get the key map used for this mode.
void setObserverSetting (int settingKey, bool value)
 Set an observer setting.
bool observerSetting (int settingKey) const
 Get an observer setting.
void getRecord (DtDe &de, makArchives::DtObserverModeRecord &record) const
 Get a record from this visual mode.
void setFromRecord (DtDe &de, const makArchives::DtObserverModeRecord &record)
 Set from a visual mode entry record.
virtual int gainPrecision () const
 Get and set the default gain precision.
virtual void setGainPrecision (int amt)
 Get and set the default gain precision.
virtual int orbitSpeedGain () const
 Get and set the default orbit speed gain.
virtual void setOrbitSpeedGain (int gain)
 Get and set the default orbit speed gain.
virtual int linearScaledSpeedGain () const
 Get and set the default linear scaled speed gain.
virtual void setLinearScaledSpeedGain (int gain)
 Get and set the default linear scaled speed gain.
virtual int linearUnscaledSpeedGain () const
 Get and set the default linear unscaled speed gain.
virtual void setLinearUnscaledSpeedGain (int gain)
 Get and set the default linear unscaled speed gain.
virtual int rotationSpeedGain () const
 Get and set the default rotation speed gain.
virtual void setRotationSpeedGain (int gain)
 Get and set the default rotation speed gain.
virtual double modelScaleFactor () const
 Get and set the model scale factor.
virtual void setModelScaleFactor (double modelScaleFactor)
 Get and set the model scale factor.
DtObserverObject::ScaleType modelScaleType () const
 Get and set the model scale type.
void setModelScaleType (DtObserverObject::ScaleType modelScaleFactor)
 Get and set the model scale type.
double maxModelScaleFactor () const
 Get and set the max XR model scale factor.
void setMaxModelScaleFactor (double maxModelScaleFactor)
 Get and set the max XR model scale factor.

Protected Types

typedef std::map< int, boolObserverSettingsMap

Protected Member Functions

 DtObserverMode (int intKey)
 CTOR.

Protected Attributes

int myIntKey
std::string myName
int myModelSet
bool myIs2D
std::string myKeyMap
int myOrbitSpeedGain
int myLinearScaledSpeedGain
int myLinearUnscaledSpeedGain
int myRotationSpeedGain
int myGainPrecision
double myModelScaleFactor
DtObserverObject::ScaleType myModelScaleType
double myMaxModelScaleFactor
ObserverSettingsMap myObserverSettings

Detailed Description

DtObserverMode is the class used to represent a single Visual Mode Visual Modes may be saved and restored via the makArchives DtObserverModesRecordEntry and DtObserverModesRecord classes and.


Member Typedef Documentation

typedef std::map< int, bool> makVrv::DtObserverMode::ObserverSettingsMap [protected]

Constructor & Destructor Documentation

default constructor; not normally called by users (use DtObserverModeManager::createObserverMode)

Copy constructor.

DTOR.

makVrv::DtObserverMode::DtObserverMode ( int  intKey) [protected]

CTOR.


Member Function Documentation

DtObserverMode& makVrv::DtObserverMode::operator= ( const DtObserverMode orig)

Assignment operator.

void makVrv::DtObserverMode::setIntKey ( int  intKey)

Set the ID assigned to this visual mode.

This will be used to look up the mode in the DtObserverModeManager, as well as the handle for setting the observer's visual mode

Get the ID assigned to this visual mode.

void makVrv::DtObserverMode::setName ( const std::string &  name)

Set the display name of the visual mode.

const std::string& makVrv::DtObserverMode::name ( ) const

Get the display name of the visual mode.

void makVrv::DtObserverMode::setIs2D ( bool  trueOrFalse)

Set if this visual mode is a 2D (plan view) mode If false, the mode is for 3D use.

Get if this visual mode is a 2D (plan view) mode.

void makVrv::DtObserverMode::setModelSet ( int  modelSet)

Set the model set used for this visual mode.

Get the model set used for this visual mode.

void makVrv::DtObserverMode::setKeyMap ( const std::string &  keyMap)

Set the key map used for this mode.

const std::string& makVrv::DtObserverMode::keyMap ( ) const

Get the key map used for this mode.

virtual int makVrv::DtObserverMode::gainPrecision ( ) const [virtual]

Get and set the default gain precision.

virtual void makVrv::DtObserverMode::setGainPrecision ( int  amt) [virtual]

Get and set the default gain precision.

virtual int makVrv::DtObserverMode::orbitSpeedGain ( ) const [virtual]

Get and set the default orbit speed gain.

virtual void makVrv::DtObserverMode::setOrbitSpeedGain ( int  gain) [virtual]

Get and set the default orbit speed gain.

virtual int makVrv::DtObserverMode::linearScaledSpeedGain ( ) const [virtual]

Get and set the default linear scaled speed gain.

virtual void makVrv::DtObserverMode::setLinearScaledSpeedGain ( int  gain) [virtual]

Get and set the default linear scaled speed gain.

virtual int makVrv::DtObserverMode::linearUnscaledSpeedGain ( ) const [virtual]

Get and set the default linear unscaled speed gain.

virtual void makVrv::DtObserverMode::setLinearUnscaledSpeedGain ( int  gain) [virtual]

Get and set the default linear unscaled speed gain.

virtual int makVrv::DtObserverMode::rotationSpeedGain ( ) const [virtual]

Get and set the default rotation speed gain.

virtual void makVrv::DtObserverMode::setRotationSpeedGain ( int  gain) [virtual]

Get and set the default rotation speed gain.

virtual double makVrv::DtObserverMode::modelScaleFactor ( ) const [virtual]

Get and set the model scale factor.

virtual void makVrv::DtObserverMode::setModelScaleFactor ( double  modelScaleFactor) [virtual]

Get and set the model scale factor.

Get and set the model scale type.

Get and set the model scale type.

Get and set the max XR model scale factor.

void makVrv::DtObserverMode::setMaxModelScaleFactor ( double  maxModelScaleFactor)

Get and set the max XR model scale factor.

void makVrv::DtObserverMode::setObserverSetting ( int  settingKey,
bool  value 
)

Set an observer setting.

bool makVrv::DtObserverMode::observerSetting ( int  settingKey) const

Get an observer setting.

Get a record from this visual mode.

Set from a visual mode entry record.


Member Data Documentation

std::string makVrv::DtObserverMode::myName [protected]
std::string makVrv::DtObserverMode::myKeyMap [protected]

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)