makVrv::DtRotorWashUpdater Class Reference

Abstract rotorWash object updater interface. More...

Inheritance diagram for makVrv::DtRotorWashUpdater:

Public Member Functions
	DtRotorWashUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtRotorWashUpdater ()
	Virtual DTOR. More...
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks. More...
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update. More...
virtual void	setRotorWashModel (DtModel *rotorWashModel)
	Set the rotorWash model to be updated. 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...
virtual void	setLandCheckInterval (unsigned int frames)
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required. More...
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 Attributes
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

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...
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Abstract rotorWash object updater interface.

DtRotorWashUpdaters are distributed objects, managed by DtTickableManager. They update the rotorWash of DtRotorWashModels

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtRotorWashUpdater::~DtRotorWashUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Note

Derived classes should update the rotorWash at the end of their implementation of this function.

Implements makVrv::DtTickable.

Reimplemented in makVrv::DtTritonRotorWashUpdater, and makVrv::DtParticleRotorWashUpdater.

virtual DtTime makVrv::DtRotorWashUpdater::lastUpdateTime ( ) const

virtual

Get the time-stamp of the last update.

Returns

The last update time.

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

virtual

Set the rotorWash model to be updated.

Parameters

[in]

rotorWashModel

is a pointer to the model to be updated

Reimplemented in makVrv::DtTritonRotorWashUpdater.

virtual unsigned int makVrv::DtRotorWashUpdater::landCheckInterval ( ) const

virtual

Get/set the interval at which the updater checks to see if it is over land or water, in frames.

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

virtual

Reimplemented in makVrv::DtTritonRotorWashUpdater.

DtUniqueID makVrv::DtRotorWashUpdater::uniqueId

(

)

const

Returns the distributed object id of this updater.

Member Data Documentation

DtDe& makVrv::DtRotorWashUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtRotorWashUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtRotorWashUpdater::myRotorWashModel

protected

A pointer to the current rotorWash model being updated.

DtTime makVrv::DtRotorWashUpdater::myLastUpdateTime

protected

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

unsigned int makVrv::DtRotorWashUpdater::myLandCheckInterval

protected

How often to check if over water (default every 60 frames)

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtRotorWashUpdater.h