DtSmokePuffsDeadReckonUpdater is an updater that is given updates for attributes of smoke (density, sigma, color) dead-reckons updates to a DtTacticalSmokeModel based on current simulation time. More...

Inheritance diagram for makVrv::DtSmokePuffsDeadReckonUpdater:

[legend]

Classes
struct	SmokeReckoners
	A structure for pairing dead-reckoning smothers for both density and sigmas. More...

Public Member Functions
	DtSmokePuffsDeadReckonUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtSmokePuffsDeadReckonUpdater ()
	Virtual DTOR.
virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required.
virtual void	update (DtTime tNow)
	Update the model with the current data.
virtual void	setModel (DtTacticalSmokeModel *model)
	Set the model to be updated.
virtual DtTacticalSmokeModel *	model ()
	Get the model being updated.
virtual const DtTacticalSmokeModel *	model () const
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.
virtual DtFixedSmoother &	densityDeadReckoner (int vtx)
	Get the dead-reckoner for density at a given vertex.
virtual DtFixedSmoother &	sigmaDeadReckoner (int vtx)
	Get the dead-reckoner for density at a given vertex.
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.

Protected Attributes
DtDe &	myDe
DtUniqueID	myId
DtTacticalSmokeModel *	mySmokeModel
DtTime	myLastUpdateTime
SmokePuffReckoners	myReckoners
std::string	myMotionModelType
DtDeadReckonTypes	myDeadReckonTypes
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.

Private Types
typedef std::vector < SmokeReckoners * >	SmokePuffReckoners

Private Member Functions
SmokeReckoners *	deadReckoner (int vtx)
	Get the set of dead-reckoner objects a given vertex.
SmokeReckoners *	createSmokeReckoners (SmokeReckoners *other)
	Helper function to create and initialize a new dead-reckoner.
	DtSmokePuffsDeadReckonUpdater ()
	Default constructor.
	DtSmokePuffsDeadReckonUpdater (const DtSmokePuffsDeadReckonUpdater &)
	Copy constructor.
DtSmokePuffsDeadReckonUpdater &	operator= (const DtSmokePuffsDeadReckonUpdater &)
	Assignment Operator.

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR.
	DtTickable ()
	Unimplemented default CTOR.

Detailed Description

DtSmokePuffsDeadReckonUpdater is an updater that is given updates for attributes of smoke (density, sigma, color) dead-reckons updates to a DtTacticalSmokeModel based on current simulation time.

Member Typedef Documentation

typedef std::vector<SmokeReckoners*> makVrv::DtSmokePuffsDeadReckonUpdater::SmokePuffReckoners

private

Constructor & Destructor Documentation

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

CTOR.

Parameters

[in] de is the display engine.

virtual makVrv::DtSmokePuffsDeadReckonUpdater::~DtSmokePuffsDeadReckonUpdater ( )

virtual

Virtual DTOR.

makVrv::DtSmokePuffsDeadReckonUpdater::DtSmokePuffsDeadReckonUpdater ( )

private

Default constructor.

Note: Not implemented

makVrv::DtSmokePuffsDeadReckonUpdater::DtSmokePuffsDeadReckonUpdater ( const DtSmokePuffsDeadReckonUpdater & )

private

Copy constructor.

Note: Not implemented

Member Function Documentation

virtual bool makVrv::DtSmokePuffsDeadReckonUpdater::needsUpdate ( DtTime tNow )

virtual

Check if an update is required.

Parameters

[in] tNow is the current time-stamp.

Return values

true	if this object needs to be ticked.
false	otherwise.

Implements makVrv::DtTickable.

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

virtual

Update the model with the current data.

Parameters

[in] tNow is the current time-stamp.

Implements makVrv::DtTickable.

virtual void makVrv::DtSmokePuffsDeadReckonUpdater::setModel ( DtTacticalSmokeModel * model )

virtual

Set the model to be updated.

Parameters

[in] model is the tactical smoke model to be updated.

virtual DtTacticalSmokeModel* makVrv::DtSmokePuffsDeadReckonUpdater::model ( )

virtual

Get the model being updated.

Returns: The tactical smoke model being updated.

virtual const DtTacticalSmokeModel* makVrv::DtSmokePuffsDeadReckonUpdater::model ( ) const

virtual

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

virtual

Set the current density.

Parameters

[in]	vtx	is the vertex of the scene object.
[in]	dens	is the density to set.

virtual void makVrv::DtSmokePuffsDeadReckonUpdater::setDensityRate	(	int	vtx,
		double	rate
	)

virtual

Set the density rate of change.

Parameters

[in]	vtx	is the vertex of the scene object.
[in]	rate	is the rate of change.

virtual void makVrv::DtSmokePuffsDeadReckonUpdater::setOneSigmas	(	int	vtx,
		const DtVector &	sigma
	)

virtual

Set the current one-sigma distances.

Parameters

[in]	vtx	is the vertex of the scene object.
[in]	sigma	is the one-sigma distances to set.

virtual void makVrv::DtSmokePuffsDeadReckonUpdater::setOneSigmaRates	(	int	vtx,
		const DtVector &	rate
	)

virtual

Set the one-sigma distances rate of change.

Parameters

[in]	vtx	is the vertex of the scene object.
[in]	rate	is the rate of change.

virtual DtFixedSmoother& makVrv::DtSmokePuffsDeadReckonUpdater::densityDeadReckoner ( int vtx )

virtual

Get the dead-reckoner for density at a given vertex.

Parameters

[in] vtx is the vertex of the scene object.

Note: Calling this function will lazy create the dead-reckoner.

virtual DtFixedSmoother& makVrv::DtSmokePuffsDeadReckonUpdater::sigmaDeadReckoner ( int vtx )

virtual

Get the dead-reckoner for density at a given vertex.

Parameters

[in] vtx is the vertex of the scene object.

Note: Calling this function will lazy create the dead-reckoner.

SmokeReckoners* makVrv::DtSmokePuffsDeadReckonUpdater::deadReckoner ( int vtx )

private

Get the set of dead-reckoner objects a given vertex.

Parameters

[in] vtx is the vertex of the scene object.

Note: Calling this function will lazy create the dead-reckoner.

SmokeReckoners* makVrv::DtSmokePuffsDeadReckonUpdater::createSmokeReckoners ( SmokeReckoners * other )

private

Helper function to create and initialize a new dead-reckoner.

with data from a previous dead-reckoner and current updater state.

Parameters

[in] other is the is the object to copy from.

Returns: A newly created dead-reckoner or NULL on failure.

DtSmokePuffsDeadReckonUpdater& makVrv::DtSmokePuffsDeadReckonUpdater::operator= ( const DtSmokePuffsDeadReckonUpdater & )

private

Assignment Operator.

Note: Not implemented

Member Data Documentation

DtDe& makVrv::DtSmokePuffsDeadReckonUpdater::myDe

protected

DtUniqueID makVrv::DtSmokePuffsDeadReckonUpdater::myId

protected

DtTacticalSmokeModel* makVrv::DtSmokePuffsDeadReckonUpdater::mySmokeModel

protected

DtTime makVrv::DtSmokePuffsDeadReckonUpdater::myLastUpdateTime

protected

SmokePuffReckoners makVrv::DtSmokePuffsDeadReckonUpdater::myReckoners

protected

std::string makVrv::DtSmokePuffsDeadReckonUpdater::myMotionModelType

protected

DtDeadReckonTypes makVrv::DtSmokePuffsDeadReckonUpdater::myDeadReckonTypes

protected

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

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

Classes

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation