makVrv::DtTetherViewCommand Class Reference

DtTetherViewCommand enables tether mode. More...

Inheritance diagram for makVrv::DtTetherViewCommand:

Public Member Functions
	DtTetherViewCommand ()
virtual	~DtTetherViewCommand ()
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
	Deprecated. Calls orientation(), which is more correctly named.
virtual void	setOffsetOrientation (const DtTaitBryan &ori)
	Deprecated. Calls setOrientation(), which is more correctly named.
virtual DtTaitBryan	orientation () const
	Get the orientation that the observer will be set to, in database coordinates.
virtual void	setOrientation (const DtTaitBryan &ori)
	Set the orientation that the observer will use, in database cooordinates.
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 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	myOrientation
DtUniqueID	myAttachedEntity
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Detailed Description

DtTetherViewCommand enables tether mode.

Constructor & Destructor Documentation

makVrv::DtTetherViewCommand::DtTetherViewCommand

(

)

virtual makVrv::DtTetherViewCommand::~DtTetherViewCommand ( )

virtual

Member Function Documentation

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

virtual

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

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

virtual

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

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

virtual

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

virtual void makVrv::DtTetherViewCommand::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 the attached entity's coordinate system

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

virtual

Deprecated. Calls orientation(), which is more correctly named.

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

virtual

Deprecated. Calls setOrientation(), which is more correctly named.

virtual DtTaitBryan makVrv::DtTetherViewCommand::orientation ( ) const

virtual

Get the orientation that the observer will be set to, in database coordinates.

virtual void makVrv::DtTetherViewCommand::setOrientation ( const DtTaitBryan &  ori )

virtual

Set the orientation that the observer will use, in database cooordinates.

On a projected database, facing North, positive psi rotates to the west; positive theta rotates up, and positive phi rolls right. For geocentric databases, you must use DIS/HLA RPR orientation with psi negated.

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

virtual

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

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

virtual

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

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

virtual

Execute the command.

Implements makVrv::DtVrvCommand.

Member Data Documentation

std::string makVrv::DtTetherViewCommand::myObserver

protected

DtVector makVrv::DtTetherViewCommand::myOffset

protected

DtTaitBryan makVrv::DtTetherViewCommand::myOrientation

protected

DtUniqueID makVrv::DtTetherViewCommand::myAttachedEntity

protected

---

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

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