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.

Inheritance diagram for makVrv::DtWaterClampingUpdater:

[legend]

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

virtual	~DtWaterClampingUpdater ()

virtual void	update (DtTime tNow)

virtual bool	clampToWater (DtTime tNow)

virtual void	setPaused (bool paused)

virtual void	setWaterlineOriginOffset (float offset)

virtual void	setLOD (float lodDistance)

virtual void	setMinimumCullDistance (float distance)

virtual void	setCullType (int cullType)

virtual void	setIsSinking (bool isSinking)

virtual void	setWaterClampingEnabled (bool enabled)

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

virtual	~DtSceneObjectUpdater ()

virtual void	setNextUpdater (DtSceneObjectUpdater *nextUpdater)

virtual void	setPrevUpdater (DtSceneObjectUpdater *prevUpdater)

virtual bool	needsUpdate (DtTime tNow)

virtual void	updateAdaptiveTickrate (const DtVector &lastPos, const DtTime &deltaTime)

virtual void	setVertexToUpdate (unsigned int vertex)

virtual void	setInputPosition (const DtVector &position)

virtual void	setInputOrientation (const DtTaitBryan &orientation)

virtual void	setOutputPosition (const DtVector &position)

virtual DtVector	outputPosition () const

virtual void	setOutputOrientation (const DtTaitBryan &orientation)

virtual DtTaitBryan	outputOrientation () const

virtual void	setOutputPositionAndOrientation (const DtVector &position, const DtTaitBryan &orientation)

virtual DtTime	lastUpdateTime () const

virtual void	setSceneObject (DtSceneObject *sceneObject, bool addToTickableMgrIfHead)

virtual void	setSceneObject (DtSceneObject *sceneObject)

DtUniqueID	uniqueId () const

DtSceneObjectUpdater *	findNextUpdater () const

DtSceneObjectUpdater *	findPrevUpdater () const

virtual bool	isChainThreadSafe (DtSceneObjectUpdater *firstUpdater)

virtual DtSceneObjectUpdater *	chainHead ()

virtual void	setIsThreadSafe (bool safe)

virtual void	setTickableEnabled (bool enabled) override

virtual void	setAdaptiveTickLodEnabled (bool enabled)

virtual bool	adaptiveTickLodEnabled () const override

virtual void	setLodScaleSpeedFactor (float factor)

virtual float	lodScaleSpeedFactor () const

virtual void	setLodRadiusStart (float ratius)

virtual float	lodRadiusStart () const

virtual void	setLodRadiusEnd (float ratius)

virtual float	lodRadiusEnd () const

virtual void	setNearLodUpdateRate (int nearRate)

virtual int	nearLodUpdateRate () const

virtual void	setFarLodUpdateRate (int maxRate)

virtual int	farLodUpdateRate () const

DtSceneObject *	findActiveSceneObject ()

DtSceneObject *const	findActiveSceneObject () const

DtSceneObject *	findSceneObjectForModelSet (DtModelSetId modelSet)

DtSceneObject *const	findSceneObjectForModelSet (DtModelSetId modelSet) const

virtual void	addSceneObjectToUpdate (DtModelSetId modelSet, DtSceneObject *sceneObject, bool addToTickableMgrIfHead=true)

virtual void	removeSceneObjectToUpdate (DtModelSetId modelSet, DtSceneObject *sceneObject)

virtual void	addSceneObjectToUpdateAtChainEnd (DtModelSetId modelSet, DtSceneObject *sceneObject, bool addToTickableMgrIfHead=true)

virtual void	removeSceneObjectToUpdateAtChainEnd (DtModelSetId modelSet, DtSceneObject *sceneObject)

Public Member Functions inherited from makVrv::DtTickable
virtual bool	updateIfNeeded (DtTime tNow)

virtual	~DtTickable ()

virtual bool	isThreadSafe () const

virtual void	setTickableListState (TickableListState safeList)

virtual TickableListState	tickableListState () const

virtual void	setUpdatePeriod (unsigned int period)

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)

virtual void	removeUnThreadSafeChainFromManager (DtSceneObjectUpdater *head)

virtual void	addThreadSafeChainToManager (DtSceneObjectUpdater *head)

virtual void	addUnThreadSafeChainToManager (DtSceneObjectUpdater *head)

virtual void	placeChainOnCorrectTickableList (DtSceneObjectUpdater *head)

virtual void	slot_sceneObjectToBeDeleted (const DtUniqueID &id)

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

	DtTickable ()=delete

virtual void	slot_managerAboutToBeDeleted ()

Protected Attributes
float	myWaterlineOriginOffset

float	myLodDistance

float	myMinimumCullDistance

DtEntitySettingsRecord::BuoyancyCullType	myCullType

bool	myIsSinking

bool	myWaterClampingEnabled

Protected Attributes inherited from makVrv::DtSceneObjectUpdater
DtDe &	myDe

DtUniqueID	myUniqueId

DtModelSetId	myModelSet

boost::signalslib::connection	mySceneObjectConnection

DtSceneObjectUpdater *	myNextUpdater

DtSceneObjectUpdater *	myPrevUpdater

unsigned int	myVertexToUpdate

DtVector	myLastPositionForAdaptiveTickRate

DtVector	myInputPosition

DtTaitBryan	myInputOrientation

DtVector	myLastOutputPosition

DtTaitBryan	myLastOutputOrientation

bool	myPositionDataOutputted

bool	myOrientationDataOutputted

ModelSetToSceneObjectMap	mySceneObjectMap

SceneObjectConnectionsMap	mySceneObjectConnectionsMap

AdaptiveTickRateLODParams	myAdaptiveTickRateLODParams

Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager

DtSignalConnectionManager	myConnections

unsigned int	myFrameCounter

unsigned int	myFrameToUpdate

unsigned int	myUpdatePeriod

unsigned int	myTickableIndex

DtTime	myLastUpdateTime

bool	myIsThreadSafe

TickableListState	myTickableListState

Friends
class	DtSurfaceClampingUpdater

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }

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

Protected Types inherited from makVrv::DtSceneObjectUpdater
using	ModelSetToSceneObjectMap = std::map< DtModelSetId, DtSceneObject * >

using	SceneObjectConnectionsMap = std::unordered_map< DtUniqueID, boost::signalslib::connection >

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

Sets myIsSinking.

virtual void makVrv::DtWaterClampingUpdater::setWaterClampingEnabled ( bool enabled )

virtual

Sets myWaterClampingEnabled.

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

protectedvirtual

Sets the next updater without adding it to the tickable manager's list of tickables to tick.

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

bool makVrv::DtWaterClampingUpdater::myWaterClampingEnabled

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtWaterClampingUpdater.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation