VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
DtArticulatedPartStateRepository Class Reference

DtArticulatedPartStateRepository; class for representing DIS/RPR articulated parts. More...

Inheritance diagram for DtArticulatedPartStateRepository:
Inheritance graph
[legend]

Public Types

enum  DtJointAxis { DtYAW, DtPITCH, DtROLL }
 This will be extended to have a DtNoCONSTRAINT value, and then one of these will be passed as an optional argument to setOrientation() calls in the kinematic state methods. More...

Public Member Functions

 DtArticulatedPartStateRepository (DtVrfObject *simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const
DtArticulatedPartStateRepository
operator= (const DtArticulatedPartStateRepository &orig)
virtual ~DtArticulatedPartStateRepository ()
virtual
DtSimObjectStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString type () const
 returns DtSimObjectStateRepositoryType
DtReal angle () const
 To use angle, setAngle, turnRate, and setTurnRate as written, we will need to cache a constraint value (in the new interface, this constraint is provided as an option value).
DtReal angle (DtKinematicStateCS::DtRotationConstraint constraint) const
DtReal turnRate () const
DtReal turnRate (DtKinematicStateCS::DtRotationConstraint constraint) const
void setTurnRate (DtReal turnRate)
void setTurnRate (DtReal turnRate, DtKinematicStateCS::DtRotationConstraint constraint)
void setAngle (DtReal angle)
void setAngle (DtReal angle, DtKinematicStateCS::DtRotationConstraint constraint)
void setBodyPartType (const DtArtPartType &type)
 
These are converted to/from DtEntityTypes.
DtArtPartType bodyPartType ()
virtual DtReal artPartPosition () const
virtual void setArtPartPosition (DtReal position)
virtual DtReal artPartPositionRate () const
virtual void setArtPartPositionRate (DtReal rate)
virtual DtReal extension () const
virtual void setExtension (DtReal extension)
virtual DtReal extensionRate () const
virtual void setExtensionRate (DtReal rate)
virtual DtReal azimuthNeutralOffset () const
virtual void setAzimuthNeutralOffset (DtReal offset)
- Public Member Functions inherited from DtSimObjectStateRepository
 DtSimObjectStateRepository (DtVrfObject *simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtSimObjectStateRepositoryoperator= (const DtSimObjectStateRepository &orig)
virtual ~DtSimObjectStateRepository ()
virtual const int objectStateRepositorySubType () const
virtual bool init ()
 Our 'virtual' constructor. Calls all the create<>() methods.
virtual void updatePositionFromModelVertices ()
virtual const DtObjectTypeobjectType () const
virtual void setObjectType (const DtObjectType &objectType)
virtual bool createKinematicState ()
 Creates a DtVrfKinematicState.
virtual DtVrfKinematicStatevrfKinematicState ()
virtual const DtVrfKinematicStatevrfKinematicState () const
virtual bool createObjectGeometry ()
virtual DtVrfObjectGeometryvrfObjectGeometry ()
virtual const DtVrfObjectGeometryvrfObjectGeometry () const
virtual bool createAttachments ()
virtual DtAttachmentManagerattachments ()
virtual const DtAttachmentManagerattachments () const
virtual
DtSimObjectStateRepository
parent ()
virtual const
DtSimObjectStateRepository
parent () const
virtual bool isEmbarkedOn (const DtUUID &parent) const
virtual void attachToParent (const DtUUID &parent)
 Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.
virtual void attachToParent (DtSimObjectStateRepository *parent)
 Adds this state repository to the given parent's list of attached state repositories and updates myAttachedToRepository and myRootSimStateRepository.
virtual void detachFromParent ()
virtual const DtUUIDattachedToRepository ()
virtual
DtSimObjectStateRepository
findRootSimStateRepository ()
virtual const
DtSimObjectStateRepository
findRootSimStateRepository () const
virtual void ancestorObjectChanged ()
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Sets myAttachedToRepository after myAttachedToRepositoryName is read in.
virtual void preGetSelf ()
 Hook function called immediately prior to getSelf().
virtual void postGetSelf ()
 Hook function called immediately following getSelf().
virtual bool processCompleteAttachment (DtVrfObject *)
virtual void processObjectAboutToBeRemovedCallback (DtVrfObject *simObject)
virtual class
DtVrfObjectStateRepository
toVrfObjectStateRepository ()
virtual class
DtVrfObjectStateRepository
toVrfObjectStateRepository () const
virtual void setCoordinateSystem (const Coordinate_System *coordinateSystem)
 Sets the coordinate system in myObjectGeometry and myKinematicState.
virtual DtVrfObjectvrfObject ()
virtual const DtVrfObjectvrfObject () const
virtual void setVrfObject (DtVrfObject *vrfObject)
virtual DtSimKinematicStatekinematicState ()
virtual const DtSimKinematicStatekinematicState () const
virtual DtVrfObjectGeometryobjectGeometry ()
virtual const DtVrfObjectGeometryobjectGeometry () const
virtual const DtVectorbodyPosition () const
 Now superseded by kinematic state parentCS functions.
virtual void setBodyPosition (const DtVector &pos)
 Formerly setMeInParent.
virtual void setBodyPosition (DtFloat64 x, DtFloat64 y, DtFloat64 z)
const DtDcm & bodyOrientationMatrix () const
 Formerly meToParent().
virtual void embarkOnParent (const DtUUID &parent)
 Embarks this entity on the specified parent.
virtual bool leftOf (const DtVector &localVector) const
virtual bool inside (const DtVector &point) const
virtual double distanceToLocalVector (const DtVector &localVector) const
 Returns the distance from a position in local.
const Coordinate_SystemcoordinateSystem () const
virtual void removeVertex (int iIndex)
 These routines simply call down to the kinematic state to get/set the results.
virtual void addLocalVertex (const DtVector &vertex)
virtual void addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
virtual void setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
virtual void setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
virtual const DtLocalVertexListlocalVertices () const
virtual const
DtLocalVectorIterator
localVertexIterator () const
virtual void addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
virtual void setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
virtual void setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
virtual const DtVertexListworldVertices () const
virtual const DtRwVectorIteratorworldVertexIterator () const
virtual void setRelativeVertices (const DtLocalVertexList &vertices)
 Access/modify vertices relative to to the parent to which this object is attached.
virtual void setRelativeVertices (const DtList &vertices)
virtual const DtLocalVertexListrelativeVertices () const
virtual const
DtLocalVectorIterator
relativeVertexIterator () const
const DtVectorlocalPosition () const
 Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void setLocalPosition (const DtVector &pos)
const DtVectorlocalVelocity () const
void setLocalVelocity (const DtVector &vel)
const DtVectorlocalAcceleration () const
void setLocalAcceleration (const DtVector &acc)
const DtVectorrelativeVelocity () const
void setRelativeVelocity (const DtVector &vel)
const DtVectorrelativeAcceleration () const
void setRelativeAcceleration (const DtVector &acc)
const DtTaitBryan & localOrientation () const
void setLocalOrientation (const DtTaitBryan &angles)
const DtVectorworldPosition () const
void setWorldPosition (const DtVector &pos)
const DtVectorworldVelocity () const
void setWorldVelocity (const DtVector &vel)
const DtVectorworldAcceleration () const
void setWorldAcceleration (const DtVector &acc)
const DtTaitBryan & worldOrientation () const
void setWorldOrientation (const DtTaitBryan &angles)
const DtVectorrotationalVelocity () const
void setRotationalVelocity (const DtVector &rotationalVelocity)
const DtDcm & localOrientationMatrix () const
void setLocalOrientationMatrix (const DtDcm &orient)
void setParentPosition (const DtVector &pos)
const double lastPositionSetTime () const
 Indicates the last time the position was set, so that a precise position at the current time may be computed.
void setLastPositionSetTime (const double simTime)
- 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 DtReaderWriteroperator= (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 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 aliasContaineraliases () 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 original 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 &)
 Restores 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.

Public Attributes

DtJointAxis myJointAxis

Protected Member Functions

 DtArticulatedPartStateRepository (const DtArticulatedPartStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
- Protected Member Functions inherited from DtSimObjectStateRepository
 DtSimObjectStateRepository (const DtSimObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtSimObjectStateRepository ()
 Default Constructor; not implemented.
virtual void setOrientationRelativeToParent ()
 If attached to a parent, and a terrain database is present, set orientation relative to parent.
- 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

DtReal myArtPartPosition
DtReal myArtPartPositionRate
DtReal myExtension
DtReal myExtensionRate
DtReal myAzimuthNeutralOffset
- Protected Attributes inherited from DtSimObjectStateRepository
DtVrfObjectmySimObject
DtRwObjectType myObjectType
DtVrfObjectGeometrymyObjectGeometry
DtVrfKinematicStatemyKinematicState
DtRwReal myLastPositionSetTime
DtAttachmentManagermyAttachments
DtSimObjectStateRepositorymyAttachedToRepository
DtRwUUID myAttachedToRepositoryUUID
 used for reading & writing the name of myAttachedToRepository
DtSimObjectStateRepositorymyRootSimStateRepository
const Coordinate_SystemmyCoordinateSystemPtr
 Caches pointer to coordinate system so it can set it after myKinematic state is created.
DtKinematicStateCSmyEmbarkedKinematicState
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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.
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Additional Inherited Members

- Static Public Member Functions inherited from DtSimObjectStateRepository
static void completeAttachmentCallback (DtVrfObject *simObject, void *usr)
 These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static void objectAboutToBeRemovedCallback (DtVrfObject *simObject, void *usr)
static DtSimObjectStateRepositoryisSimObjectStateRepository (DtSimObjectStateRepository *repository)
static const
DtSimObjectStateRepository
isSimObjectStateRepository (const DtSimObjectStateRepository *repository)
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
static bool thePutIndent

Detailed Description

DtArticulatedPartStateRepository; class for representing DIS/RPR articulated parts.

The DtArticulatedPartStateRepository class is used to represent articulated parts for an entity. When an entity is created, a tree of articulated part state repository objects gets constructed based on the contents of the parameter database entry. The parameter database entry indicates the type of part to create, which part is should be attached to, and what parameter(s) should be set for the part. The base state repository for this tree is the state repository for the entity.

Member Enumeration Documentation

This will be extended to have a DtNoCONSTRAINT value, and then one of these will be passed as an optional argument to setOrientation() calls in the kinematic state methods.

Enumerator:
DtYAW 
DtPITCH 
DtROLL 

Constructor & Destructor Documentation

DtArticulatedPartStateRepository::DtArticulatedPartStateRepository ( DtVrfObject simObject,
const DtObjectType objectType,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
DtArticulatedPartStateRepository::DtArticulatedPartStateRepository ( const DtArticulatedPartStateRepository orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)
protected
virtual DtArticulatedPartStateRepository::~DtArticulatedPartStateRepository ( )
virtual

Member Function Documentation

const DtArticulatedPartStateRepository& DtArticulatedPartStateRepository::operator= ( const DtArticulatedPartStateRepository orig)
virtual DtSimObjectStateRepository* DtArticulatedPartStateRepository::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual

Reimplemented from DtSimObjectStateRepository.

virtual DtString DtArticulatedPartStateRepository::type ( ) const
virtual

returns DtSimObjectStateRepositoryType

Reimplemented from DtSimObjectStateRepository.

DtReal DtArticulatedPartStateRepository::angle ( ) const

To use angle, setAngle, turnRate, and setTurnRate as written, we will need to cache a constraint value (in the new interface, this constraint is provided as an option value).

DtReal DtArticulatedPartStateRepository::angle ( DtKinematicStateCS::DtRotationConstraint  constraint) const
DtReal DtArticulatedPartStateRepository::turnRate ( ) const
DtReal DtArticulatedPartStateRepository::turnRate ( DtKinematicStateCS::DtRotationConstraint  constraint) const
void DtArticulatedPartStateRepository::setTurnRate ( DtReal  turnRate)
void DtArticulatedPartStateRepository::setTurnRate ( DtReal  turnRate,
DtKinematicStateCS::DtRotationConstraint  constraint 
)
void DtArticulatedPartStateRepository::setAngle ( DtReal  angle)
void DtArticulatedPartStateRepository::setAngle ( DtReal  angle,
DtKinematicStateCS::DtRotationConstraint  constraint 
)
void DtArticulatedPartStateRepository::setBodyPartType ( const DtArtPartType &  type)


These are converted to/from DtEntityTypes.

The state rep for a base part gets DtEntityBase

DtArtPartType DtArticulatedPartStateRepository::bodyPartType ( )
virtual DtReal DtArticulatedPartStateRepository::artPartPosition ( ) const
virtual
virtual void DtArticulatedPartStateRepository::setArtPartPosition ( DtReal  position)
virtual
virtual DtReal DtArticulatedPartStateRepository::artPartPositionRate ( ) const
virtual
virtual void DtArticulatedPartStateRepository::setArtPartPositionRate ( DtReal  rate)
virtual
virtual DtReal DtArticulatedPartStateRepository::extension ( ) const
virtual
virtual void DtArticulatedPartStateRepository::setExtension ( DtReal  extension)
virtual
virtual DtReal DtArticulatedPartStateRepository::extensionRate ( ) const
virtual
virtual void DtArticulatedPartStateRepository::setExtensionRate ( DtReal  rate)
virtual
virtual DtReal DtArticulatedPartStateRepository::azimuthNeutralOffset ( ) const
virtual
virtual void DtArticulatedPartStateRepository::setAzimuthNeutralOffset ( DtReal  offset)
virtual

Member Data Documentation

DtJointAxis DtArticulatedPartStateRepository::myJointAxis
DtReal DtArticulatedPartStateRepository::myArtPartPosition
protected
DtReal DtArticulatedPartStateRepository::myArtPartPositionRate
protected
DtReal DtArticulatedPartStateRepository::myExtension
protected
DtReal DtArticulatedPartStateRepository::myExtensionRate
protected
DtReal DtArticulatedPartStateRepository::myAzimuthNeutralOffset
protected

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)