![]() |
VR-Forces Development_Version Class Documentation
|
DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component. More...

Public Member Functions | |
| DtHumanMovementActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0) | |
| real constructor | |
| DtHumanMovementActuatorDescriptor (const DtHumanMovementActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| virtual | ~DtHumanMovementActuatorDescriptor () |
| DtHumanMovementActuatorDescriptor & | operator= (const DtHumanMovementActuatorDescriptor &orig) |
| assignment | |
| virtual DtString | type () const |
| Returns the type of component this descriptor describes. | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=0) const |
| virtual bool | checkForTerrainCollisions () const |
| Accessor/mutator for myCheckForTerrainCollisions. | |
| virtual void | setCheckForTerrainCollisions (bool yesOrNo) |
| Accessor/mutator for myCheckForTerrainCollisions. | |
| virtual double | maxUprightTerrainPitch () const |
| Accessor/mutator for myMaxUprightTerrainPitch. | |
| virtual void | setMaxUprightTerrainPitch (double pitch) |
| Accessor/mutator for myMaxUprightTerrainPitch. | |
| virtual double | maxWalkingSpeed () const |
| Accessor/mutator for #myMaxWalkingSpeeed. | |
| virtual void | setMaxWalkingSpeed (double speed) |
| Accessor/mutator for #myMaxWalkingSpeeed. | |
| virtual const DtRwStaticDynamicPostureList & | staticToDynamicPostureMap () const |
| Accessor for myStaticToDynamicPostureMap. | |
| virtual const DtRwSoilSpeedFactorList & | soilToMaxSpeedFactorMap () const |
| Accessor for mySoilToMaxSpeedFactorMap. | |
| virtual bool | constrainFacingTurnRate () const |
| virtual void | setConstrainFacingTurnRate (bool v) |
| virtual double | maxFacingTurnRate () const |
| virtual void | setMaxFacingTurnRate (double v) |
Public Member Functions inherited from DtActuatorComponentDescriptor | |
| DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtActuatorComponentDescriptor & | operator= (const DtActuatorComponentDescriptor &orig) |
| assignment | |
| virtual | ~DtActuatorComponentDescriptor () |
| destructor | |
| virtual void | setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList) |
| Accessor/mutator for myArtPartDescriptorList. | |
| virtual const DtSimArtPartDescriptorList & | artPartDescriptorList () const |
| Accessor/mutator for myArtPartDescriptorList. | |
Public Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtComponentDescriptor & | operator= (const DtComponentDescriptor &orig) |
| assignment | |
| virtual | ~DtComponentDescriptor () |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| Overrides base class putData to output our type. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actually stored. | |
| virtual bool | init () |
| Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. | |
| bool | operator== (const DtComponentDescriptor &) const |
| DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual void | setComponentType (const DtString &componentType) |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual const DtString & | componentType () const |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTickPeriod () const |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| virtual DtReal | minTickPeriodVariance () const |
| virtual void | setTickPeriodUsesRealTime (bool value) |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual bool | tickPeriodUsesRealTime () const |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual const DtString & | processStateRepositoryName () const |
| Name which this component will assign to its PSR. | |
| virtual void | setProcessStateRepositoryName (const DtString &name) |
| Name which this component will assign to its PSR. | |
| virtual const DtString & | processStateRepositoryType () const |
| Type of PSR this component will create. | |
| virtual void | setProcessStateRepositoryType (const DtString &type) |
| Type of PSR this component will create. | |
| virtual void | setIsEnabled (bool yesNo) |
| Is the component enabled or not. | |
| virtual bool | isEnabled () const |
| Is the component enabled or not. | |
| virtual void | setDebugActive (bool active) |
| Should detailed debug info be printed for this component. | |
| virtual bool | debugActive () const |
| Should detailed debug info be printed for this component. | |
| virtual void | setMinTaskVisualizationTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTaskVisualizationTickPeriod () const |
| virtual void | setCreateComponent (bool yesNo) |
| Should the component be created or not. | |
| virtual bool | createComponent () const |
| Should the component be created or not. | |
| virtual void | setCreateOnRemoteObject (bool yesNo) |
| Whether or not this component is created on remote versions of the object. | |
| virtual bool | createOnRemoteObject () const |
| Whether or not this component is created on remote versions of the object. | |
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 DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| 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 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) |
| The variable name, if this object is a variable reference. | |
| 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 () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| 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 () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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. | |
Static Public Member Functions | |
| static DtComponentDescriptor * | creator () |
| | |
Protected Member Functions | |
| DtHumanMovementActuatorDescriptor () | |
| default constructor; not implemented | |
Protected Member Functions inherited from DtActuatorComponentDescriptor | |
| DtActuatorComponentDescriptor () | |
| default constructor; not implemented | |
Protected Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor () | |
| default constructor; not implemented | |
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 | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwBoolean | myCheckForTerrainCollisions |
| Parameter Name: check-terrain-collisions Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity. | |
| DtRwReal | myMaxUprightTerrainPitch |
| Parameter Name: max-upright-terrain-pitch Parameter Description: Maximum terrain pitch at which entity can maintain a static upright posture (i.e. | |
| DtRwReal | myMaxWalkingSpeed |
| Parameter Name: max-walking-speed Parameter Description: Maximum speed at which entity will walk. | |
| DtRwStaticDynamicPostureList | myStaticToDynamicPostureMap |
| Parameter Name: static-to-dynamic_posture-map Parameter Description: Map of static postures to dynamic postures that actuator will map to when entity is moving. | |
| DtRwSoilSpeedFactorList | mySoilToMaxSpeedFactorMap |
| Parameter Name: soil-to-max-speed-factor-map Parameter Description: Map of soil type to a multiplier used to scale the maximum speed of an entity. | |
| DtRwBoolean | myConstrainFacingTurnRate |
| Parameter Name: constrain-facing-turn-rate Parameter Description: Boolean indicating whether or not the rate of change in the facing direction of the entity will be constrained. | |
| DtRwReal | myMaxFacingTurnRate |
| Parameter Name: max-facing-turn-rate Parameter Description: The maximum rate the entity's facing direction will change. | |
Protected Attributes inherited from DtActuatorComponentDescriptor | |
| DtSimArtPartDescriptorList | myArtPartDescriptorList |
| Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator. | |
Protected Attributes inherited from DtComponentDescriptor | |
| DtRwString | myComponentType |
| Parameter Name: component-type Parameter Description: String identifying type of component. | |
| DtRwReal | myMinTickPeriod |
| Parameter Name: min-tick-period Parameter Description: Average tick period for this component. | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. | |
| DtRwBoolean | myTickPeriodUsesRealTime |
| Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. | |
| DtRwString | myProcessStateRepositoryName |
| Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. | |
| DtRwString | myProcessStateRepositoryType |
| Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. | |
| DtRwBoolean | myIsEnabled |
| Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. | |
| DtRwBoolean | myDebug |
| This parameter defaults to false. | |
| DtRwReal | myMinTaskVisualizationTickPeriod |
| Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. | |
| DtRwBoolean | myCreateComponent |
| Parameter Name: component-type Parameter Description: String identifying type of component. | |
| DtRwBoolean | myCreateOnRemoteObject |
| Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. | |
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 Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component.
Instances of DtHumanMovementActuatorDescriptor are used to specify the parameters for a DtHumanMovementActuator component.
| DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor | ( | const DtString & | componentName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
real constructor
| DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor | ( | const DtHumanMovementActuatorDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
|
protected |
default constructor; not implemented
| DtHumanMovementActuatorDescriptor& DtHumanMovementActuatorDescriptor::operator= | ( | const DtHumanMovementActuatorDescriptor & | orig | ) |
assignment
|
virtual |
Returns the type of component this descriptor describes.
Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.
Reimplemented from DtActuatorComponentDescriptor.
|
virtual |
Reimplemented from DtActuatorComponentDescriptor.
|
static |
Reimplemented from DtActuatorComponentDescriptor.
|
virtual |
Accessor/mutator for myCheckForTerrainCollisions.
|
virtual |
Accessor/mutator for myCheckForTerrainCollisions.
|
virtual |
Accessor/mutator for myMaxUprightTerrainPitch.
|
virtual |
Accessor/mutator for myMaxUprightTerrainPitch.
|
virtual |
Accessor/mutator for #myMaxWalkingSpeeed.
|
virtual |
Accessor/mutator for #myMaxWalkingSpeeed.
|
virtual |
Accessor for myStaticToDynamicPostureMap.
|
virtual |
Accessor for mySoilToMaxSpeedFactorMap.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
protected |
Parameter Name: check-terrain-collisions
Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity.
If this returns true, then the actuator will not move the entity through terrain.
Parameter Default Value: False
|
protected |
Parameter Name: max-upright-terrain-pitch
Parameter Description: Maximum terrain pitch at which entity can maintain a static upright posture (i.e.
standing posture). Actuator will switch to a prone posture when terrain pitch exceeds this value.
Parameter Units: radians Parameter Default Value: 0.5236
|
protected |
Parameter Name: max-walking-speed
Parameter Description: Maximum speed at which entity will walk.
Actuator will switch from a walking posture to a running posture when current speed exceeds this value. Parameter Units: meters/second Parameter Default Value: 2.0
|
protected |
Parameter Name: static-to-dynamic_posture-map
Parameter Description: Map of static postures to dynamic postures that actuator will map to when entity is moving.
The actuator recieves static posture as input which it sets when the entity is not moving. If the entity is moving, it uses this map to determine the appropriate (closest) moving posture to switch to. For example, if current static posture is 'prone', and the entity starts to move, switch to a dynamic posture of 'crawling'. Parameter Units: Parameter Default Value:
|
protected |
Parameter Name: soil-to-max-speed-factor-map
Parameter Description: Map of soil type to a multiplier used to scale the maximum speed of an entity.
This factor is multiplied by the entity's overall maximum speed to obtain a maximum speed appropriate for the soil conditions. The available soil types are: "paved-road" "hard-packed" "rocks" "sand" "gravel" "shallow-water" "muck" "deep-water" Parameter Units: Parameter Default Value:
|
protected |
Parameter Name: constrain-facing-turn-rate
Parameter Description: Boolean indicating whether or not the rate of change in the facing direction of the entity will be constrained.
If true, the max-facing-turn-rate is used. Parameter Units: boolean Parameter Default Value: true
|
protected |
Parameter Name: max-facing-turn-rate
Parameter Description: The maximum rate the entity's facing direction will change.
Note: This does not constrain the entity's movement direction. Parameter Units: radians/sec Parameter Default Value: 4.71 (270 deg/s)