makVrv::DtEmbarkationUpdater Class Reference

A DtEmbarkationUpdater updates a scene object that can be positioned in the scene relative to another scene object. More...

Inheritance diagram for makVrv::DtEmbarkationUpdater:

Classes
class	ObjectEmbarkationPoint
	EmbarkationPoint used to attach to a scene object. More...

Public Member Functions
	DtEmbarkationUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtEmbarkationUpdater ()
	DTOR.
virtual void	embark (DtUniqueID uniqueID)
	Add a (object) attach point.
virtual void	setPositionOffset (const DtVector &offset)
	Set the position offset from the host object's position.
virtual void	update (DtTime tNow)
	Calls doEmbarkation() and then the DtSceneUpdater base.
virtual void	doEmbarkation (DtTime tNow)
	Find the actual position and orientation and update the scene object.
Public Member Functions inherited from makVrv::DtSceneObjectUpdater
	DtSceneObjectUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtSceneObjectUpdater ()
	Virtual DTOR.
virtual void	setNextUpdater (DtSceneObjectUpdater *nextUpdater)
	Set the next updater in the updater chain.
virtual void	setPrevUpdater (DtSceneObjectUpdater *prevUpdater)
	Set the previous updater in the updater chain.
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
virtual void	setVertexToUpdate (unsigned int vertex)
	Specify which vertex in the scene object this updater updates.
virtual void	setInputPosition (const DtVector &position)
	Set the position input to this updater.
virtual void	setInputOrientation (const DtTaitBryan &orientation)
	Set the orientation input to this updater.
virtual void	setOutputPosition (const DtVector &position)
	Output the resultant position.
virtual void	setOutputOrientation (const DtTaitBryan &orientation)
	Output the resultant orientation.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
DtSceneObjectUpdater *	findNextUpdater () const
	Return the next updater in the updater chain.
DtSceneObjectUpdater *	findPrevUpdater () const
	Return the previous updater in the updater chain.
DtSceneObject *	findSceneObject ()
	Get the current scene object for this updater.
DtSceneObject *const	findSceneObject () const
	const correct version
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update.
virtual unsigned int	updatePeriod () const

Protected Attributes
ObjectEmbarkationPoint	myEmbarkationPoint
Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated.
boost::signalslib::connection	mySceneObjectConnection
DtTime	myLastUpdateTime
	The last time stamp when the update()
DtSceneObjectUpdater *	myNextUpdater
	The next updater in the chain (or NULL)
DtSceneObjectUpdater *	myPrevUpdater
	The previous updater in the chain (or NULL)
unsigned int	myVertexToUpdate
	The default scene object vertex to update.
DtVector	myInputPosition
	Input position.
DtTaitBryan	myInputOrientation
	Input Orientation.
bool	myPositionDataOutputted
	Flag to indicate if setOutputPosition has been called this tick.
bool	myOrientationDataOutputted
	Flag to indicate if setOutputOrientation has been called this tick.
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod

Additional Inherited Members
Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const DtUniqueID &) >	signal_updaterToBeDeleted
Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

Detailed Description

A DtEmbarkationUpdater updates a scene object that can be positioned in the scene relative to another scene object.

Its input should be positions and orientations relative to the object to which it is attached; its outputs are positions and orientations in local (database) coordinates

Constructor & Destructor Documentation

makVrv::DtEmbarkationUpdater::DtEmbarkationUpdater	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtEmbarkationUpdater::~DtEmbarkationUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEmbarkationUpdater::embark ( DtUniqueID  uniqueID )

virtual

Add a (object) attach point.

If multiple attach points are specified each will update its corresponding vertex in the scene object being updated

virtual void makVrv::DtEmbarkationUpdater::setPositionOffset ( const DtVector &  offset )

virtual

Set the position offset from the host object's position.

virtual void makVrv::DtEmbarkationUpdater::update ( DtTime  tNow )

virtual

Calls doEmbarkation() and then the DtSceneUpdater base.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtEmbarkationUpdater::doEmbarkation ( DtTime  tNow )

virtual

Find the actual position and orientation and update the scene object.

Member Data Documentation

ObjectEmbarkationPoint makVrv::DtEmbarkationUpdater::myEmbarkationPoint

protected

---

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

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