makArchives::DtObserverModeRecord Class Reference

DtObserverModeRecord is the serializable record used to read and write a Visual Mode's Configuration information (see class DtObserverMode in vrvCore) More...

Public Types
typedef std::map< std::string, bool >	ObserverSettingsMap

Public Member Functions
	DtObserverModeRecord ()
	CTOR.
	DtObserverModeRecord (const DtObserverModeRecord &orig)
	Copy constructor.
	~DtObserverModeRecord ()
	DTOR.
DtObserverModeRecord &	operator= (const DtObserverModeRecord &orig)
	Assignment operator.
void	setModeKey (const std::string &modeKey)
	Set the string key assigned to this visual mode.
const std::string &	modeKey () 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.
const ObserverSettingsMap &	observerSettingsMap () const
const std::string &	sensor () const
	Get and set the active sensor.
void	setSensor (const std::string &sensor)
	Get and set the active sensor.
int	gainPrecision () const
	Get and set the default gain precision.
void	setGainPrecision (int amt)
	Get and set the default gain precision.
int	orbitSpeedGain () const
	Get and set the default orbit speed gain.
void	setOrbitSpeedGain (int gain)
	Get and set the default orbit speed gain.
int	linearScaledSpeedGain () const
	Get and set the default linear scaled speed gain.
void	setLinearScaledSpeedGain (int gain)
	Get and set the default linear scaled speed gain.
int	linearUnscaledSpeedGain () const
	Get and set the default linear unscaled speed gain.
void	setLinearUnscaledSpeedGain (int gain)
	Get and set the default linear unscaled speed gain.
int	rotationSpeedGain () const
	Get and set the default rotation speed gain.
void	setRotationSpeedGain (int gain)
	Get and set the default rotation speed gain.
double	modelScaleFactor () const
	Get and set the model scaling factor.
void	setModelScaleFactor (double modelScaleFactor)
	Get and set the model scaling factor.
unsigned	modelScaleType () const
	Get and set the model scale type.
void	setModelScaleType (unsigned modelScaleFactor)
	Get and set the model scale type.
double	maxModelScaleFactor () const
	Get and set the max model scale factor.
void	setMaxModelScaleFactor (double maxModelScaleFactor)
	Get and set the max model scale factor.
void	setObserverSetting (std::string key, bool enabled)
	Get and set if the indicated setting is enabled.
bool	observerSetting (std::string key) const
	Get and set if the indicated setting is enabled.

Protected Member Functions
template<typename Archive >
void	serialize (Archive &ar, unsigned int version)

Protected Attributes
std::string	myModeKey
std::string	myName
std::string	mySensor
bool	myIs2D
std::string	myKeyMap
int	myModelSet
int	myOrbitSpeedGain
int	myLinearScaledSpeedGain
int	myLinearUnscaledSpeedGain
int	myRotationSpeedGain
int	myGainPrecision
double	myModelScaleFactor
ObserverSettingsMap	myObserverSettingsMap
unsigned	myModelScaleType
double	myMaxModelScaleFactor

Friends
class	boost::serialization::access

Detailed Description

DtObserverModeRecord is the serializable record used to read and write a Visual Mode's Configuration information (see class DtObserverMode in vrvCore)

Member Typedef Documentation

typedef std::map< std::string, bool> makArchives::DtObserverModeRecord::ObserverSettingsMap

Constructor & Destructor Documentation

makArchives::DtObserverModeRecord::DtObserverModeRecord

(

)

CTOR.

makArchives::DtObserverModeRecord::DtObserverModeRecord

(

const DtObserverModeRecord &

orig

)

Copy constructor.

makArchives::DtObserverModeRecord::~DtObserverModeRecord

(

)

DTOR.

Member Function Documentation

DtObserverModeRecord& makArchives::DtObserverModeRecord::operator=

(

const DtObserverModeRecord &

orig

)

Assignment operator.

void makArchives::DtObserverModeRecord::setModeKey

(

const std::string &

modeKey

)

Set the string key assigned to this visual mode.

This will be converted to an integer key to look up the mode in the DtObserverModeManager, as well as the handle for setting the observer's mode. Any other data that needs to write an observer mode will use this key

const std::string& makArchives::DtObserverModeRecord::modeKey

(

)

const

Get the ID assigned to this visual mode.

void makArchives::DtObserverModeRecord::setName

(

const std::string &

name

)

Set the display name of the visual mode.

const std::string& makArchives::DtObserverModeRecord::name

(

)

const

Get the display name of the visual mode.

void makArchives::DtObserverModeRecord::setIs2D

(

bool

trueOrFalse

)

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

bool makArchives::DtObserverModeRecord::is2D

(

)

const

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

void makArchives::DtObserverModeRecord::setModelSet

(

int

modelSet

)

Set the model set used for this visual mode.

int makArchives::DtObserverModeRecord::modelSet

(

)

const

Get the model set used for this visual mode.

void makArchives::DtObserverModeRecord::setKeyMap

(

const std::string &

keyMap

)

Set the key map used for this mode.

const std::string& makArchives::DtObserverModeRecord::keyMap

(

)

const

Get the key map used for this mode.

const std::string& makArchives::DtObserverModeRecord::sensor

(

)

const

Get and set the active sensor.

void makArchives::DtObserverModeRecord::setSensor

(

const std::string &

sensor

)

Get and set the active sensor.

int makArchives::DtObserverModeRecord::gainPrecision

(

)

const

Get and set the default gain precision.

void makArchives::DtObserverModeRecord::setGainPrecision

(

int

amt

)

Get and set the default gain precision.

int makArchives::DtObserverModeRecord::orbitSpeedGain

(

)

const

Get and set the default orbit speed gain.

void makArchives::DtObserverModeRecord::setOrbitSpeedGain

(

int

gain

)

Get and set the default orbit speed gain.

int makArchives::DtObserverModeRecord::linearScaledSpeedGain

(

)

const

Get and set the default linear scaled speed gain.

void makArchives::DtObserverModeRecord::setLinearScaledSpeedGain

(

int

gain

)

Get and set the default linear scaled speed gain.

int makArchives::DtObserverModeRecord::linearUnscaledSpeedGain

(

)

const

Get and set the default linear unscaled speed gain.

void makArchives::DtObserverModeRecord::setLinearUnscaledSpeedGain

(

int

gain

)

Get and set the default linear unscaled speed gain.

int makArchives::DtObserverModeRecord::rotationSpeedGain

(

)

const

Get and set the default rotation speed gain.

void makArchives::DtObserverModeRecord::setRotationSpeedGain

(

int

gain

)

Get and set the default rotation speed gain.

double makArchives::DtObserverModeRecord::modelScaleFactor

(

)

const

Get and set the model scaling factor.

void makArchives::DtObserverModeRecord::setModelScaleFactor

(

double

modelScaleFactor

)

Get and set the model scaling factor.

unsigned makArchives::DtObserverModeRecord::modelScaleType

(

)

const

Get and set the model scale type.

void makArchives::DtObserverModeRecord::setModelScaleType

(

unsigned

modelScaleFactor

)

Get and set the model scale type.

double makArchives::DtObserverModeRecord::maxModelScaleFactor

(

)

const

Get and set the max model scale factor.

void makArchives::DtObserverModeRecord::setMaxModelScaleFactor

(

double

maxModelScaleFactor

)

Get and set the max model scale factor.

void makArchives::DtObserverModeRecord::setObserverSetting	(	std::string	key,
		bool	enabled
	)

Get and set if the indicated setting is enabled.

bool makArchives::DtObserverModeRecord::observerSetting

(

std::string

key

)

const

Get and set if the indicated setting is enabled.

const ObserverSettingsMap& makArchives::DtObserverModeRecord::observerSettingsMap

(

)

const

template<typename Archive >

void makArchives::DtObserverModeRecord::serialize ( Archive &  ar, unsigned int  version  )

inlineprotected

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

std::string makArchives::DtObserverModeRecord::myModeKey

protected

std::string makArchives::DtObserverModeRecord::myName

protected

std::string makArchives::DtObserverModeRecord::mySensor

protected

bool makArchives::DtObserverModeRecord::myIs2D

protected

std::string makArchives::DtObserverModeRecord::myKeyMap

protected

int makArchives::DtObserverModeRecord::myModelSet

protected

int makArchives::DtObserverModeRecord::myOrbitSpeedGain

protected

int makArchives::DtObserverModeRecord::myLinearScaledSpeedGain

protected

int makArchives::DtObserverModeRecord::myLinearUnscaledSpeedGain

protected

int makArchives::DtObserverModeRecord::myRotationSpeedGain

protected

int makArchives::DtObserverModeRecord::myGainPrecision

protected

double makArchives::DtObserverModeRecord::myModelScaleFactor

protected

ObserverSettingsMap makArchives::DtObserverModeRecord::myObserverSettingsMap

protected

unsigned makArchives::DtObserverModeRecord::myModelScaleType

protected

double makArchives::DtObserverModeRecord::myMaxModelScaleFactor

protected

---

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

• include/makArchives/DtObserverModeRecord.h