Updater for the Kelvin rotorWash model. More...

Inheritance diagram for makVrv::DtTritonRotorWashUpdater:

Public Member Functions
	DtTritonRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtTritonRotorWashUpdater ()
	Virtual DTOR. More...

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) More...

virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required. More...

virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks. More...

virtual DtOverWaterUpdater *	createOverWaterUpdater ()
	Create an instance of a DtOverWaterUpdater that will be used to determine when a rotor wash should actually be generated. More...

virtual void	setLandCheckInterval (unsigned int frames)
	Override of the DtRotorWashUpdater::setLandCheckInterval. More...

Public Member Functions inherited from makVrv::DtRotorWashUpdater
	DtRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtRotorWashUpdater ()
	Virtual DTOR. More...

virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update. More...

DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater. More...

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. More...

Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)
	Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...

virtual	~DtTickable ()
	Virtual DTOR. More...

virtual void	setIsThreadSafe (bool safe)
	Get/set whether this tickable can be updated in parallel with other tickables. More...

virtual bool	isThreadSafe () const

virtual void	setTickableListState (TickableListState safeList)
	Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...

virtual TickableListState	tickableListState () const

virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update. More...

virtual unsigned int	updatePeriod () const

virtual bool	lodSystemEnabled () const
	is the update LOD system enabled, overridden by subclasses More...

Protected Member Functions
virtual DtRotorWashModel *	rotorWashModel ()
	Helper method to return a properly cast version of the rotorWash model supplied. More...

virtual DtVector	calcRotorDownDirection (const DtVector &currentPos, const DtTaitBryan &orientation)
	Calculate a normalized helo down vector. More...

Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...

	DtTickable ()
	Unimplemented default CTOR. More...

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtOverWaterUpdater *	myOverWaterUpdater

Protected Attributes inherited from makVrv::DtRotorWashUpdater
DtDe &	myDe
	The display engine. More...

DtUniqueID	myUniqueId
	This distributed object's unique identifier. More...

DtModel *	myRotorWashModel
	A pointer to the current rotorWash model being updated. More...

DtTime	myLastUpdateTime
	The last time stamp when the update() was called. More...

unsigned int	myLandCheckInterval
	How often to check if over water (default every 60 frames) More...

Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction. More...

DtSignalConnectionManager	myConnections

unsigned int	myFrameCounter

unsigned int	myFrameToUpdate

unsigned int	myUpdatePeriod

DtTime	myLastUpdateTime

bool	myIsThreadSafe

TickableListState	myTickableListState

Private Member Functions
	DtTritonRotorWashUpdater (const DtTritonRotorWashUpdater &other)
	Copy Constructor not implemented – Copy Not Allowed. More...

DtTritonRotorWashUpdater &	operator= (const DtTritonRotorWashUpdater &other)
	Assignment Operator Not implemented � Assignment Not Allowed. More...

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
	Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...

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.

makVrv::DtTritonRotorWashUpdater::DtTritonRotorWashUpdater ( const DtTritonRotorWashUpdater & other )

private

Copy Constructor not implemented – Copy Not Allowed.

Member Function Documentation

DtTritonRotorWashUpdater& makVrv::DtTritonRotorWashUpdater::operator= ( const DtTritonRotorWashUpdater & other )

private

Assignment Operator Not implemented � Assignment Not Allowed.

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.

Reimplemented from 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 DtRotorWashModel* 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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvTriton/DtTritonRotorWashUpdater.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation