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

Inheritance diagram for DtGroundInteractionPt:

[legend]

Public Member Functions
	DtGroundInteractionPt ()

	DtGroundInteractionPt (const DtVector &localPosition, DtAttachedTerrain &refFrame)

	DtGroundInteractionPt (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)

	DtGroundInteractionPt (const DtString &name, const DtVector &localPosition=DtVector::zero(), DtAttachedTerrain terrainAttachedTo=0, DtReaderWriterRegistry const parentRegistry=0)

virtual	~DtGroundInteractionPt ()

	DtGroundInteractionPt (const DtGroundInteractionPt &original)
	Copy constructor. More...

DtGroundInteractionPt &	operator= (const DtGroundInteractionPt &original)
	Assignment operator. More...

DtGroundInteractionPt &	operator= (const DtVrfChordIntersectionRecord &intersectionRecord)
	Assign from a chord intersection record. More...

void	init (const DtVector &localPosition, DtAttachedTerrain &terrainAttachedTo)
	Not virtual, because called from constructor. More...

virtual bool	isOnGround ()
	Returns true if myAltitude <= 0.0. More...

virtual DtFloat64	calculatePosition ()
	Updates the position() of the interaction point from the current position and orientation of the parent entity in local coordinates. More...

virtual void	calculatePositionWithoutGround ()
	Computes position() as above, but does not set groundPosition(). More...

virtual const DtVector &	localPosition () const
	Local position is actually the offset from the entity origin in BODY coordinates. More...

virtual void	setLocalPosition (const DtVector &position)

virtual DtAttachedTerrain *	terrainAttachedTo ()
	The terrain that the parent entity is attached to. More...

virtual const DtAttachedTerrain *	terrainAttachedTo () const

virtual void	setTerrainAttachedTo (DtAttachedTerrain *newTerrainAttachedTo)

virtual DtVector	calculateOnGroundPlanePosition () const
	Returns a position, in local coordinates, that is directly above the groundPosition() by a distance localPosition().z. More...

virtual const DtVector &	position () const
	The offset of the point from the entity origin in BODY coordinates. More...

virtual void	setPosition (const DtVector &position)

virtual DtFloat64	altitude () const
	Altitude– updated by calculatePosition or DtVrfObjectStateRepository::placePoints(). More...

virtual void	setAltitude (DtFloat64 alt)

virtual const DtVector &	groundPosition () const
	The projection of the position() onto the ground. More...

virtual void	setGroundPosition (const DtVector &pos)

virtual DtRoughnessSoilType	soilType () const
	Soil type at the position(). More...

virtual void	setSoilType (DtRoughnessSoilType type)

virtual const DtSurface &	surface () const
	Surface at the position(). More...

virtual void	setSurface (const DtSurface &surface)


virtual void	setParentPosition (const DtVector &pos)
	Set the position/orientation of the entity that owns this interaction point, in local coordinates. More...

virtual void	setParentOrientation (const DtDcm &orient)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)
	Set read-only flag. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value. More...

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Protected Member Functions
bool	testInvariant () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtVector	myParentPosition

DtDcm	myParentOrientation

DtRwVector	myLocalPosition

DtVector	myPosition

DtVector	myGroundPosition

DtFloat64	myAltitude

DtRoughnessSoilType	mySoilType

DtSurface	mySurface

DtAttachedTerrain *	myTerrainAttachedTo

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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
	)

DtGroundInteractionPt::DtGroundInteractionPt	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

DtGroundInteractionPt::DtGroundInteractionPt	(	const DtString &	name,
		const DtVector &	localPosition = `DtVector::zero()`,
		DtAttachedTerrain *	terrainAttachedTo = `0`,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

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 DtVrfChordIntersectionRecord & 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

Updates the position() of the interaction point from the current position and orientation of the parent entity in local coordinates.

Note that before this function is called, parentPosition and parentOrientation must be set. Also does a terrain intersection check to set groundPosition() and altitude().

virtual void DtGroundInteractionPt::calculatePositionWithoutGround ( )

virtual

Computes position() as above, but does not set groundPosition().

virtual const DtVector& DtGroundInteractionPt::localPosition ( ) const

virtual

Local position is actually the offset from the entity origin in BODY coordinates.

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

virtual

virtual DtAttachedTerrain* DtGroundInteractionPt::terrainAttachedTo ( )

virtual

The terrain that the parent entity is attached to.

virtual const DtAttachedTerrain* DtGroundInteractionPt::terrainAttachedTo ( ) const

virtual

virtual void DtGroundInteractionPt::setTerrainAttachedTo ( DtAttachedTerrain * newTerrainAttachedTo )

virtual

virtual DtVector DtGroundInteractionPt::calculateOnGroundPlanePosition ( ) const

virtual

Returns a position, in local coordinates, that is directly above the groundPosition() by a distance localPosition().z.

The current parentOrientation must be set, and the groundPosition() must have been calculated by a call to calculatePosition or DtVrfObjectStateRepository::placePoints(). With these positions from 3 interaction points for an entity, an orientation plane can be determined.

virtual const DtVector& DtGroundInteractionPt::position ( ) const

virtual

The offset of the point from the entity origin in BODY coordinates.

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

virtual

virtual DtFloat64 DtGroundInteractionPt::altitude ( ) const

virtual

Altitude– updated by calculatePosition or DtVrfObjectStateRepository::placePoints().

virtual void DtGroundInteractionPt::setAltitude ( DtFloat64 alt )

virtual

virtual const DtVector& DtGroundInteractionPt::groundPosition ( ) const

virtual

The projection of the position() onto the ground.

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

virtual

virtual DtRoughnessSoilType DtGroundInteractionPt::soilType ( ) const

virtual

Soil type at the position().

Set by a call to Set by a call to calculatePosition or DtVrfObjectStateRepository::placePoints().

virtual void DtGroundInteractionPt::setSoilType ( DtRoughnessSoilType type )

virtual

virtual const DtSurface& DtGroundInteractionPt::surface ( ) const

virtual

Surface at the position().

Set by a call to calculatePosition or DtVrfObjectStateRepository::placePoints().

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

virtual

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

virtual

Set the position/orientation of the entity that owns this interaction point, in local coordinates.

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

virtual

bool DtGroundInteractionPt::testInvariant ( ) const

protected

Member Data Documentation

DtVector DtGroundInteractionPt::myParentPosition

protected

DtDcm DtGroundInteractionPt::myParentOrientation

protected

DtRwVector 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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/groundInteractionPt.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation