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...

Public Types
enum	ModelSets { ModelSet3dModels = 0, ModelSetColorizedModels = 1, ModelSetMinimap = 4, ModelSet2dIcons = 5 }

Public Member Functions
	DtObserverMode ()
	default constructor; not normally called by users (use DtObserverModeManager::createObserverMode) More...
	DtObserverMode (const DtObserverMode &orig)
	Copy constructor. More...
virtual	~DtObserverMode ()
	DTOR. More...
DtObserverMode &	operator= (const DtObserverMode &orig)
	Assignment operator. More...
void	setIntKey (int intKey)
	Set the ID assigned to this visual mode. More...
int	intKey () const
	Get the ID assigned to this visual mode. More...
void	setName (const std::string &name)
	Set the display name of the visual mode. More...
const std::string &	name () const
	Get the display name of the visual mode. More...
void	setIs2D (bool trueOrFalse)
	Set if this visual mode is a 2D (plan view) mode If false, the mode is for 3D use. More...
bool	is2D () const
	Get if this visual mode is a 2D (plan view) mode. More...
void	setModelSet (int modelSet)
	Set the model set used for this visual mode. More...
int	modelSet () const
	Get the model set used for this visual mode. More...
void	setKeyMap (const std::string &keyMap)
	Set the key map used for this mode. More...
const std::string &	keyMap () const
	Get the key map used for this mode. More...
void	setObserverSetting (int settingKey, bool value)
	Set an observer setting. More...
bool	observerSetting (int settingKey) const
	Get an observer setting. More...
void	getRecord (DtDe &de, makArchives::DtObserverModeRecord &record) const
	Get a record from this visual mode. More...
void	setFromRecord (DtDe &de, const makArchives::DtObserverModeRecord &record)
	Set from a visual mode entry record. More...
virtual bool	wireframeModeChanged (bool onOrOff, bool &retVal)
	This method is called by the observer mode manager whenever we change into or out of wireframe mode. More...
virtual int	gainPrecision () const
	Get and set the default gain precision. More...
virtual void	setGainPrecision (int amt)
virtual const std::string &	sensor () const
	Get and set the active sensor by name. More...
virtual void	setSensor (const std::string &sensorName)
virtual int	orbitSpeedGain () const
	Get and set the default orbit speed gain. More...
virtual void	setOrbitSpeedGain (int gain)
virtual int	linearScaledSpeedGain () const
	Get and set the default linear scaled speed gain. More...
virtual void	setLinearScaledSpeedGain (int gain)
virtual int	linearUnscaledSpeedGain () const
	Get and set the default linear unscaled speed gain. More...
virtual void	setLinearUnscaledSpeedGain (int gain)
virtual int	rotationSpeedGain () const
	Get and set the default rotation speed gain. More...
virtual void	setRotationSpeedGain (int gain)
virtual double	modelScaleFactor () const
	Get and set the model scale factor. More...
virtual void	setModelScaleFactor (double modelScaleFactor)
const std::string &	modelScaleType () const
	Get and set the model scale type. More...
void	setModelScaleType (const std::string &modelScaleType)
double	maxModelScaleFactor () const
	Get and set the max model scale factor. More...
void	setMaxModelScaleFactor (double maxModelScaleFactor)
void	setSpeedScalingMode (DtObserverObject::SpeedScalingMode mode)
	Get and set the speed scaling mode. More...
DtObserverObject::SpeedScalingMode	speedScalingMode () const
void	setSpeedScalingMslModeOffset (double offset)
	Get and set the speed scaling MSL mode offset. More...
double	speedScalingMslModeOffset () const
void	setCameraShakeEnabled (bool enabled)
	Get and set the camera shake enabled flag. More...
bool	cameraShakeEnabled () const
void	setCameraShakeIntensity (double intensity)
	Get and set the camera shake intensity. More...
double	cameraShakeIntensity () const
void	setLodScaleCenterEnabled (bool enabled)
	Get and set the lod scale center enabled. More...
bool	lodScaleCenterEnabled () const
void	setLodScaleCenterMagMinLimit (double limit)
	Get and set the lod scale view magnification minimum limit. More...
double	lodScaleCenterMagMinLimit () const
virtual void	setNorthType (DtObserverObject::NorthType northType)
	Get and set the north type. More...
virtual DtObserverObject::NorthType	northType () const

Static Public Attributes
static std::string	theXRScaleType
static std::string	theLinearScaleType

Protected Types
typedef std::map< int, bool >	ObserverSettingsMap

Protected Member Functions
	DtObserverMode (int intKey)
	CTOR. More...
virtual bool	hasSkyRestoreInfo ()
	Set / Return whether the observer has saved its sky state due to entering wireframe mode (and not being changed subsequent to that) More...
virtual void	setHasSkyRestoreInfo (bool trueOrFalse)
virtual bool	skyRestoreInfo ()
	If the observer has been asked to remember its sky state for later restoration, these methods set or return it. More...
virtual void	setSkyRestoreInfo (bool onOrOff)

Protected Attributes
int	myIntKey
std::string	myName
std::string	mySensor
int	myModelSet
bool	myIs2D
std::string	myKeyMap
int	myOrbitSpeedGain
int	myLinearScaledSpeedGain
int	myLinearUnscaledSpeedGain
int	myRotationSpeedGain
int	myGainPrecision
double	myModelScaleFactor
std::string	myModelScaleType
double	myMaxModelScaleFactor
DtObserverObject::SpeedScalingMode	mySpeedScalingMode
double	mySpeedScalingMslModeOffset
bool	myCameraShakeEnabled
double	myCameraShakeIntensity
bool	myLodScaleCenterEnabled
double	myLodScaleCenterMagMinLimit
ObserverSettingsMap	myObserverSettings
DtObserverObject::NorthType	myNorthType
bool	myHasSkyRestoreInfo
bool	mySkyRestoreInfo

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

Member Enumeration Documentation

enum makVrv::DtObserverMode::ModelSets

Enumerator
ModelSet3dModels
ModelSetColorizedModels
ModelSetMinimap
ModelSet2dIcons

Constructor & Destructor Documentation

makVrv::DtObserverMode::DtObserverMode

(

)

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

makVrv::DtObserverMode::DtObserverMode

(

const DtObserverMode &

orig

)

Copy constructor.

virtual makVrv::DtObserverMode::~DtObserverMode ( )

virtual

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

int makVrv::DtObserverMode::intKey

(

)

const

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.

bool makVrv::DtObserverMode::is2D

(

)

const

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.

int makVrv::DtObserverMode::modelSet

(

)

const

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

virtual const std::string& makVrv::DtObserverMode::sensor ( ) const

virtual

Get and set the active sensor by name.

virtual void makVrv::DtObserverMode::setSensor ( const std::string &  sensorName )

virtual

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

virtual

Get and set the default orbit speed gain.

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

virtual

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

virtual

Get and set the default linear scaled speed gain.

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

virtual

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

virtual

Get and set the default linear unscaled speed gain.

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

virtual

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

virtual

Get and set the default rotation speed gain.

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

virtual

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

virtual

Get and set the model scale factor.

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

virtual

const std::string& makVrv::DtObserverMode::modelScaleType

(

)

const

Get and set the model scale type.

void makVrv::DtObserverMode::setModelScaleType

(

const std::string &

modelScaleType

)

double makVrv::DtObserverMode::maxModelScaleFactor

(

)

const

Get and set the max model scale factor.

void makVrv::DtObserverMode::setMaxModelScaleFactor

(

double

maxModelScaleFactor

)

void makVrv::DtObserverMode::setSpeedScalingMode

(

DtObserverObject::SpeedScalingMode

mode

)

Get and set the speed scaling mode.

DtObserverObject::SpeedScalingMode makVrv::DtObserverMode::speedScalingMode

(

)

const

void makVrv::DtObserverMode::setSpeedScalingMslModeOffset

(

double

offset

)

Get and set the speed scaling MSL mode offset.

double makVrv::DtObserverMode::speedScalingMslModeOffset

(

)

const

void makVrv::DtObserverMode::setCameraShakeEnabled

(

bool

enabled

)

Get and set the camera shake enabled flag.

bool makVrv::DtObserverMode::cameraShakeEnabled

(

)

const

void makVrv::DtObserverMode::setCameraShakeIntensity

(

double

intensity

)

Get and set the camera shake intensity.

double makVrv::DtObserverMode::cameraShakeIntensity

(

)

const

void makVrv::DtObserverMode::setLodScaleCenterEnabled

(

bool

enabled

)

Get and set the lod scale center enabled.

bool makVrv::DtObserverMode::lodScaleCenterEnabled

(

)

const

void makVrv::DtObserverMode::setLodScaleCenterMagMinLimit

(

double

limit

)

Get and set the lod scale view magnification minimum limit.

double makVrv::DtObserverMode::lodScaleCenterMagMinLimit

(

)

const

virtual void makVrv::DtObserverMode::setNorthType ( DtObserverObject::NorthType  northType )

virtual

Get and set the north type.

virtual DtObserverObject::NorthType makVrv::DtObserverMode::northType ( ) const

virtual

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

Set an observer setting.

bool makVrv::DtObserverMode::observerSetting

(

int

settingKey

)

const

Get an observer setting.

void makVrv::DtObserverMode::getRecord	(	DtDe &	de,
		makArchives::DtObserverModeRecord &	record
	)		const

Get a record from this visual mode.

void makVrv::DtObserverMode::setFromRecord	(	DtDe &	de,
		const makArchives::DtObserverModeRecord &	record
	)

Set from a visual mode entry record.

virtual bool makVrv::DtObserverMode::wireframeModeChanged ( bool  onOrOff, bool &  retVal  )

virtual

This method is called by the observer mode manager whenever we change into or out of wireframe mode.

It backs up / restores our current displaySky setting, which is turned off in wireframe mode. If a change is actually made, this method will return true (so the observer manager knows to raise a signal)

virtual bool makVrv::DtObserverMode::hasSkyRestoreInfo ( )

protectedvirtual

Set / Return whether the observer has saved its sky state due to entering wireframe mode (and not being changed subsequent to that)

virtual void makVrv::DtObserverMode::setHasSkyRestoreInfo ( bool  trueOrFalse )

protectedvirtual

virtual bool makVrv::DtObserverMode::skyRestoreInfo ( )

protectedvirtual

If the observer has been asked to remember its sky state for later restoration, these methods set or return it.

True = skyOn, False = sky off. Its value is undefined if hasSkyRestoreInfo() returns false.

virtual void makVrv::DtObserverMode::setSkyRestoreInfo ( bool  onOrOff )

protectedvirtual

Member Data Documentation

std::string makVrv::DtObserverMode::theXRScaleType

static

std::string makVrv::DtObserverMode::theLinearScaleType

static

int makVrv::DtObserverMode::myIntKey

protected

std::string makVrv::DtObserverMode::myName

protected

std::string makVrv::DtObserverMode::mySensor

protected

int makVrv::DtObserverMode::myModelSet

protected

bool makVrv::DtObserverMode::myIs2D

protected

std::string makVrv::DtObserverMode::myKeyMap

protected

int makVrv::DtObserverMode::myOrbitSpeedGain

protected

int makVrv::DtObserverMode::myLinearScaledSpeedGain

protected

int makVrv::DtObserverMode::myLinearUnscaledSpeedGain

protected

int makVrv::DtObserverMode::myRotationSpeedGain

protected

int makVrv::DtObserverMode::myGainPrecision

protected

double makVrv::DtObserverMode::myModelScaleFactor

protected

std::string makVrv::DtObserverMode::myModelScaleType

protected

double makVrv::DtObserverMode::myMaxModelScaleFactor

protected

DtObserverObject::SpeedScalingMode makVrv::DtObserverMode::mySpeedScalingMode

protected

double makVrv::DtObserverMode::mySpeedScalingMslModeOffset

protected

bool makVrv::DtObserverMode::myCameraShakeEnabled

protected

double makVrv::DtObserverMode::myCameraShakeIntensity

protected

bool makVrv::DtObserverMode::myLodScaleCenterEnabled

protected

double makVrv::DtObserverMode::myLodScaleCenterMagMinLimit

protected

ObserverSettingsMap makVrv::DtObserverMode::myObserverSettings

protected

DtObserverObject::NorthType makVrv::DtObserverMode::myNorthType

protected

bool makVrv::DtObserverMode::myHasSkyRestoreInfo

protected

bool makVrv::DtObserverMode::mySkyRestoreInfo

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtObserverMode.h