makVrv::DtObserverConfiguration Class Reference

TODO: This class is used to encapsulate a set of default observer settings and parameters. More...

Inheritance diagram for makVrv::DtObserverConfiguration:

Public Member Functions
	DtObserverConfiguration (const std::string &name="")
	CTOR The default Observer configuration.
	DtObserverConfiguration (const DtObserverConfiguration &)
	Copy CTOR.
DtObserverConfiguration &	operator= (const DtObserverConfiguration &)
	Assignment operator.
virtual	~DtObserverConfiguration ()
	DTOR.
virtual const std::string &	defaultMode () const
	Get and set the default mode name.
virtual void	setDefaultMode (const std::string &defaultMode)
virtual double	minLinearSpeed () const
	Get and set the minimum linear speed.
virtual void	setMinLinearSpeed (double speed)
virtual double	maxLinearSpeed () const
	Get and set the maximum linear speed.
virtual void	setMaxLinearSpeed (double speed)
virtual double	linearSpeed () const
	Get and set the starting linear speed.
virtual void	setLinearSpeed (double speed)
virtual double	minRotationSpeed () const
	Get and set the minimum rotation speed.
virtual void	setMinRotationSpeed (double speed)
virtual double	maxRotationSpeed () const
	Get and set the maximum rotation speed.
virtual void	setMaxRotationSpeed (double speed)
virtual double	rotationSpeed () const
	Get and set the starting rotation speed.
virtual void	setRotationSpeed (double speed)
virtual double	minOrbitSpeed () const
	Get and set the minimum orbit speed.
virtual void	setMinOrbitSpeed (double speed)
virtual double	maxOrbitSpeed () const
	Get and set the maximum orbit speed.
virtual void	setMaxOrbitSpeed (double speed)
virtual double	orbitSpeed () const
	Get and set the starting orbit speed.
virtual void	setOrbitSpeed (double speed)
virtual double	sceneCenterOffsetX () const
	Get and set the scene center X offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.
virtual void	setSceneCenterOffsetX (double offset)
virtual double	sceneCenterOffsetY () const
	Get and set the scene center Y offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.
virtual void	setSceneCenterOffsetY (double offset)
virtual double	sceneCenterOffsetZ () const
	Get and set the scene center Z offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.
virtual void	setSceneCenterOffsetZ (double offset)
virtual const std::string &	observerMode () const
	Get and set the observer mode The observer mode determines if the observer is in 2D or 3D, the model set used, key map, etc.
virtual void	setObserverMode (const std::string &observerMode)
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR.
	DtConfiguration (const DtConfiguration &)
	Copy CTOR.
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP.
virtual	~DtConfiguration ()
	DTOR.
virtual const std::string &	name () const
	Get the configuration name.
virtual void	setName (const std::string &name)
	Set the configuration name.
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters.
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const ParameterMap &	optionalParameters () const
	Get the optional parameters.

Static Public Attributes
static const char *	ObserverConfigurationString

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Protected Attributes
std::string	myDefaultMode
int	myOrbitSpeedGain
int	myLinearScaledSpeedGain
int	myLinearUnscaledSpeedGain
int	myRotationSpeedGain
int	myGainPrecision
double	myMinLinearSpeed
double	myMaxLinearSpeed
double	myLinearSpeed
double	myMinRotationSpeed
double	myMaxRotationSpeed
double	myRotationSpeed
double	myMinOrbitSpeed
double	myMaxOrbitSpeed
double	myOrbitSpeed
double	mySceneCenterOffsetX
double	mySceneCenterOffsetY
double	mySceneCenterOffsetZ
std::string	myObserverMode
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface

Additional Inherited Members
Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string, std::string >	ParameterMap

Detailed Description

TODO: This class is used to encapsulate a set of default observer settings and parameters.

Examples

• exampleCreateObserver

Constructor & Destructor Documentation

makVrv::DtObserverConfiguration::DtObserverConfiguration

(

const std::string &

name = ""

)

CTOR The default Observer configuration.

makVrv::DtObserverConfiguration::DtObserverConfiguration

(

const DtObserverConfiguration &

)

Copy CTOR.

virtual makVrv::DtObserverConfiguration::~DtObserverConfiguration ( )

virtual

DTOR.

Member Function Documentation

DtObserverConfiguration& makVrv::DtObserverConfiguration::operator=

(

const DtObserverConfiguration &

)

Assignment operator.

virtual const std::string& makVrv::DtObserverConfiguration::defaultMode ( ) const

virtual

Get and set the default mode name.

virtual void makVrv::DtObserverConfiguration::setDefaultMode ( const std::string &  defaultMode )

virtual

virtual double makVrv::DtObserverConfiguration::minLinearSpeed ( ) const

virtual

Get and set the minimum linear speed.

virtual void makVrv::DtObserverConfiguration::setMinLinearSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::maxLinearSpeed ( ) const

virtual

Get and set the maximum linear speed.

virtual void makVrv::DtObserverConfiguration::setMaxLinearSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::linearSpeed ( ) const

virtual

Get and set the starting linear speed.

virtual void makVrv::DtObserverConfiguration::setLinearSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::minRotationSpeed ( ) const

virtual

Get and set the minimum rotation speed.

virtual void makVrv::DtObserverConfiguration::setMinRotationSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::maxRotationSpeed ( ) const

virtual

Get and set the maximum rotation speed.

virtual void makVrv::DtObserverConfiguration::setMaxRotationSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::rotationSpeed ( ) const

virtual

Get and set the starting rotation speed.

virtual void makVrv::DtObserverConfiguration::setRotationSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::minOrbitSpeed ( ) const

virtual

Get and set the minimum orbit speed.

virtual void makVrv::DtObserverConfiguration::setMinOrbitSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::maxOrbitSpeed ( ) const

virtual

Get and set the maximum orbit speed.

virtual void makVrv::DtObserverConfiguration::setMaxOrbitSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::orbitSpeed ( ) const

virtual

Get and set the starting orbit speed.

virtual void makVrv::DtObserverConfiguration::setOrbitSpeed ( double  speed )

virtual

virtual double makVrv::DtObserverConfiguration::sceneCenterOffsetX ( ) const

virtual

Get and set the scene center X offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.

virtual void makVrv::DtObserverConfiguration::setSceneCenterOffsetX ( double  offset )

virtual

virtual double makVrv::DtObserverConfiguration::sceneCenterOffsetY ( ) const

virtual

Get and set the scene center Y offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.

virtual void makVrv::DtObserverConfiguration::setSceneCenterOffsetY ( double  offset )

virtual

virtual double makVrv::DtObserverConfiguration::sceneCenterOffsetZ ( ) const

virtual

Get and set the scene center Z offset This offset is applied to the center of the database when the gotoSceneCenter() command is issued.

virtual void makVrv::DtObserverConfiguration::setSceneCenterOffsetZ ( double  offset )

virtual

virtual const std::string& makVrv::DtObserverConfiguration::observerMode ( ) const

virtual

Get and set the observer mode The observer mode determines if the observer is in 2D or 3D, the model set used, key map, etc.

virtual void makVrv::DtObserverConfiguration::setObserverMode ( const std::string &  observerMode )

virtual

template<class Archive >

void makVrv::DtObserverConfiguration::_serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.

Member Data Documentation

const char* makVrv::DtObserverConfiguration::ObserverConfigurationString

static

std::string makVrv::DtObserverConfiguration::myDefaultMode

protected

int makVrv::DtObserverConfiguration::myOrbitSpeedGain

protected

int makVrv::DtObserverConfiguration::myLinearScaledSpeedGain

protected

int makVrv::DtObserverConfiguration::myLinearUnscaledSpeedGain

protected

int makVrv::DtObserverConfiguration::myRotationSpeedGain

protected

int makVrv::DtObserverConfiguration::myGainPrecision

protected

double makVrv::DtObserverConfiguration::myMinLinearSpeed

protected

double makVrv::DtObserverConfiguration::myMaxLinearSpeed

protected

double makVrv::DtObserverConfiguration::myLinearSpeed

protected

double makVrv::DtObserverConfiguration::myMinRotationSpeed

protected

double makVrv::DtObserverConfiguration::myMaxRotationSpeed

protected

double makVrv::DtObserverConfiguration::myRotationSpeed

protected

double makVrv::DtObserverConfiguration::myMinOrbitSpeed

protected

double makVrv::DtObserverConfiguration::myMaxOrbitSpeed

protected

double makVrv::DtObserverConfiguration::myOrbitSpeed

protected

double makVrv::DtObserverConfiguration::mySceneCenterOffsetX

protected

double makVrv::DtObserverConfiguration::mySceneCenterOffsetY

protected

double makVrv::DtObserverConfiguration::mySceneCenterOffsetZ

protected

std::string makVrv::DtObserverConfiguration::myObserverMode

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvUtil/DtObserverConfiguration.h