Updater for the Kelvin tidalStreamWake model. More...

Inheritance diagram for makVrv::DtTritonTidalStreamWakeUpdater:

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

virtual	~DtTritonTidalStreamWakeUpdater ()
	Virtual DTOR. 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...

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

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

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

virtual void	setTidalStreamWakeModel (DtModel *tidalStreamWakeModel)
	Set the tidalStreamWake model to be updated. More...

virtual void	setCurrentSpeed (double speed)
	In m/s. More...

virtual void	setCurrentDirection (double dir)
	In rad from North (clockwise). More...

DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater. 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 DtTritonTidalStreamWakeModel *	tidalStreamWakeModel ()
	Helper method to return a properly cast version of the tidalStreamWake model supplied. More...

virtual DtVector	calcWakeDirection (const DtVector &currentPos, float radiansFromNorth)
	Calculate a normalized helo down vector. More...

virtual void	setTidalStreamWakesEnabled (bool enabled)
	Called when global tidal stream wakes enabled signal is received. More...

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

	DtTickable ()
	Unimplemented default CTOR. More...

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
DtSignalConnectionManager	mySignals

bool	myTidalStreamWakesEnabled

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

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

DtModel *	myTidalStreamWakeModel
	A pointer to the current tidalStreamWake model being updated. More...

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

double	myCurrentSpeed
	In m/s. Only used to override global current speed. More...

double	myCurrentDirection
	In rad from North (clockwise). Only used for override. 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...

Detailed Description

Updater for the Kelvin tidalStreamWake model.

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

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTritonTidalStreamWakeUpdater::~DtTritonTidalStreamWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual bool makVrv::DtTritonTidalStreamWakeUpdater::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::DtTritonTidalStreamWakeUpdater::update ( DtTime tNow )

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in] tNow is the current time-stamp.

Implements makVrv::DtTidalStreamWakeUpdater.

virtual DtTritonTidalStreamWakeModel* makVrv::DtTritonTidalStreamWakeUpdater::tidalStreamWakeModel ( )

protectedvirtual

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

virtual DtVector makVrv::DtTritonTidalStreamWakeUpdater::calcWakeDirection	(	const DtVector &	currentPos,
		float	radiansFromNorth
	)

protectedvirtual

Calculate a normalized helo down vector.

virtual void makVrv::DtTritonTidalStreamWakeUpdater::setTidalStreamWakesEnabled ( bool enabled )

protectedvirtual

Called when global tidal stream wakes enabled signal is received.

Member Data Documentation

DtSignalConnectionManager makVrv::DtTritonTidalStreamWakeUpdater::mySignals

protected

bool makVrv::DtTritonTidalStreamWakeUpdater::myTidalStreamWakesEnabled

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation