DtGroundClampingUpdater is a scene object updater that is given a position and orientation, and depending on how it is configured, updates a scene object with a position and orientation that are clamped to the underlying terrain.

Inheritance diagram for makVrv::DtGroundClampingUpdater:

[legend]

Public Types
enum	GroundClampingMode { ClampNone = 0, ClampOrientation = 1, ClampPosition = 2, ClampUpright = 4, ClampOrientationAndPosition = ClampOrientation \| ClampPosition, ClampOrientationAndUpright = ClampOrientation \| ClampUpright, ClampPositionAndUpright = ClampPosition \| ClampUpright, ClampAll = ClampOrientation \| ClampPosition \| ClampUpright }

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

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

virtual	~DtGroundClampingUpdater ()

virtual void	update (DtTime tNow)

virtual void	setGroundClampingEnabled (bool enabled)

virtual void	setMode (GroundClampingMode mode)

bool	isClamping () const

bool	isClampingUp () const

bool	isClampingOrientation () const

bool	isClampingPosition () const

virtual void	setCullCylinderRadiusScale (float scale)

virtual void	setClampAlways (bool enabled)

virtual void	setCheckForCulling (bool)

virtual void	doGroundClamp (DtTime tNow)

virtual void	setClampTimeThreshold (double)

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
bool	computeGroundClampingHit (const DtVector &up, const DtVector &unclampedPosition, DtVector &hitLocation, DtVector &hitNormal)

void	computeIntersectionOrigin (const DtVector &up, const DtVector &unclampedPosition, DtVector &origin) const

bool	needClampThisTick () const

bool	targetIsMoving (const DtVector &newPos, const DtVector &lastPos) const

bool	targetIsTurning (const DtTaitBryan &newOri, const DtTaitBryan &lastOri) const

bool	checkCulling (const DtVector &up) const

void	clampToWater (DtTime tNow)

virtual void	setNextUpdaterWithoutManagerPlacement (DtSceneObjectUpdater *updater)

virtual void	slot_coordinateSystemChanged ()

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 ()

Static Protected Member Functions
static void	computePerpendicularRotation (const DtVector &pos, const DtVector &hitNormal, const DtTaitBryan &orientation, DtTaitBryan &output)

static double	angleDifference (double prev, double curr)

Protected Attributes
bool	myHaveLastClampedPosition

bool	myHaveLastClampedOrientation

DtVector	myLastClampedPosition

DtTaitBryan	myLastClampedOrientation

DtVector	myUnclampedPosition

DtTaitBryan	myUnclampedOrientation

DtVector	myLastUnclampedPosition

DtTaitBryan	myLastUnclampedOrientation

double	myLastCacheUpdateTime

double	myLastClampTime

float	myCullCylinderScale

GroundClampingMode	myMode

DtIntersectionCache *	myIntersectionCache

bool	myGroundClampingEnabled

bool	myClampAlwaysFlag

bool	myClampCulledLastFrame

bool	myCheckForCull

double	myClampTimeThreshold

bool	myBecameEnabledThisTick

DtIntersectorsContainer *	myIntersectors = nullptr

DtCoordinateConverter *	myCoordinateConverter = nullptr

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

Static Protected Attributes
static const double	theClampTimeThreshold

static const double	theMaxCacheInterval

static const double	theClampDistThreshold

static const double	theClampOrientThreshold

static const double	theIsectLength

Friends
class	DtSurfaceClampingUpdater

Additional Inherited Members
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 >

Member Enumeration Documentation

enum makVrv::DtGroundClampingUpdater::GroundClampingMode

Ground Clamping Modes.

Enumerator
ClampNone
ClampOrientation
ClampPosition
ClampUpright
ClampOrientationAndPosition
ClampOrientationAndUpright
ClampPositionAndUpright
ClampAll

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtGroundClampingUpdater::~DtGroundClampingUpdater ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Calls doGroundClamp()

Reimplemented from makVrv::DtSceneObjectUpdater.

virtual void makVrv::DtGroundClampingUpdater::setGroundClampingEnabled ( bool enabled )

virtual

Set whether this updater is enabled. A disabled updater will not ground clamp.

virtual void makVrv::DtGroundClampingUpdater::setMode ( GroundClampingMode mode )

virtual

Set the type of ground clamping to do.

bool makVrv::DtGroundClampingUpdater::isClamping ( ) const

Determine if clamping is enabled, we're close enough, etc.

bool makVrv::DtGroundClampingUpdater::isClampingUp ( ) const

inline

Check to see if the mode supports clamping up.

bool makVrv::DtGroundClampingUpdater::isClampingOrientation ( ) const

inline

Check to see if the mode supports clamping orientation.

bool makVrv::DtGroundClampingUpdater::isClampingPosition ( ) const

inline

Check to see if the mode supports clamping position.

virtual void makVrv::DtGroundClampingUpdater::setCullCylinderRadiusScale ( float scale )

virtual

Set the scale multiplier used to determine whether or not to cull the target according to its distance from the eye-point.

Calculates a cylinder with radius equal to the target's bounding radius multiplied by the scale factor and infinite length, oriented along the local up vector. If the eye-point is outside of that cylinder, the target will not be ground clamped.

virtual void makVrv::DtGroundClampingUpdater::setClampAlways ( bool enabled )

virtual

When enabled, this causes clamping every frame (use judiciously)

virtual void makVrv::DtGroundClampingUpdater::setCheckForCulling ( bool )

virtual

When enabled check for object culling.

virtual void makVrv::DtGroundClampingUpdater::doGroundClamp ( DtTime tNow )

virtual

do the actual clamping. Called by update() Returns true if the object was ground clamped.

virtual void makVrv::DtGroundClampingUpdater::setClampTimeThreshold ( double )

virtual

Sets the threshold for ground clamping by sim time. Any number < 0 will prevent updating based purely on simtime only. Default is 3 seconds. Set time in seconds.

static void makVrv::DtGroundClampingUpdater::computePerpendicularRotation	(	const DtVector &	pos,
		const DtVector &	hitNormal,
		const DtTaitBryan &	orientation,
		DtTaitBryan &	output
	)

staticprotected

Find an orientation perpendicular to the normal vector.

bool makVrv::DtGroundClampingUpdater::computeGroundClampingHit	(	const DtVector &	up,
		const DtVector &	unclampedPosition,
		DtVector &	hitLocation,
		DtVector &	hitNormal
	)

protected

Compute the location and normal ground clamping hit for the current position returns true if a hit was achieved.

void makVrv::DtGroundClampingUpdater::computeIntersectionOrigin	(	const DtVector &	up,
		const DtVector &	unclampedPosition,
		DtVector &	origin
	)		const

protected

Get the position to use as object origin when ground clamping.

bool makVrv::DtGroundClampingUpdater::needClampThisTick ( ) const

protected

Determine if we need to clamp this tick, or can use the last clamp.

bool makVrv::DtGroundClampingUpdater::targetIsMoving	(	const DtVector &	newPos,
		const DtVector &	lastPos
	)		const

protected

Determine if our position has changed since the last time we were clamped.

bool makVrv::DtGroundClampingUpdater::targetIsTurning	(	const DtTaitBryan &	newOri,
		const DtTaitBryan &	lastOri
	)		const

protected

Determine if our orientation has changed since the last time we were clamped.

bool makVrv::DtGroundClampingUpdater::checkCulling ( const DtVector & up ) const

protected

Check to see if the object is culled.

void makVrv::DtGroundClampingUpdater::clampToWater ( DtTime tNow )

protected

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

protectedvirtual

virtual void makVrv::DtGroundClampingUpdater::slot_coordinateSystemChanged ( )

protectedvirtual

slot for when the coordinate system changes

static double makVrv::DtGroundClampingUpdater::angleDifference	(	double	prev,
		double	curr
	)

staticprotected

compensating for rollover issues

Friends And Related Function Documentation

friend class DtSurfaceClampingUpdater

friend

Member Data Documentation

const double makVrv::DtGroundClampingUpdater::theClampTimeThreshold

staticprotected

const double makVrv::DtGroundClampingUpdater::theMaxCacheInterval

staticprotected

const double makVrv::DtGroundClampingUpdater::theClampDistThreshold

staticprotected

const double makVrv::DtGroundClampingUpdater::theClampOrientThreshold

staticprotected

const double makVrv::DtGroundClampingUpdater::theIsectLength

staticprotected

bool makVrv::DtGroundClampingUpdater::myHaveLastClampedPosition

protected

bool makVrv::DtGroundClampingUpdater::myHaveLastClampedOrientation

protected

DtVector makVrv::DtGroundClampingUpdater::myLastClampedPosition

protected

DtTaitBryan makVrv::DtGroundClampingUpdater::myLastClampedOrientation

protected

DtVector makVrv::DtGroundClampingUpdater::myUnclampedPosition

protected

DtTaitBryan makVrv::DtGroundClampingUpdater::myUnclampedOrientation

protected

DtVector makVrv::DtGroundClampingUpdater::myLastUnclampedPosition

protected

DtTaitBryan makVrv::DtGroundClampingUpdater::myLastUnclampedOrientation

protected

double makVrv::DtGroundClampingUpdater::myLastCacheUpdateTime

protected

double makVrv::DtGroundClampingUpdater::myLastClampTime

protected

float makVrv::DtGroundClampingUpdater::myCullCylinderScale

protected

Object is not ground clamped if the camera is farther away than this times the object's bounding radius.

GroundClampingMode makVrv::DtGroundClampingUpdater::myMode

protected

The type of clamping this updater is doing.

DtIntersectionCache* makVrv::DtGroundClampingUpdater::myIntersectionCache

protected

Ground clamping optimization variables.

bool makVrv::DtGroundClampingUpdater::myGroundClampingEnabled

protected

Ground clamping state.

bool makVrv::DtGroundClampingUpdater::myClampAlwaysFlag

protected

Always clamp regardless of time.

bool makVrv::DtGroundClampingUpdater::myClampCulledLastFrame

protected

Was the unclamped position outside the cull cylinder last frame.

bool makVrv::DtGroundClampingUpdater::myCheckForCull

protected

Whether or not to check to see if object is culled. Default is true.

double makVrv::DtGroundClampingUpdater::myClampTimeThreshold

protected

bool makVrv::DtGroundClampingUpdater::myBecameEnabledThisTick

protected

DtIntersectorsContainer* makVrv::DtGroundClampingUpdater::myIntersectors = nullptr

protected

DtCoordinateConverter* makVrv::DtGroundClampingUpdater::myCoordinateConverter = nullptr

protected

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

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation