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)
	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.
DtGroundInteractionPt &	operator= (const DtGroundInteractionPt &original)
	Assignment operator.
DtGroundInteractionPt &	operator= (const DtVrfChordIntersectionRecord &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)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
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.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
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.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
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.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
bool	testInvariant () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

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.
bool	myInvalid
	Set to true if there is a problem reading this item.

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.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
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

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

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

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/groundInteractionPt.h