VR-Forces 4.1 Class Documentation
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makArchives::DtObserverSettingsRecord Class Reference

A DtObserverSettingsRecord contains the settings of an observer. More...

Public Types

enum  AttachType {
  AttachTypeTether, AttachTypeMimic, AttachTypeFollow, AttachTypeTrack,
  AttachTypeTetherTrack, AttachTypeMimicTrack, AttachTypeModelView, AttachTypeSpaceFollow
}

Public Member Functions

 DtObserverSettingsRecord ()
 CTOR.
 DtObserverSettingsRecord (const DtObserverSettingsRecord &orig)
 Copy CTOR.
DtObserverSettingsRecordoperator= (const DtObserverSettingsRecord &orig)
 Assignment OP.
 ~DtObserverSettingsRecord ()
 DTOR.
Accessors/ mutators:
void setObserverMode (const std::string &observerMode)
 void setGainPrecision( int amt ); int gainPrecision() const;
const std::string & observerMode () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setAttachType (AttachType type)
 void setGainPrecision( int amt ); int gainPrecision() const;
AttachType attachType () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setHideModelOnAttach (bool hide)
 void setGainPrecision( int amt ); int gainPrecision() const;
bool hideModelOnAttach () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setOrientToTargetConstraint (bool orient)
 void setGainPrecision( int amt ); int gainPrecision() const;
bool orientToTargetConstraint () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setOrbitSpeedGain (int gain)
 void setGainPrecision( int amt ); int gainPrecision() const;
int orbitSpeedGain () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setRotationSpeedGain (int gain)
 void setGainPrecision( int amt ); int gainPrecision() const;
int rotationSpeedGain () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setLinearScaledSpeedGain (int gain)
 void setGainPrecision( int amt ); int gainPrecision() const;
int linearScaledSpeedGain () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setLinearUnscaledSpeedGain (int gain)
 void setGainPrecision( int amt ); int gainPrecision() const;
int linearUnscaledSpeedGain () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setOrbitSpeed (double speed)
 void setGainPrecision( int amt ); int gainPrecision() const;
double orbitSpeed () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setRotationSpeed (double speed)
 void setGainPrecision( int amt ); int gainPrecision() const;
double rotationSpeed () const
 void setGainPrecision( int amt ); int gainPrecision() const;
void setLinearSpeed (double speed)
 void setGainPrecision( int amt ); int gainPrecision() const;
double linearSpeed () const
 void setGainPrecision( int amt ); int gainPrecision() const;

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes

std::string myObserverMode
AttachType myAttachType
bool myHideModelOnAttach
bool myOrientToTargetConstraint
bool mySpeedScaling
bool myConstrainToTerrain
int myOrbitSpeedGain
int myRotationSpeedGain
int myLinearScaledSpeedGain
int myLinearUnscaledSpeedGain
double myOrbitSpeed
double myRotationSpeed
double myLinearSpeed

Friends

class boost::serialization::access

Detailed Description

A DtObserverSettingsRecord contains the settings of an observer.

Member Enumeration Documentation

Enumerator:
AttachTypeTether 
AttachTypeMimic 
AttachTypeFollow 
AttachTypeTrack 
AttachTypeTetherTrack 
AttachTypeMimicTrack 
AttachTypeModelView 
AttachTypeSpaceFollow 

Constructor & Destructor Documentation

makArchives::DtObserverSettingsRecord::DtObserverSettingsRecord ( )

CTOR.

makArchives::DtObserverSettingsRecord::DtObserverSettingsRecord ( const DtObserverSettingsRecord orig)

Copy CTOR.

makArchives::DtObserverSettingsRecord::~DtObserverSettingsRecord ( )

DTOR.

Member Function Documentation

DtObserverSettingsRecord& makArchives::DtObserverSettingsRecord::operator= ( const DtObserverSettingsRecord orig)

Assignment OP.

void makArchives::DtObserverSettingsRecord::setObserverMode ( const std::string &  observerMode)

void setGainPrecision( int amt ); int gainPrecision() const;

const std::string& makArchives::DtObserverSettingsRecord::observerMode ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setAttachType ( AttachType  type)

void setGainPrecision( int amt ); int gainPrecision() const;

AttachType makArchives::DtObserverSettingsRecord::attachType ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setHideModelOnAttach ( bool  hide)

void setGainPrecision( int amt ); int gainPrecision() const;

bool makArchives::DtObserverSettingsRecord::hideModelOnAttach ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setOrientToTargetConstraint ( bool  orient)

void setGainPrecision( int amt ); int gainPrecision() const;

bool makArchives::DtObserverSettingsRecord::orientToTargetConstraint ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setOrbitSpeedGain ( int  gain)

void setGainPrecision( int amt ); int gainPrecision() const;

int makArchives::DtObserverSettingsRecord::orbitSpeedGain ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setRotationSpeedGain ( int  gain)

void setGainPrecision( int amt ); int gainPrecision() const;

int makArchives::DtObserverSettingsRecord::rotationSpeedGain ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setLinearScaledSpeedGain ( int  gain)

void setGainPrecision( int amt ); int gainPrecision() const;

int makArchives::DtObserverSettingsRecord::linearScaledSpeedGain ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setLinearUnscaledSpeedGain ( int  gain)

void setGainPrecision( int amt ); int gainPrecision() const;

int makArchives::DtObserverSettingsRecord::linearUnscaledSpeedGain ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setOrbitSpeed ( double  speed)

void setGainPrecision( int amt ); int gainPrecision() const;

double makArchives::DtObserverSettingsRecord::orbitSpeed ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setRotationSpeed ( double  speed)

void setGainPrecision( int amt ); int gainPrecision() const;

double makArchives::DtObserverSettingsRecord::rotationSpeed ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

void makArchives::DtObserverSettingsRecord::setLinearSpeed ( double  speed)

void setGainPrecision( int amt ); int gainPrecision() const;

double makArchives::DtObserverSettingsRecord::linearSpeed ( ) const

void setGainPrecision( int amt ); int gainPrecision() const;

template<class Archive >
void makArchives::DtObserverSettingsRecord::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Member Data Documentation

std::string makArchives::DtObserverSettingsRecord::myObserverMode
protected
AttachType makArchives::DtObserverSettingsRecord::myAttachType
protected
bool makArchives::DtObserverSettingsRecord::myHideModelOnAttach
protected
bool makArchives::DtObserverSettingsRecord::myOrientToTargetConstraint
protected
bool makArchives::DtObserverSettingsRecord::mySpeedScaling
protected
bool makArchives::DtObserverSettingsRecord::myConstrainToTerrain
protected
int makArchives::DtObserverSettingsRecord::myOrbitSpeedGain
protected
int makArchives::DtObserverSettingsRecord::myRotationSpeedGain
protected
int makArchives::DtObserverSettingsRecord::myLinearScaledSpeedGain
protected
int makArchives::DtObserverSettingsRecord::myLinearUnscaledSpeedGain
protected
double makArchives::DtObserverSettingsRecord::myOrbitSpeed
protected
double makArchives::DtObserverSettingsRecord::myRotationSpeed
protected
double makArchives::DtObserverSettingsRecord::myLinearSpeed
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)