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

Inheritance diagram for makVrv::DtWaterClampingUpdater:

[legend]

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

virtual	~DtWaterClampingUpdater ()
	DTOR. More...

virtual void	update (DtTime tNow)
	do the actual clamping. More...

virtual bool	clampToWater (DtTime tNow)
	Clamp an object to the water using the buoyancy model. More...

virtual void	setPaused (bool paused)
	Pause the bouyancy model (not yet implemented) More...

virtual void	setWaterlineOriginOffset (float offset)
	Set an altitude offset from the scene object origin to its waterline. More...

virtual void	setLOD (float lodDistance)
	Set the distance (m) to LOD out the buoyancy simulation. More...

virtual void	setMinimumCullDistance (float distance)
	Set the distance within which buoyancy won't be frustum culled. More...

virtual void	setCullType (int cullType)
	Sets the type of buoyancy culling used (FrontFacing or None). More...

virtual void	setIsSinking (bool isSinking)

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

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

virtual void	setNextUpdater (DtSceneObjectUpdater *nextUpdater)
	Set the next updater in the updater chain. More...

virtual void	setPrevUpdater (DtSceneObjectUpdater *prevUpdater)
	Set the previous updater in the updater chain. More...

virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required. More...

virtual void	updateAdaptiveTickrate (const DtVector &lastPos, const DtTime &deltaTime)
	This is called by the update function after all the original chaining updates happen. More...

virtual void	setVertexToUpdate (unsigned int vertex)
	Specify which vertex in the scene object this updater updates. More...

virtual void	setInputPosition (const DtVector &position)
	Set the position input to this updater. More...

virtual void	setInputOrientation (const DtTaitBryan &orientation)
	Set the orientation input to this updater. More...

virtual void	setOutputPosition (const DtVector &position)
	Output the resultant position. More...

virtual void	setOutputOrientation (const DtTaitBryan &orientation)
	Output the resultant orientation. More...

virtual void	setOutputPositionAndOrientation (const DtVector &position, const DtTaitBryan &orientation)
	Set both the position and orientation at the same time. More...

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

virtual void	setSceneObject (DtSceneObject *sceneObject, bool addToTickableMgrIfHead)
	Set the scene object to be updated. More...

virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated. More...

virtual void	setLodSystemEnabled (bool enabled)
	brief set if the lod update system is on for this model More...

virtual bool	lodSystemEnabled () const
	brief gets if the lod update system is on for this model More...

virtual void	setLodScaleSpeedFactor (float factor)
	brief sets the value that linearly adjusts the range of the lod radii by the velocity More...

virtual float	lodScaleSpeedFactor () const
	brief gets the value that linearly adjusts the range of the lod radii by the velocity More...

virtual void	setLodRadiusStart (float ratius)
	brief sets the near radius where the update rate starts to fall off More...

virtual float	lodRadiusStart () const
	brief gets the near radius where the update rate starts to fall off More...

virtual void	setLodRadiusEnd (float ratius)
	brief sets the far radius where the update rate stops falling off More...

virtual float	lodRadiusEnd () const
	brief gets the far radius where the update rate stops falling off More...

virtual void	setNearLodUpdateRate (int nearRate)
	sets the update rate at the near radius, defaults to every six ticks More...

virtual int	nearLodUpdateRate () const
	brief gets the update rate at the near radius, defaults to every six ticks More...

virtual void	setFarLodUpdateRate (int maxRate)
	brief the update rate at the far radius, defaults to every 30 ticks More...

virtual int	farLodUpdateRate () const
	brief gets the update rate at the far radius defaults to every 30 ticks More...

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

DtSceneObjectUpdater *	findNextUpdater () const
	Return the next updater in the updater chain. More...

DtSceneObjectUpdater *	findPrevUpdater () const
	Return the previous updater in the updater chain. More...

virtual bool	isChainThreadSafe (DtSceneObjectUpdater *firstUpdater)
	Check all the updaters in the current chain and determine if the chain is thread safe. More...

virtual DtSceneObjectUpdater *	chainHead ()
	Find the first updater in the chain. More...

virtual void	setIsThreadSafe (bool safe)
	Override the DtTickable base class' method so retest the entire chain this updater belongs to. More...

DtSceneObject *	findSceneObject ()
	Get the current scene object for this updater. More...

DtSceneObject *const	findSceneObject () const
	const correct version 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 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

Protected Member Functions
virtual void	setNextUpdaterWithoutManagerPlacement (DtSceneObjectUpdater *updater)

Protected Member Functions inherited from makVrv::DtSceneObjectUpdater
virtual void	removeThreadSafeChainFromManager (DtSceneObjectUpdater *head)
	Helper method to remove an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) from the DtTickableManager's thread-safe tickable list. More...

virtual void	removeUnThreadSafeChainFromManager (DtSceneObjectUpdater *head)
	Helper method to remove an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) from the DtTickableManager's un-thread-safe tickable list. More...

virtual void	addThreadSafeChainToManager (DtSceneObjectUpdater *head)
	Helper method to add an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) to the DtTickableManager's thread-safe tickable list. More...

virtual void	addUnThreadSafeChainToManager (DtSceneObjectUpdater *head)
	Helper method to add an updater (not necessarily this one, but rather the one at the head of the chain that this updater belongs to) to the DtTickableManager's un-thread-safe tickable list. More...

virtual void	placeChainOnCorrectTickableList (DtSceneObjectUpdater *head)
	Examines the chain for the given head updater, removes the head from the approriate ticable list if necessary, and then adds the head to the correct (threaded or unthreaded) tickable list. More...

virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

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

	DtTickable ()
	Unimplemented default CTOR. More...

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
float	myWaterlineOriginOffset

float	myLodDistance

float	myMinimumCullDistance

DtEntitySettingsRecord::BuoyancyCullType	myCullType

bool	myIsSinking

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

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

DtSceneObject *	mySceneObject
	A pointer to the current scene object being updated. More...

int	myModelSet
	This updater is registered as a modelset-specific tickable; this is the modelset it's registered with. More...

boost::signalslib::connection	mySceneObjectConnection

DtSceneObjectUpdater *	myNextUpdater
	The next updater in the chain (or NULL) More...

DtSceneObjectUpdater *	myPrevUpdater
	The previous updater in the chain (or NULL) More...

unsigned int	myVertexToUpdate
	The default scene object vertex to update. More...

DtVector	myInputPosition
	Input position. More...

DtTaitBryan	myInputOrientation
	Input Orientation. More...

bool	myPositionDataOutputted
	Flag to indicate if setOutputPosition has been called this tick. More...

bool	myOrientationDataOutputted
	Flag to indicate if setOutputOrientation has been called this tick. More...

UpdateLODParams	myLodUpdateParams
	automatic lod system params 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

Friends
class	DtSurfaceClampingUpdater

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...

Public Attributes inherited from makVrv::DtSceneObjectUpdater
boost::signal< void(const DtUniqueID &) >	signal_updaterToBeDeleted

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

virtual void makVrv::DtWaterClampingUpdater::setNextUpdaterWithoutManagerPlacement ( DtSceneObjectUpdater * updater )

protectedvirtual

Friends And Related Function Documentation

friend class DtSurfaceClampingUpdater

friend

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:

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation