VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions
DtRwGroundInteractionPt Class Reference

Read/writable DtGroundInteraction Point. More...

Inheritance diagram for DtRwGroundInteractionPt:
Inheritance graph
[legend]

Public Member Functions

 DtRwGroundInteractionPt ()
 DtRwGroundInteractionPt (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
 DtRwGroundInteractionPt (const DtString &name, const DtVector &localPosition=DtVector::zero(), DtAttachedTerrain *terrainAttachedTo=0, DtReaderWriterRegistry *const parentRegistry=0)
virtual ~DtRwGroundInteractionPt ()
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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 bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
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 DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
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 void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
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 DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
- Public Member Functions inherited from DtGroundInteractionPt
 DtGroundInteractionPt ()
 DtGroundInteractionPt (const DtVector &localPosition, DtAttachedTerrain &refFrame)
virtual ~DtGroundInteractionPt ()
 DtGroundInteractionPt (const DtGroundInteractionPt &original)
 Copy constructor.
DtGroundInteractionPtoperator= (const DtGroundInteractionPt &original)
 Assignment operator.
DtGroundInteractionPtoperator= (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 DtVectorlocalPosition () const
virtual void setLocalPosition (const DtVector &position)
virtual DtAttachedTerrainterrainAttachedTo ()
virtual const DtAttachedTerrainterrainAttachedTo () 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 DtVectorposition () const
 These simply return the corresponding member variable.
virtual DtFloat64 altitude () const
virtual void setAltitude (DtFloat64 alt)
virtual const DtVectorgroundPosition () const
virtual void setGroundPosition (const DtVector &pos)
virtual DtRoughnessSoilType soilType () const
virtual void setSoilType (DtRoughnessSoilType type)
virtual const DtSurfacesurface () const
virtual void setSurface (const DtSurface &surface)
virtual void setParentPosition (const DtVector &pos)
virtual void setParentOrientation (const DtDcm &orient)

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::pair
< DtSymbolString, DtString
DtVariableNameType
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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.
- Protected Member Functions inherited from DtGroundInteractionPt
bool testInvariant () const
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
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.
- Protected Attributes inherited from DtGroundInteractionPt
DtVector myParentPosition
DtDcm myParentOrientation
DtVector myLocalPosition
DtVector myPosition
DtVector myGroundPosition
DtFloat64 myAltitude
DtRoughnessSoilType mySoilType
DtSurface mySurface
DtAttachedTerrainmyTerrainAttachedTo
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

Read/writable DtGroundInteraction Point.

Most of this class is just derived state. The only thing we read/write is the local position value, which is the offset of the ground interaction point from the center of the vehicle base.

Constructor & Destructor Documentation

DtRwGroundInteractionPt::DtRwGroundInteractionPt ( )
DtRwGroundInteractionPt::DtRwGroundInteractionPt ( const DtString name,
DtReaderWriterRegistry *const  parentRegistry = 0 
)
DtRwGroundInteractionPt::DtRwGroundInteractionPt ( const DtString name,
const DtVector localPosition = DtVector::zero(),
DtAttachedTerrain terrainAttachedTo = 0,
DtReaderWriterRegistry *const  parentRegistry = 0 
)
virtual DtRwGroundInteractionPt::~DtRwGroundInteractionPt ( )
virtual

Member Function Documentation

virtual void DtRwGroundInteractionPt::putData ( FILE *  fp,
int  indentLevel = 0 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwGroundInteractionPt::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)