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.

Public Member Functions
	DtObserverMode ()

	DtObserverMode (const DtObserverMode &orig)

virtual	~DtObserverMode ()

DtObserverMode &	operator= (const DtObserverMode &orig)

void	setIntKey (int intKey)

int	intKey () const

void	setName (const std::string &name)

const std::string &	name () const

void	setIs2D (bool trueOrFalse)

bool	is2D () const

void	setModelSet (DtModelSetId modelSet)

DtModelSetId	modelSet () const

void	setKeyMap (const std::string &keyMap)

const std::string &	keyMap () const

virtual void	setColorControlEnabled (bool enabled)

virtual bool	colorControlEnabled () const

virtual void	setColorControlInvert (bool enabled)

virtual bool	colorControlInvert () const

virtual void	setColorControlContrast (double value)

virtual double	colorControlContrast () const

virtual void	setColorControlBrightness (double value)

virtual double	colorControlBrightness () const

virtual void	setColorControlColorMix (double value)

virtual double	colorControlColorMix () const

void	setObserverSetting (int settingKey, bool value)

bool	observerSetting (int settingKey) const

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

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

virtual bool	wireframeModeChanged (bool onOrOff, bool &retVal)


virtual int	gainPrecision () const

virtual void	setGainPrecision (int amt)


virtual const std::string &	sensor () const

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


virtual int	orbitSpeedGain () const

virtual void	setOrbitSpeedGain (int gain)


virtual int	linearScaledSpeedGain () const

virtual void	setLinearScaledSpeedGain (int gain)


virtual int	linearUnscaledSpeedGain () const

virtual void	setLinearUnscaledSpeedGain (int gain)


virtual int	rotationSpeedGain () const

virtual void	setRotationSpeedGain (int gain)


virtual double	modelScaleFactor () const

virtual void	setModelScaleFactor (double modelScaleFactor)


const std::string &	modelScaleType () const

void	setModelScaleType (const std::string &modelScaleType)


double	maxModelScaleFactor () const

void	setMaxModelScaleFactor (double maxModelScaleFactor)


void	setSpeedScalingMode (DtObserverObject::SpeedScalingMode mode)

DtObserverObject::SpeedScalingMode	speedScalingMode () const


void	setSpeedScalingMslModeOffset (double offset)

double	speedScalingMslModeOffset () const


void	setCameraShakeEnabled (bool enabled)

bool	cameraShakeEnabled () const


void	setCameraShakeIntensity (double intensity)

double	cameraShakeIntensity () const


void	setIsFrustumBasedViewMagnificationEnabled (bool enabled)

bool	isFrustumBasedViewMagnificationEnabled () const


void	setLodCenterSettings (const DtObserverObject::DtLodCenterSettings &settings)

const DtObserverObject::DtLodCenterSettings &	lodCenterSettings () const


virtual void	setNorthType (DtObserverObject::NorthType northType)

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)


virtual bool	hasSkyRestoreInfo ()

virtual void	setHasSkyRestoreInfo (bool trueOrFalse)


virtual bool	skyRestoreInfo ()

virtual void	setSkyRestoreInfo (bool onOrOff)

Protected Attributes
int	myIntKey

std::string	myName

std::string	mySensor

DtModelSetId	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	myIsFrustumBasedViewMagnificationEnabled

ObserverSettingsMap	myObserverSettings

DtObserverObject::NorthType	myNorthType

bool	myColorControlEnabled

bool	myColorControlInvert

float	myColorControlContrast

float	myColorControlBrightness

float	myColorControlColorMix

DtObserverObject::DtLodCenterSettings	myLodCenterSettings

bool	myHasSkyRestoreInfo

bool	mySkyRestoreInfo

Member Typedef Documentation

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

protected

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 ( DtModelSetId modelSet )

Set the model set used for this visual mode.

DtModelSetId 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

Get and set the default gain precision.

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

Get and set the active sensor by name.

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.

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

Get and set the model scale type.

void makVrv::DtObserverMode::setModelScaleType ( const std::string & modelScaleType )

Get and set the model scale type.

double makVrv::DtObserverMode::maxModelScaleFactor ( ) const

Get and set the max model scale factor.

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

Get and set the max model scale factor.

void makVrv::DtObserverMode::setSpeedScalingMode ( DtObserverObject::SpeedScalingMode mode )

Get and set the speed scaling mode.

DtObserverObject::SpeedScalingMode makVrv::DtObserverMode::speedScalingMode ( ) const

Get and set the speed scaling mode.

void makVrv::DtObserverMode::setSpeedScalingMslModeOffset ( double offset )

Get and set the speed scaling MSL mode offset.

double makVrv::DtObserverMode::speedScalingMslModeOffset ( ) const

Get and set the speed scaling MSL mode offset.

void makVrv::DtObserverMode::setCameraShakeEnabled ( bool enabled )

Get and set the camera shake enabled flag.

bool makVrv::DtObserverMode::cameraShakeEnabled ( ) const

Get and set the camera shake enabled flag.

void makVrv::DtObserverMode::setCameraShakeIntensity ( double intensity )

Get and set the camera shake intensity.

double makVrv::DtObserverMode::cameraShakeIntensity ( ) const

Get and set the camera shake intensity.

void makVrv::DtObserverMode::setIsFrustumBasedViewMagnificationEnabled ( bool enabled )

Get and set the whether or not the frustum contributes to the view magnification or not.

bool makVrv::DtObserverMode::isFrustumBasedViewMagnificationEnabled ( ) const

Get and set the whether or not the frustum contributes to the view magnification or not.

void makVrv::DtObserverMode::setLodCenterSettings ( const DtObserverObject::DtLodCenterSettings & settings )

Get and set the LOD Center Settings for this observer mode.

const DtObserverObject::DtLodCenterSettings& makVrv::DtObserverMode::lodCenterSettings ( ) const

Get and set the LOD Center Settings for this observer mode.

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

virtual

Get and set the north type.

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

virtual

Get and set the north type.

virtual void makVrv::DtObserverMode::setColorControlEnabled ( bool enabled )

virtual

Sets the color control enabled value. Defines if the color control should be used for an observer mode.

Parameters

enabled True if color control should be enabled.

virtual bool makVrv::DtObserverMode::colorControlEnabled ( ) const

virtual

Gets the color control enabled value.

virtual void makVrv::DtObserverMode::setColorControlInvert ( bool enabled )

virtual

Sets the current color control invert value. Defines if the grayscale computed output should be inverted in the image.

Parameters

enabled True if the color grayscale should be inverted.

virtual bool makVrv::DtObserverMode::colorControlInvert ( ) const

virtual

Gets the color control invert value.

virtual void makVrv::DtObserverMode::setColorControlContrast ( double value )

virtual

Sets the current color control contrast value. Defines the grayscale contrast in the image.

Parameters

value The (0.0 - 1.0) grayscale contrast value.

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

virtual

Gets the color control contrast value.

virtual void makVrv::DtObserverMode::setColorControlBrightness ( double value )

virtual

Sets the current color control brightness value. Defines the grayscale brightness in the image.

Parameters

value The (0.0 - 1.0) grayscale brightness value.

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

virtual

Gets the color control brightness value.

virtual void makVrv::DtObserverMode::setColorControlColorMix ( double value )

virtual

Sets the current color control color mix value. Defines how much color to mix in to the image.

Parameters

value The (0.0 - 1.0) grayscale vs color mix value.

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

virtual

Gets the color control color mix value.

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

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

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

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.

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

DtModelSetId 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::myIsFrustumBasedViewMagnificationEnabled

protected

ObserverSettingsMap makVrv::DtObserverMode::myObserverSettings

protected

DtObserverObject::NorthType makVrv::DtObserverMode::myNorthType

protected

bool makVrv::DtObserverMode::myColorControlEnabled

protected

bool makVrv::DtObserverMode::myColorControlInvert

protected

float makVrv::DtObserverMode::myColorControlContrast

protected

float makVrv::DtObserverMode::myColorControlBrightness

protected

float makVrv::DtObserverMode::myColorControlColorMix

protected

DtObserverObject::DtLodCenterSettings makVrv::DtObserverMode::myLodCenterSettings

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.vrf5-2-branch/include/vrvCore/DtObserverMode.h

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation