makVrv::DtWaterClampingUpdater Class Reference

DtWaterClampingUpdater defines the interface for scene object updaters that clamp scene objects to dynamic ocean. More...

Inheritance diagram for makVrv::DtWaterClampingUpdater:

Public Member Functions
	DtWaterClampingUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtWaterClampingUpdater ()
	DTOR.
virtual void	update (DtTime tNow)
	do the actual clamping.
virtual bool	clampToWater (DtTime tNow)
	Clamp an object to the water using the buoyancy model.
virtual void	setPaused (bool paused)
	Pause the bouyancy model (not yet implemented)
virtual void	setWaterlineOriginOffset (float offset)
	Set an altitude offset from the scene object origin to its waterline.
virtual void	setLOD (float lodDistance)
	Set the distance (m) to LOD out the buoyancy simulation.
virtual void	setMinimumCullDistance (float distance)
	Set the distance within which buoyancy won't be frustum culled.
virtual void	setCullType (int cullType)
	Sets the type of buoyancy culling used (FrontFacing or None).
virtual void	setIsSinking (bool isSinking)
Public Member Functions inherited from makVrv::DtSceneObjectUpdater
	DtSceneObjectUpdater (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtSceneObjectUpdater ()
	Virtual DTOR.
virtual void	setNextUpdater (DtSceneObjectUpdater *nextUpdater)
	Set the next updater in the updater chain.
virtual void	setPrevUpdater (DtSceneObjectUpdater *prevUpdater)
	Set the previous updater in the updater chain.
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required.
virtual void	setVertexToUpdate (unsigned int vertex)
	Specify which vertex in the scene object this updater updates.
virtual void	setInputPosition (const DtVector &position)
	Set the position input to this updater.
virtual void	setInputOrientation (const DtTaitBryan &orientation)
	Set the orientation input to this updater.
virtual void	setOutputPosition (const DtVector &position)
	Output the resultant position.
virtual void	setOutputOrientation (const DtTaitBryan &orientation)
	Output the resultant orientation.
virtual DtTime	lastUpdateTime () const
	Get the time-stamp of the last update.
virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated.
DtUniqueID	uniqueId () const
	Returns the distributed object id of this updater.
DtSceneObjectUpdater *	findNextUpdater () const
	Return the next updater in the updater chain.
DtSceneObjectUpdater *	findPrevUpdater () const
	Return the previous updater in the updater chain.
DtSceneObject *	findSceneObject ()
	Get the current scene object for this updater.
DtSceneObject *const	findSceneObject () const
	const correct version
Public Member Functions inherited from makVrv::DtTickable
virtual	~DtTickable ()
	Virtual DTOR.
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update.
virtual unsigned int	updatePeriod () const

Protected Attributes
float	myWaterlineOriginOffset
float	myLodDistance
float	myMinimumCullDistance
DtEntitySettingsRecord::BuoyancyCullType	myCullType
bool	myIsSinking
Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDe &	myDe
	The display engine.
DtUniqueID	myUniqueId
	This distributed object's unique identifier.
DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated.
DtTime	myLastUpdateTime
	The last time stamp when the update()
DtSceneObjectUpdater *	myNextUpdater
	The next updater in the chain (or NULL)
DtSceneObjectUpdater *	myPrevUpdater
	The previous updater in the chain (or NULL)
unsigned int	myVertexToUpdate
	The default scene object vertex to update.
DtVector	myInputPosition
	Input position.
DtTaitBryan	myInputOrientation
	Input Orientation.
bool	myPositionDataOutputted
	Flag to indicate if setOutputPosition has been called this tick.
bool	myOrientationDataOutputted
	Flag to indicate if setOutputOrientation has been called this tick.
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction.
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod

Additional Inherited Members
Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const DtUniqueID &) >	signal_updaterToBeDeleted
Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

Detailed Description

DtWaterClampingUpdater defines the interface for scene object updaters that clamp scene objects to dynamic ocean.

This base class just passes any inputs to the output of the updater, making it possible to instantiate a water clamping updater even if a real dynamic ocean implementation is not available.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtWaterClampingUpdater::~DtWaterClampingUpdater ( )

virtual

DTOR.

Member Function Documentation

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

virtual

do the actual clamping.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual bool makVrv::DtWaterClampingUpdater::clampToWater ( DtTime  tNow )

virtual

Clamp an object to the water using the buoyancy model.

The base class defines a do-nothing pass-through.

Reimplemented in makVrv::DtTritonWaterClampingUpdater.

virtual void makVrv::DtWaterClampingUpdater::setPaused ( bool  paused )

inlinevirtual

Pause the bouyancy model (not yet implemented)

Reimplemented in makVrv::DtTritonWaterClampingUpdater.

virtual void makVrv::DtWaterClampingUpdater::setWaterlineOriginOffset ( float  offset )

virtual

Set an altitude offset from the scene object origin to its waterline.

Reimplemented in makVrv::DtTritonWaterClampingUpdater.

virtual void makVrv::DtWaterClampingUpdater::setLOD ( float  lodDistance )

virtual

Set the distance (m) to LOD out the buoyancy simulation.

Reimplemented in makVrv::DtTritonWaterClampingUpdater.

virtual void makVrv::DtWaterClampingUpdater::setMinimumCullDistance ( float  distance )

virtual

Set the distance within which buoyancy won't be frustum culled.

virtual void makVrv::DtWaterClampingUpdater::setCullType ( int  cullType )

virtual

Sets the type of buoyancy culling used (FrontFacing or None).

virtual void makVrv::DtWaterClampingUpdater::setIsSinking ( bool  isSinking )

virtual

Member Data Documentation

float makVrv::DtWaterClampingUpdater::myWaterlineOriginOffset

protected

float makVrv::DtWaterClampingUpdater::myLodDistance

protected

float makVrv::DtWaterClampingUpdater::myMinimumCullDistance

protected

DtEntitySettingsRecord::BuoyancyCullType makVrv::DtWaterClampingUpdater::myCullType

protected

bool makVrv::DtWaterClampingUpdater::myIsSinking

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtWaterClampingUpdater.h