makVrv::DtFollowViewCommand Class Reference

DtFollowViewCommand enables follow mode on the named observer. More...

Inheritance diagram for makVrv::DtFollowViewCommand:

Public Member Functions
	DtFollowViewCommand ()
	CTOR.
virtual	~DtFollowViewCommand ()
	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)
	Specify the location of the observer as an offset from the location of the attached-to entity.
virtual DtTaitBryan	offsetOrientation () const
	Get the orientation that the observer will take as an offset from the notional coordinate system described above for setOffset.
virtual void	setOffsetOrientation (const DtTaitBryan &ori)
	Set the orientation that the observer will take as an offset from the notional coordinate system described above for setOffset.
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	myOffsetOri
DtUniqueID	myAttachedEntity
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Detailed Description

DtFollowViewCommand enables follow mode on the named observer.

Constructor & Destructor Documentation

makVrv::DtFollowViewCommand::DtFollowViewCommand

(

)

CTOR.

virtual makVrv::DtFollowViewCommand::~DtFollowViewCommand ( )

virtual

DTOR.

Member Function Documentation

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

virtual

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

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

virtual

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

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

virtual

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

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

virtual

Specify 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 at the same location as the entity, rotated about its z-axis by the same amount the the entity is rotated about it's z-axis, but with it's x and y axes level (the pitch and roll of the entity ignored); Z up, Y to the front (projected heading) and X to the right.

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

virtual

Get the orientation that the observer will take as an offset from the notional coordinate system described above for setOffset.

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

virtual

Set the orientation that the observer will take as an offset from the notional coordinate system described above for setOffset.

Positive psi rotates to the left of the entity (as if it was level); theta up, phi roll right.

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

virtual

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

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

virtual

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

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

virtual

Execute the command.

Implements makVrv::DtVrvCommand.

Member Data Documentation

std::string makVrv::DtFollowViewCommand::myObserver

protected

DtVector makVrv::DtFollowViewCommand::myOffset

protected

DtTaitBryan makVrv::DtFollowViewCommand::myOffsetOri

protected

DtUniqueID makVrv::DtFollowViewCommand::myAttachedEntity

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtFollowViewCommand.h