DtGroundInteractionPt Class Reference

Class Invariant: The DtGroundInteractionPt class must always have a valid DtAttachedTerrain or DtSimManager pointer. More...

Inheritance diagram for DtGroundInteractionPt:

Public Member Functions
	DtGroundInteractionPt ()
	DtGroundInteractionPt (const DtVector &localPosition, DtAttachedTerrain &refFrame)
virtual	~DtGroundInteractionPt ()
	DtGroundInteractionPt (const DtGroundInteractionPt &original)
	Copy constructor.
DtGroundInteractionPt &	operator= (const DtGroundInteractionPt &original)
	Assignment operator.
DtGroundInteractionPt &	operator= (const DtChordIntersectionRecord &intersectionRecord)
	Assign from a chord intersection record.
void	init (const DtVector &localPosition, DtAttachedTerrain &terrainAttachedTo)
	Not virtual, because called from constructor.
virtual bool	isOnGround ()
	Returns true if myAltitude <= 0.0.
virtual DtFloat64	calculatePosition ()
	Calculates position in world coordinates, and returns altitude above or below ground.
virtual void	calculatePositionWithoutGround ()
	Just calculate the position value using the parent's position.
virtual const DtVector &	localPosition () const
virtual void	setLocalPosition (const DtVector &position)
virtual DtAttachedTerrain *	terrainAttachedTo ()
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual void	setTerrainAttachedTo (DtAttachedTerrain *newTerrainAttachedTo)
virtual void	setPosition (const DtVector &position)
virtual DtVector	calculateOnGroundPlanePosition () const
	If the ground interaction point is used to actually place an object on the ground by offsetting the object's position relative to the ground by the interaction point offset amounts, this is the position on the plane in which the (offset) object will lie, directly above the ground interaction point.
virtual const DtVector &	position () const
	These simply return the corresponding member variable.
virtual DtFloat64	altitude () const
virtual void	setAltitude (DtFloat64 alt)
virtual const DtVector &	groundPosition () const
virtual void	setGroundPosition (const DtVector &pos)
virtual DtRoughnessSoilType	soilType () const
virtual void	setSoilType (DtRoughnessSoilType type)
virtual const DtSurface &	surface () const
virtual void	setSurface (const DtSurface &surface)
virtual void	setParentPosition (const DtVector &pos)
virtual void	setParentOrientation (const DtDcm &orient)

Protected Member Functions
bool	testInvariant () const

Protected Attributes
DtVector	myParentPosition
DtDcm	myParentOrientation
DtVector	myLocalPosition
DtVector	myPosition
DtVector	myGroundPosition
DtFloat64	myAltitude
DtRoughnessSoilType	mySoilType
DtSurface	mySurface
DtAttachedTerrain *	myTerrainAttachedTo

Detailed Description

Class Invariant: The DtGroundInteractionPt class must always have a valid DtAttachedTerrain or DtSimManager pointer.

Constructor & Destructor Documentation

DtGroundInteractionPt::DtGroundInteractionPt

(

)

DtGroundInteractionPt::DtGroundInteractionPt	(	const DtVector &	localPosition,
		DtAttachedTerrain &	refFrame
	)

virtual DtGroundInteractionPt::~DtGroundInteractionPt ( )

virtual

DtGroundInteractionPt::DtGroundInteractionPt

(

const DtGroundInteractionPt &

original

)

Copy constructor.

Member Function Documentation

DtGroundInteractionPt& DtGroundInteractionPt::operator=

(

const DtGroundInteractionPt &

original

)

Assignment operator.

DtGroundInteractionPt& DtGroundInteractionPt::operator=

(

const DtChordIntersectionRecord &

intersectionRecord

)

Assign from a chord intersection record.

void DtGroundInteractionPt::init	(	const DtVector &	localPosition,
		DtAttachedTerrain &	terrainAttachedTo
	)

Not virtual, because called from constructor.

virtual bool DtGroundInteractionPt::isOnGround ( )

virtual

Returns true if myAltitude <= 0.0.

virtual DtFloat64 DtGroundInteractionPt::calculatePosition ( )

virtual

Calculates position in world coordinates, and returns altitude above or below ground.

Above ground is defined as positive altitude. Also sets the ground position.

virtual void DtGroundInteractionPt::calculatePositionWithoutGround ( )

virtual

Just calculate the position value using the parent's position.

virtual const DtVector& DtGroundInteractionPt::localPosition ( ) const

virtual

virtual void DtGroundInteractionPt::setLocalPosition ( const DtVector &  position )

virtual

virtual DtAttachedTerrain* DtGroundInteractionPt::terrainAttachedTo ( )

virtual

virtual const DtAttachedTerrain* DtGroundInteractionPt::terrainAttachedTo ( ) const

virtual

virtual void DtGroundInteractionPt::setTerrainAttachedTo ( DtAttachedTerrain *  newTerrainAttachedTo )

virtual

virtual void DtGroundInteractionPt::setPosition ( const DtVector &  position )

virtual

virtual DtVector DtGroundInteractionPt::calculateOnGroundPlanePosition ( ) const

virtual

If the ground interaction point is used to actually place an object on the ground by offsetting the object's position relative to the ground by the interaction point offset amounts, this is the position on the plane in which the (offset) object will lie, directly above the ground interaction point.

This can only be used if the groundPosition() has already been determined by calling calculatePosition() (or set directly via mutator) and the parentOrientation has been provided.

virtual const DtVector& DtGroundInteractionPt::position ( ) const

virtual

These simply return the corresponding member variable.

calculatePosition() must be called for them to be up-to-date.

virtual DtFloat64 DtGroundInteractionPt::altitude ( ) const

virtual

virtual void DtGroundInteractionPt::setAltitude ( DtFloat64  alt )

virtual

virtual const DtVector& DtGroundInteractionPt::groundPosition ( ) const

virtual

virtual void DtGroundInteractionPt::setGroundPosition ( const DtVector &  pos )

virtual

virtual DtRoughnessSoilType DtGroundInteractionPt::soilType ( ) const

virtual

virtual void DtGroundInteractionPt::setSoilType ( DtRoughnessSoilType  type )

virtual

virtual const DtSurface& DtGroundInteractionPt::surface ( ) const

virtual

virtual void DtGroundInteractionPt::setSurface ( const DtSurface &  surface )

virtual

virtual void DtGroundInteractionPt::setParentPosition ( const DtVector &  pos )

virtual

virtual void DtGroundInteractionPt::setParentOrientation ( const DtDcm &  orient )

virtual

bool DtGroundInteractionPt::testInvariant ( ) const

protected

Member Data Documentation

DtVector DtGroundInteractionPt::myParentPosition

protected

DtDcm DtGroundInteractionPt::myParentOrientation

protected

DtVector DtGroundInteractionPt::myLocalPosition

protected

DtVector DtGroundInteractionPt::myPosition

protected

DtVector DtGroundInteractionPt::myGroundPosition

protected

DtFloat64 DtGroundInteractionPt::myAltitude

protected

DtRoughnessSoilType DtGroundInteractionPt::mySoilType

protected

DtSurface DtGroundInteractionPt::mySurface

protected

DtAttachedTerrain* DtGroundInteractionPt::myTerrainAttachedTo

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/groundInteractionPt.h