makVrv::DtMimicViewCommand Class Reference

DtMimicViewCommand enables mimic mode on the named observer. More...

Inheritance diagram for makVrv::DtMimicViewCommand:

Public Member Functions
	DtMimicViewCommand ()
	CTOR.
virtual	~DtMimicViewCommand ()
	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 attached-to entity's orientation.
virtual void	setOffsetOrientation (const DtTaitBryan &ori)
	Specify the orientation that the observer should take as an offset from the attached-to entity's orientation.
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

DtMimicViewCommand enables mimic mode on the named observer.

Constructor & Destructor Documentation

makVrv::DtMimicViewCommand::DtMimicViewCommand

(

)

CTOR.

virtual makVrv::DtMimicViewCommand::~DtMimicViewCommand ( )

virtual

DTOR.

Member Function Documentation

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

virtual

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

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

virtual

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

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

virtual

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

virtual void makVrv::DtMimicViewCommand::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 body-centric coordinate system of the attached-to object with Z up, Y to the front and X to the right.

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

virtual

Get the orientation that the observer will take as an offset from the attached-to entity's orientation.

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

virtual

Specify the orientation that the observer should take as an offset from the attached-to entity's orientation.

This uses a body-centric system where a positive psi rotates to the entity's left, and positive theta looks up; and a positive phi rolls to the right

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

virtual

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

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

virtual

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

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

virtual

Execute the command.

Implements makVrv::DtVrvCommand.

Member Data Documentation

std::string makVrv::DtMimicViewCommand::myObserver

protected

DtVector makVrv::DtMimicViewCommand::myOffset

protected

DtTaitBryan makVrv::DtMimicViewCommand::myOffsetOri

protected

DtUniqueID makVrv::DtMimicViewCommand::myAttachedEntity

protected

---

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

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