VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
makVrv::DtAttachableDeadReckonUpdater Class Reference

DtAttachableDeadReckonUpdater is an updater that updates scene objects that need to attach to some other object in the scene and still be dead reckoned (such as embarked entities). More...

Inheritance diagram for makVrv::DtAttachableDeadReckonUpdater:
Inheritance graph
[legend]

Public Member Functions

 DtAttachableDeadReckonUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
 CTOR.
virtual ~DtAttachableDeadReckonUpdater ()
 DTOR.
virtual void update (DtTime tNow)
 Call deadReckonAndAttach() followed by updateSceneObject()
virtual void deadReckonAndAttach (DtTime tNow)
 Use the contained DtDeadReckonUpdater to dead reckon the scene object's relative position, and then used the contained DtAttachableUpdater the attach the result to the parent.
virtual void addAttachedPoint (const DtVector &position, int targetVertexIndex)
 Add a (vertex) attach point.
virtual void addAttachedPoint (DtUniqueID uniqueID, int targetVertexIndex)
 Add a (object) attach point.
virtual void addAttachedPoint (DtUniqueID uniqueID, int vtx1, int vtx2, double proportion, int targetVertexIndex)
 Add a (linear) attach point.
virtual void setPosition (const DtVector &position)
 Set the object's position.
virtual void setOrientation (const DtTaitBryan &ori)
 Set the object's orientation.
virtual void setVelocity (const DtVector &velocity)
 Set the object's velocity.
virtual void setAcceleration (const DtVector &acceleration)
 Set the object's velocity.
virtual void setAngularVelocity (const DtVector &angularVelocity)
 Set the object's rotational velocity.
virtual void setDeadReckoningSettings (bool deadReckonPosition, bool deadReckonVelocity, bool deadReckonOrientation)
 Set the object's dead reckoning settings.
virtual void setSmoothingEnabled (bool enabled)
 Turn the smoother on or off.
virtual void setSmoothingPeriod (float period)
 Set the period for the smoother.
virtual void updateSpacial (double simulationTime)
 Update the spacial attributes using the given simulation time.
void setMotionModel (const std::string &modelName)
 Set which motion model the object should use.
virtual void setSceneObject (DtSceneObject *sceneObject)
 Override setting the scene object to handle the dead reckon updater.
- Public Member Functions inherited from makVrv::DtSceneObjectUpdater
 DtSceneObjectUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
 CTOR.
virtual ~DtSceneObjectUpdater ()
 Virtual DTOR.
virtual bool needsUpdate (DtTime tNow)
 The check function called by DtTickableManager to verify if an update is required.
virtual DtTime lastUpdateTime () const
 Get the time-stamp of the last update.
DtSceneObjectfindSceneObject ()
 Get the current scene object for this updater.
DtUniqueID uniqueId () const
 Returns the distributed object id of this updater.
virtual void setUpdaterPosition (int vtx, const DtVector &pos)
 Set the position of a scene object vertex.
virtual const DtVectorupdaterPosition (int vtx) const
 Get the position of a scene object vertex.
virtual void setUpdaterOrientation (int vtx, const DtTaitBryan &ori)
 Set the orientation of a scene object vertex.
virtual const DtTaitBryan & updaterOrientation (int vtx) const
 Get the orientation of a scene object vertex.
void updateSceneObject (DtTime tNow)
 Update the scene object position and orientation at each vertex and set the last updated time-stamp.
virtual void terrainScaleTransformsIfNeeded ()
 Scales the transforms if the terrain scaling flag is set.

Protected Attributes

DtAttachableUpdatermyAttachableUpdater
DtDeadReckonUpdatermyDeadReckonUpdater
- Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDemyDe
 The display engine.
DtUniqueID myUniqueId
 This distributed object's unique identifier.
DtSceneObjectmySceneObject
 A pointer to the current scene object being updated.
DtTime myLastUpdateTime
 The last time stamp when the updateSceneObject() was called.
DtSceneObject::TransformList myTransforms
 Local copy of the vertex positions and orientations.
const DtDeSharedStatemyDeSharedState
 This is kept to make terrain scale updating cheaper ( by one virtual function call ).
bool myInManager
 If tick was suppressed, then this updater is not on the tickableManager.

Additional Inherited Members

- Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const
DtUniqueID &) > 
signal_updaterToBeDeleted
 Signal that this updater is being destroyed.
- Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void slot_sceneObjectToBeDeleted (const DtUniqueID &id)
 Signal that this updater is being destroyed.
- Protected Member Functions inherited from makVrv::DtTickable
 DtTickable (DtTickableManagerInterface *manager=NULL)
 CTOR.
virtual ~DtTickable ()
 Virtual DTOR.

Detailed Description

DtAttachableDeadReckonUpdater is an updater that updates scene objects that need to attach to some other object in the scene and still be dead reckoned (such as embarked entities).

Constructor & Destructor Documentation

makVrv::DtAttachableDeadReckonUpdater::DtAttachableDeadReckonUpdater ( DtDe de,
DtUniqueID  id,
bool  suppressTick = false 
)

CTOR.

virtual makVrv::DtAttachableDeadReckonUpdater::~DtAttachableDeadReckonUpdater ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtAttachableDeadReckonUpdater::update ( DtTime  tNow)
virtual
virtual void makVrv::DtAttachableDeadReckonUpdater::deadReckonAndAttach ( DtTime  tNow)
virtual

Use the contained DtDeadReckonUpdater to dead reckon the scene object's relative position, and then used the contained DtAttachableUpdater the attach the result to the parent.

virtual void makVrv::DtAttachableDeadReckonUpdater::addAttachedPoint ( const DtVector position,
int  targetVertexIndex 
)
virtual

Add a (vertex) attach point.

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

virtual void makVrv::DtAttachableDeadReckonUpdater::addAttachedPoint ( DtUniqueID  uniqueID,
int  targetVertexIndex 
)
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::DtAttachableDeadReckonUpdater::addAttachedPoint ( DtUniqueID  uniqueID,
int  vtx1,
int  vtx2,
double  proportion,
int  targetVertexIndex 
)
virtual

Add a (linear) attach point.

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

virtual void makVrv::DtAttachableDeadReckonUpdater::setPosition ( const DtVector position)
virtual

Set the object's position.

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

Set the object's orientation.

virtual void makVrv::DtAttachableDeadReckonUpdater::setVelocity ( const DtVector velocity)
virtual

Set the object's velocity.

virtual void makVrv::DtAttachableDeadReckonUpdater::setAcceleration ( const DtVector acceleration)
virtual

Set the object's velocity.

virtual void makVrv::DtAttachableDeadReckonUpdater::setAngularVelocity ( const DtVector angularVelocity)
virtual

Set the object's rotational velocity.

virtual void makVrv::DtAttachableDeadReckonUpdater::setDeadReckoningSettings ( bool  deadReckonPosition,
bool  deadReckonVelocity,
bool  deadReckonOrientation 
)
virtual

Set the object's dead reckoning settings.

virtual void makVrv::DtAttachableDeadReckonUpdater::setSmoothingEnabled ( bool  enabled)
virtual

Turn the smoother on or off.

virtual void makVrv::DtAttachableDeadReckonUpdater::setSmoothingPeriod ( float  period)
virtual

Set the period for the smoother.

virtual void makVrv::DtAttachableDeadReckonUpdater::updateSpacial ( double  simulationTime)
virtual

Update the spacial attributes using the given simulation time.

void makVrv::DtAttachableDeadReckonUpdater::setMotionModel ( const std::string &  modelName)

Set which motion model the object should use.

virtual void makVrv::DtAttachableDeadReckonUpdater::setSceneObject ( DtSceneObject sceneObject)
virtual

Override setting the scene object to handle the dead reckon updater.

Reimplemented from makVrv::DtSceneObjectUpdater.

Member Data Documentation

DtAttachableUpdater* makVrv::DtAttachableDeadReckonUpdater::myAttachableUpdater
protected
DtDeadReckonUpdater* makVrv::DtAttachableDeadReckonUpdater::myDeadReckonUpdater
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)