makVrv::DtTetherTrackViewCommand Class Reference

DtTetherTrackViewCommand enables tether track mode. More...

Inheritance diagram for makVrv::DtTetherTrackViewCommand:

Public Member Functions
	DtTetherTrackViewCommand ()
	CTOR.
virtual	~DtTetherTrackViewCommand ()
	DTOR.
virtual std::string	observer ()
	Return the name of the observer that this command will control.
virtual void	setObserver (const std::string &newObs)
	Set the name of the observer that this command will control.
virtual DtVector	offset () const
	Get the location of the observer as an offset from the location of the attached-to entity.
virtual void	setOffset (const DtVector &vec)
	Set the location of the observer as an offset from the location of the attached-to entity.
virtual DtTaitBryan	offsetOrientation () const
	Returns whatever is set using setOffsetOrientation.
virtual void	setOffsetOrientation (const DtTaitBryan &ori)
	Reserved for potential later use.
virtual DtUniqueID	attachedEntity () const
	Get the element ID of the entity that the observer will be attached to.
virtual void	setAttachedEntity (const DtUniqueID &entityId)
	Specify the element ID of the entity that will be attached to.
virtual DtUniqueID	trackedEntity () const
	Get the element ID of the entity that will be tracked.
virtual void	setTrackedEntity (const DtUniqueID &entityId)
	Set the element ID of the entity that will be tracked.
virtual void	execute (DtDe &de)
	Execute the command.
Public Member Functions inherited from makVrv::DtVrvCommand
	DtVrvCommand ()
virtual	~DtVrvCommand ()
virtual vrvControlToolkit::DtVrvControlTypeEnum	commandType ()

Protected Attributes
std::string	myObserver
DtVector	myOffset
DtTaitBryan	myOffsetOri
DtUniqueID	myAttachedEntity
DtUniqueID	myTrackedEntity
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Detailed Description

DtTetherTrackViewCommand enables tether track mode.

Constructor & Destructor Documentation

makVrv::DtTetherTrackViewCommand::DtTetherTrackViewCommand

(

)

CTOR.

virtual makVrv::DtTetherTrackViewCommand::~DtTetherTrackViewCommand ( )

virtual

DTOR.

Member Function Documentation

virtual std::string makVrv::DtTetherTrackViewCommand::observer ( )

virtual

Return the name of the observer that this command will control.

virtual void makVrv::DtTetherTrackViewCommand::setObserver ( const std::string &  newObs )

virtual

Set the name of the observer that this command will control.

virtual DtVector makVrv::DtTetherTrackViewCommand::offset ( ) const

virtual

Get the location of the observer as an offset from the location of the attached-to entity.

virtual void makVrv::DtTetherTrackViewCommand::setOffset ( const DtVector &  vec )

virtual

Set the location of the observer as an offset from the location of the attached-to entity.

The offset is specified in a notional coordinate system which is at at the same location as the entity, but with its axes aligned with the database coordinate system

virtual DtTaitBryan makVrv::DtTetherTrackViewCommand::offsetOrientation ( ) const

virtual

Returns whatever is set using setOffsetOrientation.

virtual void makVrv::DtTetherTrackViewCommand::setOffsetOrientation ( const DtTaitBryan &  ori )

virtual

Reserved for potential later use.

This call has no effect (other than to set a local member variable). The observer is always oriented toward the tracked entity in tether track mode.

virtual DtUniqueID makVrv::DtTetherTrackViewCommand::attachedEntity ( ) const

virtual

Get the element ID of the entity that the observer will be attached to.

virtual void makVrv::DtTetherTrackViewCommand::setAttachedEntity ( const DtUniqueID &  entityId )

virtual

Specify the element ID of the entity that will be attached to.

virtual DtUniqueID makVrv::DtTetherTrackViewCommand::trackedEntity ( ) const

virtual

Get the element ID of the entity that will be tracked.

Tracking an entity means that the observer's orientation will be set to face the tracked entity

virtual void makVrv::DtTetherTrackViewCommand::setTrackedEntity ( const DtUniqueID &  entityId )

virtual

Set the element ID of the entity that will be tracked.

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

virtual

Execute the command.

Implements makVrv::DtVrvCommand.

Member Data Documentation

std::string makVrv::DtTetherTrackViewCommand::myObserver

protected

DtVector makVrv::DtTetherTrackViewCommand::myOffset

protected

DtTaitBryan makVrv::DtTetherTrackViewCommand::myOffsetOri

protected

DtUniqueID makVrv::DtTetherTrackViewCommand::myAttachedEntity

protected

DtUniqueID makVrv::DtTetherTrackViewCommand::myTrackedEntity

protected

---

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

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