makVrv::DtTritonRotorWashUpdater Class Reference

Updater for the Kelvin rotorWash model. More...

Inheritance diagram for makVrv::DtTritonRotorWashUpdater:

Public Member Functions
	DtTritonRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonRotorWashUpdater ()
	Virtual DTOR.
virtual void	setRotorWashModel (DtModel *rotorWashModel)
	Overrides the base class (which it calls down to first) and then creates the overwater updater (if it doesn't already exist)
virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required.
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks.
virtual DtOverWaterUpdater *	createOverWaterUpdater ()
	Create an instance of a DtOverWaterUpdater that will be used to determine when a rotor wash should actually be generated.
virtual void	setLandCheckInterval (unsigned int frames)
	Override of the DtRotorWashUpdater::setLandCheckInterval.
Public Member Functions inherited from makVrv::DtRotorWashUpdater
	DtRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtRotorWashUpdater ()
	Virtual DTOR.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
virtual unsigned int	landCheckInterval () const
	Get/set the interval at which the updater checks to see if it is over land or water, in frames.
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 Member Functions
virtual DtTritonRotorWashModel *	rotorWashModel ()
	Helper method to return a properly cast version of the rotorWash model supplied.
virtual DtVector	calcRotorDownDirection (const DtVector &currentPos, const DtTaitBryan &orientation)
	Calculate a normalized helo down vector.

Protected Attributes
DtOverWaterUpdater *	myOverWaterUpdater
Protected Attributes inherited from makVrv::DtRotorWashUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtModel *	myRotorWashModel
	A pointer to the current rotorWash model being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update() was called.
unsigned int	myLandCheckInterval
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

Detailed Description

Updater for the Kelvin rotorWash model.

DtTritonRotorWashUpdater is a distributed object, managed by DtTickableManager. It updates the position, direction and speed of an rotorWash-generating entity

Constructor & Destructor Documentation

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

CTOR.

Parameters

[in]	de	is the display engine.
[in]	id	is a unique identifier for this distributed object.

virtual makVrv::DtTritonRotorWashUpdater::~DtTritonRotorWashUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtTritonRotorWashUpdater::setRotorWashModel ( DtModel *  rotorWashModel )

virtual

Overrides the base class (which it calls down to first) and then creates the overwater updater (if it doesn't already exist)

Parameters

[in]

rotorWashModel

is a pointer to the model to be updated

Reimplemented from makVrv::DtRotorWashUpdater.

virtual bool makVrv::DtTritonRotorWashUpdater::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.

Reimplemented from makVrv::DtTickable.

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

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Implements makVrv::DtRotorWashUpdater.

virtual DtOverWaterUpdater* makVrv::DtTritonRotorWashUpdater::createOverWaterUpdater ( )

virtual

Create an instance of a DtOverWaterUpdater that will be used to determine when a rotor wash should actually be generated.

virtual void makVrv::DtTritonRotorWashUpdater::setLandCheckInterval ( unsigned int  frames )

virtual

Override of the DtRotorWashUpdater::setLandCheckInterval.

Calls down to DtRotorWashUpdater::setLandCheckInterval and then if myOverWaterUpdater exists, sets the update period

Reimplemented from makVrv::DtRotorWashUpdater.

virtual DtTritonRotorWashModel* makVrv::DtTritonRotorWashUpdater::rotorWashModel ( )

protectedvirtual

Helper method to return a properly cast version of the rotorWash model supplied.

virtual DtVector makVrv::DtTritonRotorWashUpdater::calcRotorDownDirection ( const DtVector &  currentPos, const DtTaitBryan &  orientation  )

protectedvirtual

Calculate a normalized helo down vector.

Member Data Documentation

DtOverWaterUpdater* makVrv::DtTritonRotorWashUpdater::myOverWaterUpdater

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvTriton/DtTritonRotorWashUpdater.h