makVrv::DtTritonWakeUpdater Class Reference

Updater for the Kelvin wake model. More...

Inheritance diagram for makVrv::DtTritonWakeUpdater:

Public Member Functions
	DtTritonWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtTritonWakeUpdater ()
	Virtual DTOR.
virtual void	update (DtTime tNow)
	The update function called by DtTickableManager during update-ticks.
virtual bool	needsUpdate (DtTime tNow)
	Check if an update is required.
virtual void	setPosition (const DtVector &pos)
	Manually set the current position.
virtual void	setOrientation (const DtTaitBryan &ori)
	Manually set the current orientation.
Public Member Functions inherited from makVrv::DtWakeUpdater
	DtWakeUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWakeUpdater ()
	Virtual DTOR.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setWakeModel (DtModel *wakeModel)
	Set the wake model to be updated.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.

Protected Member Functions
virtual DtTritonWakeModel *	wakeModel () const
	Helper method to return a properly cast version of the wake model supplied.
virtual DtVector	calcWakeOrigin (const DtVector &currentPos, const DtTaitBryan &orientation, double wakeOffset)
	Calculate the origin of the wake.
virtual bool	getCurrentShipKinematics (double t, DtVector &position, DtVector &velocity, DtTaitBryan &orientation) const
	Get the ship's current position, velocity, and orientation that this wake is attached to

Protected Attributes
bool	myFirstTick
DtDoubleSmoother	mySpeedSmoother
DtDoubleSmoother	myVelocityXSmoother
DtDoubleSmoother	myVelocityYSmoother
DtDoubleSmoother	myVelocityZSmoother
bool	mySetManually
bool	myPositionUpdated
DtVector	myPosition
DtVector	myLastPosition
DtTaitBryan	myOrientation
Protected Attributes inherited from makVrv::DtWakeUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtModel *	myWakeModel
	A pointer to the current wake model being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update() was called.
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.

Detailed Description

Updater for the Kelvin wake model.

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

Constructor & Destructor Documentation

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

CTOR.

Parameters

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

virtual makVrv::DtTritonWakeUpdater::~DtTritonWakeUpdater ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

The update function called by DtTickableManager during update-ticks.

Parameters

[in]

tNow

is the current time-stamp.

Implements makVrv::DtWakeUpdater.

virtual bool makVrv::DtTritonWakeUpdater::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.

Implements makVrv::DtTickable.

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

virtual

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 from makVrv::DtWakeUpdater.

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

virtual

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 from makVrv::DtWakeUpdater.

virtual DtTritonWakeModel* makVrv::DtTritonWakeUpdater::wakeModel ( ) const

protectedvirtual

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

virtual DtVector makVrv::DtTritonWakeUpdater::calcWakeOrigin ( const DtVector &  currentPos, const DtTaitBryan &  orientation, double  wakeOffset  )

protectedvirtual

Calculate the origin of the wake.

Parameters

[in]	currentPos	is the entity's position.
[in]	currentOrientation	is the entity's orientation.
[in]	wakeOffset	is offset of the wake start from the entity. center

Returns

The position of the center of the circle used to generate a Kelvin wake effect.

virtual bool makVrv::DtTritonWakeUpdater::getCurrentShipKinematics ( double  t, DtVector &  position, DtVector &  velocity, DtTaitBryan &  orientation  ) const

protectedvirtual

Get the ship's current position, velocity, and orientation that this

wake is attached to

Member Data Documentation

bool makVrv::DtTritonWakeUpdater::myFirstTick

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::mySpeedSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityXSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityYSmoother

protected

DtDoubleSmoother makVrv::DtTritonWakeUpdater::myVelocityZSmoother

protected

bool makVrv::DtTritonWakeUpdater::mySetManually

protected

bool makVrv::DtTritonWakeUpdater::myPositionUpdated

protected

DtVector makVrv::DtTritonWakeUpdater::myPosition

protected

DtVector makVrv::DtTritonWakeUpdater::myLastPosition

protected

DtTaitBryan makVrv::DtTritonWakeUpdater::myOrientation

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvTriton/DtTritonWakeUpdater.h