DtStealthCommandsManager Class Reference

Public Types
typedef std::pair < DtSimulationAddress, DtString >	StealthObserver
	Returns stealth address/observer name pairs to send messages to.
typedef std::vector < StealthObserver >	StealthObservers

Public Member Functions
	DtStealthCommandsManager (DtSimManager *simManager)
	CTOR.
virtual	~DtStealthCommandsManager ()
	DTOR.
virtual bool	init ()
	Calls register callbacks and default stealth commands.
virtual void	addStealthCommand (const DtString &command, const DtString &displayName, DtStealthCommandExecutorFcn)
	Adds a new stealth command.
virtual void	removeStealthCommand (const DtString &command)
	Removes the stealth command with the given keyword.
virtual void	addStealthSelectorToCommand (const DtString &command)
	Adds a stealth command selector variable to the given command.
virtual void	addObserverModeSelectorToCommand (const DtString &command)
	Adds an observer mode (Stealth, Plan View, etc.) selector to the command with a variable called "observermode".
virtual void	addAttachSelectorToCommand (const DtString &command)
	Adds a selector to select an entity/aggegate to attach to. Will create a variable called "attachto".
virtual void	addTrackedEntitySelectorToCommand (const DtString &command)
	Adds a selector to select an entity/aggegate to attach to. Will create a variable called "track".
virtual void	addBodyPositionSelectorToCommand (const DtString &command)
	Adds a body position entry for offset. Will create a variable called "bodypositionoffset".
virtual void	addLocationSelectorToCommand (const DtString &command)
	Adds a location entry. Will create a variable called "location".
virtual void	addOffsetOrientationSelectorToCommand (const DtString &command)
	Adds an offset orientation entry for offset. Will create a variable called "orientationoffset".
virtual void	addObserverViewSelectorToCommand (const DtString &command)
	Adds a selector for a saved (or current) observer view to use.
virtual void	addObserverTransitionTimeToCommand (const DtString &command)
	Adds a time control to set the transition time to move the camera from the current to the new position.
StealthObservers	getStealthObservers (const DtRwVariableBindings &) const
virtual void	executeCommand (const DtString &, const DtRwVariableBindings &)
	Executes the given stealth command by it's registered executor function.
virtual void	setObserverMode (const DtRwVariableBindings &)
	Sets the observer mode to the given mode for all the observers in the variable bindings.
virtual DtGlobalObjectDesignator	attachToGlobalId (const DtRwVariableBindings &vars, const std::string &varname="attachto") const
	Returns global object identifier of attached entity.
DtSimManager *	simManager ()
virtual void	resetStealth (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth reset to reset the stealth to the appropriate origin/orientation.
virtual void	detachStealth (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth detach to detach the stealth observers - String list of observers to send message to.
virtual void	attachMimic (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth mimic attach command Variables: observers - String list of observers to send message to.
virtual void	attachTether (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth tether attach command Variables: observers - String list of observers to send message to.
virtual void	attachFollow (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth follow attach command Variables: observers - String list of observers to send message to.
virtual void	attachTrack (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth track attach command Variables: observers - String list of observers to send message to.
virtual void	attachTetherTrack (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the stealth tether track attach command Variables: observers - String list of observers to send message to.
virtual void	setLocation (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Executes the absolute command which will detach the stealth and set it to the specified location and orientation Variables: observers - String list of observers to send message to.
virtual void	setObserverView (DtSimManager *, const DtString &command, const DtRwVariableBindings &)
	Sets the observer to the current view.

Protected Types
typedef std::map< DtString, DtStealthCommandExecutorFcn >	StealthCommandExecutors

Protected Member Functions
virtual void	initializeResetCommand ()
	Initializes stealth reset command.
virtual void	initializeDetachCommand ()
	Initializes stealth detach command.
virtual void	initializeMimicCommand ()
	Initializes stealth mimic attach command.
virtual void	initializeTetherCommand ()
	Initializes stealth tether attach command.
virtual void	initializeFollowCommand ()
	Initializes stealth follow attach command.
virtual void	initializeTrackCommand ()
	Initializes stealth track attach command.
virtual void	initializeTetherTrackCommand ()
	Initializes stealth tether track attach command.
virtual void	initializeSetLocationCommand ()
	Initializes stealth set location command.
virtual void	initializeUseViewModeCommand ()
	Initializes command to use the the current view or allow the user to select a view mode to use as part of the command.
virtual void	processStealthCommandsRequest (DtIfRequestStealthCommands *msg)

Static Protected Member Functions
static void	stealthCommandsRequestCallback (DtSimMessage *msg, void *usr)
	Request and return current sim commands.

Protected Attributes
DtSimManager *	mySimManager
DtStealthCommands	myStealthCommands
StealthCommandExecutors	myStealthCommandExecutors

Member Typedef Documentation

typedef std::pair<DtSimulationAddress, DtString> DtStealthCommandsManager::StealthObserver

Returns stealth address/observer name pairs to send messages to.

typedef std::vector<StealthObserver> DtStealthCommandsManager::StealthObservers

typedef std::map<DtString, DtStealthCommandExecutorFcn> DtStealthCommandsManager::StealthCommandExecutors

protected

Constructor & Destructor Documentation

DtStealthCommandsManager::DtStealthCommandsManager

(

DtSimManager *

simManager

)

CTOR.

virtual DtStealthCommandsManager::~DtStealthCommandsManager ( )

virtual

DTOR.

Member Function Documentation

virtual bool DtStealthCommandsManager::init ( )

virtual

Calls register callbacks and default stealth commands.

virtual void DtStealthCommandsManager::addStealthCommand ( const DtString &  command, const DtString &  displayName, DtStealthCommandExecutorFcn    )

virtual

Adds a new stealth command.

Once added you can add/remove variables to that command using the keyword. If the keyword exists will replace the existing command

virtual void DtStealthCommandsManager::removeStealthCommand ( const DtString &  command )

virtual

Removes the stealth command with the given keyword.

virtual void DtStealthCommandsManager::addStealthSelectorToCommand ( const DtString &  command )

virtual

Adds a stealth command selector variable to the given command.

Variable name will be "observer" and the display string "Select Observer". This control will also add a "Broadcast" check box

virtual void DtStealthCommandsManager::addObserverModeSelectorToCommand ( const DtString &  command )

virtual

Adds an observer mode (Stealth, Plan View, etc.) selector to the command with a variable called "observermode".

virtual void DtStealthCommandsManager::addAttachSelectorToCommand ( const DtString &  command )

virtual

Adds a selector to select an entity/aggegate to attach to. Will create a variable called "attachto".

virtual void DtStealthCommandsManager::addTrackedEntitySelectorToCommand ( const DtString &  command )

virtual

Adds a selector to select an entity/aggegate to attach to. Will create a variable called "track".

virtual void DtStealthCommandsManager::addBodyPositionSelectorToCommand ( const DtString &  command )

virtual

Adds a body position entry for offset. Will create a variable called "bodypositionoffset".

virtual void DtStealthCommandsManager::addLocationSelectorToCommand ( const DtString &  command )

virtual

Adds a location entry. Will create a variable called "location".

virtual void DtStealthCommandsManager::addOffsetOrientationSelectorToCommand ( const DtString &  command )

virtual

Adds an offset orientation entry for offset. Will create a variable called "orientationoffset".

virtual void DtStealthCommandsManager::addObserverViewSelectorToCommand ( const DtString &  command )

virtual

Adds a selector for a saved (or current) observer view to use.

virtual void DtStealthCommandsManager::addObserverTransitionTimeToCommand ( const DtString &  command )

virtual

Adds a time control to set the transition time to move the camera from the current to the new position.

StealthObservers DtStealthCommandsManager::getStealthObservers

(

const DtRwVariableBindings &

)

const

virtual void DtStealthCommandsManager::executeCommand ( const DtString &  , const DtRwVariableBindings &    )

virtual

Executes the given stealth command by it's registered executor function.

virtual void DtStealthCommandsManager::setObserverMode ( const DtRwVariableBindings &  )

virtual

Sets the observer mode to the given mode for all the observers in the variable bindings.

virtual DtGlobalObjectDesignator DtStealthCommandsManager::attachToGlobalId ( const DtRwVariableBindings &  vars, const std::string &  varname = "attachto"  ) const

virtual

Returns global object identifier of attached entity.

DtSimManager* DtStealthCommandsManager::simManager ( )

inline

virtual void DtStealthCommandsManager::resetStealth ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth reset to reset the stealth to the appropriate origin/orientation.

Variables: observers - String list of observers to send message to. If blank sends to all

virtual void DtStealthCommandsManager::detachStealth ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth detach to detach the stealth observers - String list of observers to send message to.

If blank sends to all

virtual void DtStealthCommandsManager::attachMimic ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth mimic attach command Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) attachto - Entity to attach to

virtual void DtStealthCommandsManager::attachTether ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth tether attach command Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) attachto - Entity to attach to offsetlocation - Location offset from the origin of the entity to place the camera orientationoffset - Orientation offset to place the location

virtual void DtStealthCommandsManager::attachFollow ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth follow attach command Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) attachto - Entity to attach to offsetlocation - Location offset from the origin of the entity to place the camera orientationoffset - Orientation offset to place the location

virtual void DtStealthCommandsManager::attachTrack ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth track attach command Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) tracked - Entity to attach to offsetlocation - Location offset from the origin of the entity to place the camera orientationoffset - Orientation offset to place the location

virtual void DtStealthCommandsManager::attachTetherTrack ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the stealth tether track attach command Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) attachto - Entity to attach to offsetlocation - Location offset from the origin of the entity to place the camera orientationoffset - Orientation offset to place the location

virtual void DtStealthCommandsManager::setLocation ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Executes the absolute command which will detach the stealth and set it to the specified location and orientation Variables: observers - String list of observers to send message to.

If blank sends to all observermode - Mode to setthe observers to (Stealth, Plan View, etc) location - Location to place the camera orientationoffset - Orientation offset to place the location

virtual void DtStealthCommandsManager::setObserverView ( DtSimManager *  , const DtString &  command, const DtRwVariableBindings &    )

virtual

Sets the observer to the current view.

Variables: observers - String list of observers to send message to. If blank sends to all observerview - View record to use transitiontime - Time used to transition to the final view

virtual void DtStealthCommandsManager::initializeResetCommand ( )

protectedvirtual

Initializes stealth reset command.

virtual void DtStealthCommandsManager::initializeDetachCommand ( )

protectedvirtual

Initializes stealth detach command.

virtual void DtStealthCommandsManager::initializeMimicCommand ( )

protectedvirtual

Initializes stealth mimic attach command.

virtual void DtStealthCommandsManager::initializeTetherCommand ( )

protectedvirtual

Initializes stealth tether attach command.

virtual void DtStealthCommandsManager::initializeFollowCommand ( )

protectedvirtual

Initializes stealth follow attach command.

virtual void DtStealthCommandsManager::initializeTrackCommand ( )

protectedvirtual

Initializes stealth track attach command.

virtual void DtStealthCommandsManager::initializeTetherTrackCommand ( )

protectedvirtual

Initializes stealth tether track attach command.

virtual void DtStealthCommandsManager::initializeSetLocationCommand ( )

protectedvirtual

Initializes stealth set location command.

virtual void DtStealthCommandsManager::initializeUseViewModeCommand ( )

protectedvirtual

Initializes command to use the the current view or allow the user to select a view mode to use as part of the command.

Note that once the view mode is selected the information for that mode is transcribed into the command such that if it changes later (the view mode) the plan statement will not update

static void DtStealthCommandsManager::stealthCommandsRequestCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Request and return current sim commands.

virtual void DtStealthCommandsManager::processStealthCommandsRequest ( DtIfRequestStealthCommands *  msg )

protectedvirtual

Member Data Documentation

DtSimManager* DtStealthCommandsManager::mySimManager

protected

DtStealthCommands DtStealthCommandsManager::myStealthCommands

protected

StealthCommandExecutors DtStealthCommandsManager::myStealthCommandExecutors

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/stealthCommandsManager.h