makVrv::DtObserverModeSettingCommand Class Reference

DtObserverModeSettingCommand is the common base class for all VRV Commands that toggle an observer mode setting. More...

Inheritance diagram for makVrv::DtObserverModeSettingCommand:

Public Member Functions
	DtObserverModeSettingCommand ()
	CTOR.
virtual	~DtObserverModeSettingCommand ()
	DTOR.
virtual DtObserverSettingsManager::ObserverSetting	settingToControl () const =0
	Return the observer mode setting that this command controls.
virtual void	execute (DtDe &de)
	Execute the command (change the observer mode setting) if the observer mode has view control enabled.
virtual void	setFromControlPacket (vrvControlToolkit::DtVrvControl_v1 *control)
	Initialize the command from a vrvControl packet.
virtual std::string	observerModeName () const
	Set / Get the name of the observer mode to change.
virtual void	setObserverModeName (const std::string &mode)
virtual bool	isEnabled () const
	Set / Get whether the setting is being enabled or disabled.
virtual void	setEnabled (bool state)
Public Member Functions inherited from makVrv::DtVrvCommand
	DtVrvCommand ()
virtual	~DtVrvCommand ()
virtual vrvControlToolkit::DtVrvControlTypeEnum	commandType ()

Protected Member Functions
virtual void	setSettingByObserverModeIntKey (DtDe &de, int observerModeIntKey)
virtual void	setSettingByObserverModeName (DtDe &de, const std::string &observerModeName)

Protected Attributes
std::string	myObserverModeName
bool	myState
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Detailed Description

DtObserverModeSettingCommand is the common base class for all VRV Commands that toggle an observer mode setting.

Constructor & Destructor Documentation

makVrv::DtObserverModeSettingCommand::DtObserverModeSettingCommand

(

)

CTOR.

virtual makVrv::DtObserverModeSettingCommand::~DtObserverModeSettingCommand ( )

virtual

DTOR.

Member Function Documentation

virtual DtObserverSettingsManager::ObserverSetting makVrv::DtObserverModeSettingCommand::settingToControl ( ) const

pure virtual

Return the observer mode setting that this command controls.

Implemented in makVrv::DtDepthOfFieldCommand, makVrv::DtOceanSprayCommand, makVrv::DtDetonationsCommand, makVrv::DtDustCloudsCommand, makVrv::DtDynamicLightsCommand, makVrv::DtDynamicOceanCommand, makVrv::DtFlamesCommand, makVrv::DtFootprintsCommand, makVrv::DtModelScalingCommand, makVrv::DtMuzzleFlashesCommand, makVrv::DtRainSplashCommand, makVrv::DtSensorFieldsOfViewCommand, makVrv::DtSkyCommand, makVrv::DtSmokePlumesCommand, makVrv::DtSpeedScalingCommand, makVrv::DtTacticalSmokeCommand, makVrv::DtTracersCommand, makVrv::DtTrackHistoriesCommand, makVrv::DtTracksCommand, makVrv::DtVaporTrailsCommand, and makVrv::DtWaveSplashCommand.

virtual std::string makVrv::DtObserverModeSettingCommand::observerModeName ( ) const

virtual

Set / Get the name of the observer mode to change.

virtual void makVrv::DtObserverModeSettingCommand::setObserverModeName ( const std::string &  mode )

virtual

virtual bool makVrv::DtObserverModeSettingCommand::isEnabled ( ) const

virtual

Set / Get whether the setting is being enabled or disabled.

virtual void makVrv::DtObserverModeSettingCommand::setEnabled ( bool  state )

virtual

virtual void makVrv::DtObserverModeSettingCommand::execute ( DtDe &  de )

virtual

Execute the command (change the observer mode setting) if the observer mode has view control enabled.

Implements makVrv::DtVrvCommand.

virtual void makVrv::DtObserverModeSettingCommand::setFromControlPacket ( vrvControlToolkit::DtVrvControl_v1 *  control )

virtual

Initialize the command from a vrvControl packet.

virtual void makVrv::DtObserverModeSettingCommand::setSettingByObserverModeIntKey ( DtDe &  de, int  observerModeIntKey  )

protectedvirtual

virtual void makVrv::DtObserverModeSettingCommand::setSettingByObserverModeName ( DtDe &  de, const std::string &  observerModeName  )

protectedvirtual

Member Data Documentation

std::string makVrv::DtObserverModeSettingCommand::myObserverModeName

protected

bool makVrv::DtObserverModeSettingCommand::myState

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtObserverModeSettingCommand.h