VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
makVrv::DtTacticalSmokeUpdater Class Reference

An updater for tactical smoke. More...

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

Public Member Functions

 DtTacticalSmokeUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
 CTOR.
virtual ~DtTacticalSmokeUpdater ()
 Virtual DTOR.
virtual void setTacticalSmokeModel (DtModel *model)
 Set the tactical smoke model to be updated.
virtual void setPosition (int vtx, const DtVector &pos)
 Set the position of a scene object vertex.
virtual void setOrientation (int vtx, const DtTaitBryan &ori)
 Set the orientation of a scene object vertex.
virtual void setVelocity (int vtx, const DtVector &velo)
 Set the velocity of a scene object vertex.
virtual void setAcceleration (int vtx, const DtVector &accel)
 Set the acceleration of a scene object vertex.
virtual void setAngularVelocity (int vtx, const DtVector &velo)
 Set the angular velocity of a scene object vertex.
virtual void setDensity (int vtx, double dens)
 Set the current density.
virtual void setDensityRate (int vtx, double rate)
 Set the density rate of change.
virtual void setOneSigmas (int vtx, const DtVector &sigma)
 Set the current one-sigma distances.
virtual void setOneSigmaRates (int vtx, const DtVector &rate)
 Set the one-sigma distances rate of change.
- Public Member Functions inherited from makVrv::DtMultiDeadReckonUpdater
 DtMultiDeadReckonUpdater (DtDe &de, DtUniqueID id, bool suppressTick=false)
 CTOR.
virtual ~DtMultiDeadReckonUpdater ()
 Virtual DTOR.
virtual void update (DtTime tNow)
 Push the update data to the scene object.
virtual void setDeadReckoningSettings (bool pos, bool ori, bool velo)
 Set the object's dead reckoning settings at all vertices.
virtual void setSmoothingEnabled (bool enabled)
 Enable or disable smoothing for all vertices.
virtual void setSmoothingPeriod (float period)
 Set the period for the smoothing calculation.
virtual void updateSpacial (DtTime tNow)
 Update the spacial attributes using the current simulation time.
virtual void setMotionModel (const std::string &modelName)
 Set which motion model the object should use.
virtual DtMotionModelmotionModel (int vtx)
 Get the motion model at a given vertex.
virtual void setUseAbsoluteTimeStamping (bool)
 Sets whether or not to use absolute time stamping (default is false).
bool useAbsoluteTimeStamping () const
- 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.
virtual void setSceneObject (DtSceneObject *sceneObject)
 Set the scene object to be updated.
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

DtSmokePuffsDeadReckonUpdater mySmokePuffsDeadReckonUpdater
- Protected Attributes inherited from makVrv::DtMultiDeadReckonUpdater
MotionModels myMotionModels
std::string myMotionModelType
DtDeadReckonTypes myDeadReckonTypes
float mySmoothingPeriod
bool mySmoothingEnabled
bool myUseAbsoluteTimeStamping
- 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.

Private Member Functions

 DtTacticalSmokeUpdater ()
 Default constructor.
 DtTacticalSmokeUpdater (const DtTacticalSmokeUpdater &)
 Copy constructor.
DtTacticalSmokeUpdateroperator= (const DtTacticalSmokeUpdater &)
 Assignment Operator.

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

An updater for tactical smoke.

This updater drives a cloud of smoke made up of several 'puffs' with a changing cloud position, cloud orientation, puff position (within the cloud), puff density and one-sigma particle distribution distances for each puff.

Constructor & Destructor Documentation

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

CTOR.

Parameters
[in]deis the display engine.
[in]idis a unique identifier for this distributed object.
[in]suppressTickis a flag instructing to not register with a DtTickableManager when set true, default is false.
virtual makVrv::DtTacticalSmokeUpdater::~DtTacticalSmokeUpdater ( )
virtual

Virtual DTOR.

makVrv::DtTacticalSmokeUpdater::DtTacticalSmokeUpdater ( )
private

Default constructor.

Note
Not implemented
makVrv::DtTacticalSmokeUpdater::DtTacticalSmokeUpdater ( const DtTacticalSmokeUpdater )
private

Copy constructor.

Note
Not implemented

Member Function Documentation

virtual void makVrv::DtTacticalSmokeUpdater::setTacticalSmokeModel ( DtModel model)
virtual

Set the tactical smoke model to be updated.

Parameters
[in]modelis the tactical smoke model to receive updates.
Note
Calling the base class setSceneObject() function does not add the model to this updater. This function must be explicitly called for the model to receive updates.
virtual void makVrv::DtTacticalSmokeUpdater::setPosition ( int  vtx,
const DtVector pos 
)
virtual

Set the position of a scene object vertex.

Parameters
[in]vtxis the vertex of the scene object.
[in]posis the position to set.

Reimplemented from makVrv::DtMultiDeadReckonUpdater.

virtual void makVrv::DtTacticalSmokeUpdater::setOrientation ( int  vtx,
const DtTaitBryan &  ori 
)
virtual

Set the orientation of a scene object vertex.

Parameters
[in]vtxis the vertex of the scene object.
[in]oriis the orientation to set.

Reimplemented from makVrv::DtMultiDeadReckonUpdater.

virtual void makVrv::DtTacticalSmokeUpdater::setVelocity ( int  vtx,
const DtVector velo 
)
virtual

Set the velocity of a scene object vertex.

Parameters
[in]vtxis the vertex of the scene object.
[in]velois the velocity to set.

Reimplemented from makVrv::DtMultiDeadReckonUpdater.

virtual void makVrv::DtTacticalSmokeUpdater::setAcceleration ( int  vtx,
const DtVector accel 
)
virtual

Set the acceleration of a scene object vertex.

Parameters
[in]vtxis the vertex of the scene object.
[in]accelis the acceleration to set.

Reimplemented from makVrv::DtMultiDeadReckonUpdater.

virtual void makVrv::DtTacticalSmokeUpdater::setAngularVelocity ( int  vtx,
const DtVector velo 
)
virtual

Set the angular velocity of a scene object vertex.

Parameters
[in]vtxis the vertex of the scene object.
[in]velois the angular velocity to set.

Reimplemented from makVrv::DtMultiDeadReckonUpdater.

virtual void makVrv::DtTacticalSmokeUpdater::setDensity ( int  vtx,
double  dens 
)
virtual

Set the current density.

Parameters
[in]vtxis the vertex of the scene object.
[in]densis the density to set.
virtual void makVrv::DtTacticalSmokeUpdater::setDensityRate ( int  vtx,
double  rate 
)
virtual

Set the density rate of change.

Parameters
[in]vtxis the vertex of the scene object.
[in]rateis the rate of change.
virtual void makVrv::DtTacticalSmokeUpdater::setOneSigmas ( int  vtx,
const DtVector sigma 
)
virtual

Set the current one-sigma distances.

Parameters
[in]vtxis the vertex of the scene object.
[in]sigmais the one-sigma distances to set.
virtual void makVrv::DtTacticalSmokeUpdater::setOneSigmaRates ( int  vtx,
const DtVector rate 
)
virtual

Set the one-sigma distances rate of change.

Parameters
[in]vtxis the vertex of the scene object.
[in]rateis the rate of change.
DtTacticalSmokeUpdater& makVrv::DtTacticalSmokeUpdater::operator= ( const DtTacticalSmokeUpdater )
private

Assignment Operator.

Note
Not implemented

Member Data Documentation

DtSmokePuffsDeadReckonUpdater makVrv::DtTacticalSmokeUpdater::mySmokePuffsDeadReckonUpdater
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)