DtSurfaceClampingUpdater is an updater that is given a position and orientation, and will clamp those to dynamic ocean if it exists and the scene object is currently at sea level (or below). More...

Inheritance diagram for makVrv::DtSurfaceClampingUpdater:

[legend]

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

virtual	~DtSurfaceClampingUpdater ()
	DTOR. More...

virtual void	setGroundClampingUpdater (DtGroundClampingUpdater *gndUpdater)
	Set the ground clamping updater to be used when the object to update is not on water. More...

virtual DtGroundClampingUpdater *	findGroundClampingUpdater () const
	Get the ground clamping updater used when the object to update is not on water. More...

virtual void	setWaterClampingUpdater (DtWaterClampingUpdater *waterUpdater)
	Set the water clamping updater to be used when the object to update is on water. More...

virtual DtWaterClampingUpdater *	findWaterClampingUpdater () const
	Get the water clamping updater used when the object to update is on water. More...

virtual void	update (DtTime tNow)
	Calls doGroundClamp() More...

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

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

virtual void	setSceneObject (DtSceneObject *sceneObject)
	Set the scene object to be updated. 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	setPaused (bool isPaused)
	Pause surface clamping. More...

virtual void	setIsAmphibious (bool isAmphibious)
	Set whether the object being updated needs to check for ocean and use the water clamping updater if it is. More...

virtual void	setIsSinking (bool isSinking)
	Set whether a buoyant object is currently sinking. More...

virtual DtOverWaterUpdater *	createOverWaterUpdater ()
	Create an instance of a DtOverWaterUpdater that will be used to determine when an amphibous entity needs a buoyancy updater. More...


virtual unsigned int	landCheckInterval () const
	Get/set the interval at which the updater checks to see if it is over land or water. More...

virtual void	setLandCheckInterval (unsigned int frames)

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

virtual	~DtSceneObjectUpdater ()
	Virtual DTOR. 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	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	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 bool	haveOcean () const

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
DtGroundClampingUpdater *	myGroundClampingUpdater

DtWaterClampingUpdater *	myWaterClampingUpdater

DtDynamicOceanObjectManager &	myDynamicOceanObjectManager

double	myLastLandCheckTime

bool	myIsOnWater

bool	myIsSinking

DtOverWaterUpdater *	myOverWaterUpdater

unsigned int	myLandCheckInterval

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

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

DtSurfaceClampingUpdater is an updater that is given a position and orientation, and will clamp those to dynamic ocean if it exists and the scene object is currently at sea level (or below).

If not clamped to water, the scene object may be clamped to the underlying terrain, depending on how it is configured.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtSurfaceClampingUpdater::~DtSurfaceClampingUpdater ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtSurfaceClampingUpdater::setGroundClampingUpdater ( DtGroundClampingUpdater * gndUpdater )

virtual

Set the ground clamping updater to be used when the object to update is not on water.

virtual DtGroundClampingUpdater* makVrv::DtSurfaceClampingUpdater::findGroundClampingUpdater ( ) const

virtual

Get the ground clamping updater used when the object to update is not on water.

virtual void makVrv::DtSurfaceClampingUpdater::setWaterClampingUpdater ( DtWaterClampingUpdater * waterUpdater )

virtual

Set the water clamping updater to be used when the object to update is on water.

virtual DtWaterClampingUpdater* makVrv::DtSurfaceClampingUpdater::findWaterClampingUpdater ( ) const

virtual

Get the water clamping updater used when the object to update is on water.

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

virtual

Calls doGroundClamp()

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setVertexToUpdate ( unsigned int vertex )

virtual

Specify which vertex in the scene object this updater updates.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setNextUpdater ( DtSceneObjectUpdater * nextUpdater )

virtual

Set the next updater in the updater chain.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setSceneObject ( DtSceneObject * sceneObject )

virtual

Set the scene object to be updated.

Parameters

[in] sceneObject is the scene object to receive updates.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setInputPosition ( const DtVector & position )

virtual

Set the position input to this updater.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setInputOrientation ( const DtTaitBryan & orientation )

virtual

Set the orientation input to this updater.

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtSurfaceClampingUpdater::setPaused ( bool isPaused )

virtual

Pause surface clamping.

virtual void makVrv::DtSurfaceClampingUpdater::setIsAmphibious ( bool isAmphibious )

virtual

Set whether the object being updated needs to check for ocean and use the water clamping updater if it is.

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

virtual

Set whether a buoyant object is currently sinking.

virtual unsigned int makVrv::DtSurfaceClampingUpdater::landCheckInterval ( ) const

virtual

Get/set the interval at which the updater checks to see if it is over land or water.

virtual void makVrv::DtSurfaceClampingUpdater::setLandCheckInterval ( unsigned int frames )

virtual

virtual DtOverWaterUpdater* makVrv::DtSurfaceClampingUpdater::createOverWaterUpdater ( )

virtual

Create an instance of a DtOverWaterUpdater that will be used to determine when an amphibous entity needs a buoyancy updater.

virtual bool makVrv::DtSurfaceClampingUpdater::haveOcean ( ) const

protectedvirtual

Member Data Documentation

DtGroundClampingUpdater* makVrv::DtSurfaceClampingUpdater::myGroundClampingUpdater

protected

DtWaterClampingUpdater* makVrv::DtSurfaceClampingUpdater::myWaterClampingUpdater

protected

DtDynamicOceanObjectManager& makVrv::DtSurfaceClampingUpdater::myDynamicOceanObjectManager

protected

double makVrv::DtSurfaceClampingUpdater::myLastLandCheckTime

protected

bool makVrv::DtSurfaceClampingUpdater::myIsOnWater

protected

bool makVrv::DtSurfaceClampingUpdater::myIsSinking

protected

DtOverWaterUpdater* makVrv::DtSurfaceClampingUpdater::myOverWaterUpdater

protected

unsigned int makVrv::DtSurfaceClampingUpdater::myLandCheckInterval

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation