makVrv::DtTidalStreamWakeUpdater Class Reference

Abstract tidalStreamWake object updater interface. More...

Inheritance diagram for makVrv::DtTidalStreamWakeUpdater:

Public Member Functions
	DtTidalStreamWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtTidalStreamWakeUpdater ()
	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	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	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 *	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...
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

Abstract tidalStreamWake object updater interface.

DtTidalStreamWakeUpdaters are distributed objects, managed by DtTickableManager. They update the tidalStreamWake of DtTidalStreamWakeModels

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTidalStreamWakeUpdater::~DtTidalStreamWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtTidalStreamWakeUpdater::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 tidalStreamWake at the end of their implementation of this function.

Implements makVrv::DtTickable.

Implemented in makVrv::DtTritonTidalStreamWakeUpdater.

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

virtual

Get the time-stamp of the last update.

Returns

The last update time.

virtual void makVrv::DtTidalStreamWakeUpdater::setTidalStreamWakeModel ( DtModel *  tidalStreamWakeModel )

virtual

Set the tidalStreamWake model to be updated.

Parameters

[in]

tidalStreamWakeModel

is a pointer to the model to be updated

virtual void makVrv::DtTidalStreamWakeUpdater::setCurrentSpeed ( double  speed )

virtual

In m/s.

Only used to override global current speed. Set to -1. to start using global current speed again

virtual void makVrv::DtTidalStreamWakeUpdater::setCurrentDirection ( double  dir )

virtual

In rad from North (clockwise).

Only used for override. Set to -1 to start using global direction again

DtUniqueID makVrv::DtTidalStreamWakeUpdater::uniqueId ( ) const

inline

Returns the distributed object id of this updater.

Member Data Documentation

DtDe& makVrv::DtTidalStreamWakeUpdater::myDe

protected

The display engine.

DtUniqueID makVrv::DtTidalStreamWakeUpdater::myUniqueId

protected

This distributed object's unique identifier.

DtModel* makVrv::DtTidalStreamWakeUpdater::myTidalStreamWakeModel

protected

A pointer to the current tidalStreamWake model being updated.

DtTime makVrv::DtTidalStreamWakeUpdater::myLastUpdateTime

protected

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

double makVrv::DtTidalStreamWakeUpdater::myCurrentSpeed

protected

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

double makVrv::DtTidalStreamWakeUpdater::myCurrentDirection

protected

In rad from North (clockwise). Only used for override.

---

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

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