Abstract wake object updater interface. More...

Inheritance diagram for makVrv::DtWakeUpdater:

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

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

virtual void	update (DtTime tNow)=0
	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	setWakeModel (DtModel *wakeModel)
	Set the wake model to be updated. More...

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

virtual void	setPosition (const DtVector &pos)
	Manually set the current position. More...

virtual void	setOrientation (const DtTaitBryan &ori)
	Manually set the current orientation. More...

virtual void	setIsAmphibious (bool isAmphibious)
	Set whether the wake needs to check to see if its over land. More...

virtual void	setLODDistance (double distance)

virtual void	setFrozen (bool froze)
	If an entity is in the frozen state, use 0 for velocity regardless of what it might send. More...

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 *	myWakeModel
	A pointer to the current wake model being updated. More...

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

double	myLODDistance

bool	myFrozenFlag

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 wake object updater interface.

DtWakeUpdaters are distributed objects, managed by DtTickableManager. They update the wake of DtWakeModels

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtWakeUpdater::~DtWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

pure virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in] tNow is the current time-stamp.

Note: Derived classes should update the wake at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtTritonWakeUpdater.

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

virtual

Get the time-stamp of the last update.

Returns: The last update time.

virtual void makVrv::DtWakeUpdater::setWakeModel ( DtModel * wakeModel )

virtual

Set the wake model to be updated.

Parameters

[in] wakeModel is a pointer to the model to be updated

DtUniqueID makVrv::DtWakeUpdater::uniqueId ( ) const

inline

Returns the distributed object id of this updater.

virtual void makVrv::DtWakeUpdater::setPosition ( const DtVector & pos )

inlinevirtual

Manually set the current position.

Parameters

[in] pos is the position to set.

Note: Only used when ships kinematics cannot be found, such as when creating a wake as a separate entity.

See Also: getCurrentShipKinematics()

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setOrientation ( const DtTaitBryan & ori )

inlinevirtual

Manually set the current orientation.

Parameters

[in] ori is the orientation to set.

Note: Only used when ships kinematics cannot be found, such as when creating a wake as a separate entity.

See Also: getCurrentShipKinematics()

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setIsAmphibious ( bool isAmphibious )

inlinevirtual

Set whether the wake needs to check to see if its over land.

Reimplemented in makVrv::DtTritonWakeUpdater.

virtual void makVrv::DtWakeUpdater::setLODDistance ( double distance )

virtual

virtual void makVrv::DtWakeUpdater::setFrozen ( bool froze )

virtual

If an entity is in the frozen state, use 0 for velocity regardless of what it might send.

Member Data Documentation

DtDe& makVrv::DtWakeUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtWakeUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtWakeUpdater::myWakeModel

protected

A pointer to the current wake model being updated.

DtTime makVrv::DtWakeUpdater::myLastUpdateTime

protected

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

double makVrv::DtWakeUpdater::myLODDistance

protected

bool makVrv::DtWakeUpdater::myFrozenFlag

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation