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

DtHumanMovementActuator is a simple movement actuator for lifeforms. More...

Inheritance diagram for DtHumanMovementActuator:
Inheritance graph
[legend]

Public Types

typedef std::map
< DtLifeformStaticPosture,
DtLifeformState > 
DtStaticToDynamicPostureMap

Public Member Functions

 DtHumanMovementActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtHumanMovementActuator ()
 destructor
virtual bool init ()
 to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void tick ()
 This gives the thread of control to the component.
- Public Member Functions inherited from DtActuatorComponent
virtual ~DtActuatorComponent ()
 destructor
virtual DtSimRadioradio ()
virtual bool tickWhileDestroyed () const
 By default, all actuators tick when the entity is destroyed.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preprocess ()
 Perform parallel preprocessing prior to tick and similar computations.
virtual void parallelTick ()
 called in parallel
virtual void preFirstTickInit ()
 called from preprocess if appropriate
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
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 actual stored.
virtual void addInputPort (DtInputPort *port)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPort (DtInputPort *port)
virtual DtInputPortlookupInputPort (const DtString &portName)
 Returns a pointer to the input port registered on this component with the specified name.
virtual DtList inputPortList () const
 Returns the list of DtInputPorts registered on this component.
virtual void addOutputPort (DtOutputPort *port)
 Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void removeOutputPort (DtOutputPort *port)
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 Returns a pointer to the output port registered on this component with the specified name.
virtual DtList outputPortList () const
 Returns the list of DtOutputPorts registered on this component.
virtual void addInputPortGroup (DtInputPortGroup *group)
 Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 Returns a pointer the input port group registered on this component with the specified name.
virtual DtList inputPortGroupList () const
 Returns the list of DtInputPortGroups registered on this component.
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 Returns a pointer the output port group registered on this component with the specified name.
virtual DtList outputPortGroupList () const
 Returns the list of DtOutputPortGroups registered on this component.
virtual int priority () const
 Return the current connection priority for this component.
virtual void setPriority (int priority)
 Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double dT () const
 This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void setDT (double deltaT)
 Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const
DtComponentDescriptor
componentDescriptor () const
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () const
virtual const Coordinate_System * coordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System * coordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual void enable ()
 Is this component enabled or not.
virtual void disable ()
 Is this component enabled or not.
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStreamobjectConsoleDebug () const
virtual DtOutputStreamobjectConsoleVerbose () const
virtual DtOutputStreamobjectConsoleInfo () const
virtual DtOutputStreamobjectConsoleWarn () const
virtual DtOutputStreamobjectConsoleError () const
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
- 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 (FILE *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 (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 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 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 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
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 &)
 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 DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual double calculateMaxSpeed () const
virtual double maxSpeedSoilFactor () const
virtual DtVector calculateProjectedLocation (const DtVector &oldLocalPosition, const DtVector &newBodyVelocity, double newHeading)
virtual void calculateOrientationAndPosition (const DtVector &newLocalProjectedLocation, double newHeading, double newFacingOrientation, DtDcm &newLocalOrientation, DtDcm &newLocalDirectionOfMovement, DtVector &newLocalPosition)
 Given the new location as projected along the current velocity vector, its movement heading, and its facing, find the terrain under the new location and compute the final entity state.
virtual double stepUpFractionLimit () const
 The limit on how far an entity can step up in one tick.
virtual double underWaterFraction () const
 The fraction of a human that is below water when it is floating in water.
virtual void updateRepository (const DtVector &position, const DtVector &velocity, const DtVector &acceleration, const DtTaitBryan &localOrientation, const DtVector &rotationalVelocity, double newHeading)
virtual void computeAndSetPosture ()
 The main method for everything to do with posture in this actuator.
virtual DtLifeformState computeDynamicPosture (DtLifeformStaticPosture staticPosture)
 Determines the correct dynamic posture for the entity based on the desired static posture passed in, and the current state of the entity.
virtual DtLifeformStaticPosture restrictPostureForTerrain (DtLifeformStaticPosture desiredPosture)
virtual bool checkForTerrainCollisions () const
virtual bool checkBlockedByTerrain (const DtVector &oldLocalPosition, DtVector &newLocalProjectedLocation)
 Checks for terrain polygons between specified old and new positions.
virtual double maxUprightTerrainPitch () const
virtual double maxWalkingSpeed () const
virtual void initializeStaticToDynamicPostureMap ()
 Initializes contents of myStaticToDynamicPostureMap, used.
virtual bool computeEntityDirOfMovement (double &heading) const
virtual double calculateTerrainPitch (const DtVector &localPosition, double heading, const DtAttachedTerrain &terrain) const
virtual bool createPorts ()
 Overridden to create the movement control input ports.
virtual bool createPortGroups ()
 Overridden to create the movement control input port group.
virtual bool getSurfacesBelow (const DtVector &testPosition, double underWaterLimit, const DtAttachedTerrain *terrain, DtChordIntersectRecordList &intList)
 Find surfaces below the test point, from top to bottom.
virtual bool closestSurfaceAbove (const DtVector &testPosition, const DtAttachedTerrain *terrain, double &altitude, DtSurface &surface)
 Find the closest surface above the test point.
virtual bool isWater (const DtSurface &surface)
 Determine whether the surface should be interpreted as water.
virtual double altitudeForNoTerrainBelow (double projectedPointAlt, DtVector projectedPoint, double surfacePointAlt) const
 In calculating the new altitude for an entity when it moves, the entity position is first projected along its velocity vector for the last tick (calculateProjectedLocation above), and then the terrain at that location is found (in calculateOrientationAndPosition).
virtual double altitudeForDropToSurface (double projectedPointAlt, DtVector projectedPoint, double surfacePointAlt) const
 This function handles the case where there is a drop from the projected position to the ground surface below of more than some fraction of the body height.
virtual double altitudeForNearbySurface (double projectedPointAlt, DtVector projectedPoint, double surfacePointAlt) const
 This function handles the case where a surface is found near the projected position.
virtual double altitudeForNoSurface (double projectedPointAlt, DtVector projectedPoint) const
 This function is for the case where no surfaces were found at all in the terrain lookup.
virtual void calculateOrientationAndPositionCrawling (const DtVector &newLocalProjectedLocation, double newHeading, double newFacingOrientation, DtDcm &newLocalOrientation, DtDcm &newLocalDirectionOfMovement, DtVector &newLocalPosition)
 The following functions are no longer used in this actuator (4.3)
virtual void groundClamp (double heading, const DtVector &location, DtAttachedTerrain &terrainDatabase, DtVector &newNormal)
 The following functions are no longer used in this actuator (4.3)
virtual void calculateDirectionOfLinearMotion (const DtDcm &newLocalOrientation, double desiredDirectionOfMovement, const DtVector &newLocalPosition, DtDcm &newLocalDirectionOfLinearMotion)
 The following functions are no longer used in this actuator (4.3)
virtual bool closestIntersectionWithBias (const DtVector &localPosition, DtChordIntersectionRecord &record, DtIntersectionRecord::DtIntersectionType irtFlag, double bias, const DtAttachedTerrain *terrain)
 This function looks for an intersection with the terrain.
virtual void groundClampLowFidelity (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal, bool &dataAvailable)
 The following functions are no longer used in this actuator (4.3)
- Protected Member Functions inherited from DtActuatorComponent
 DtActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
 DtActuatorComponent (const DtActuatorComponent &orig)
 copy constructor
const DtActuatorComponentoperator= (const DtActuatorComponent &orig)
 assignment operator
virtual void setRadio (DtSimRadio *radio)
 DtActuatorComponent ()
 Default constructor; should not be called.
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT, common between preprocess and timedTick.
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 Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Protected Attributes

double myMutablePitch
 This value is the pitch of the terrain under the entity.
bool myMutablePitchValid
DtVector myLastParentPosition
DtStaticToDynamicPostureMap myStaticToDynamicPostureMap
const
DtHumanMovementActuatorDescriptor
myHumanMovementActuatorDescriptor
bool myPreviouslyEmbarked
bool myWasOnGround
 These states are used for controlling debug print statements.
DtUpdateRepositoryOutputPortGroupmyUpdateRepositoryOutputPortGroup
 Port group used to set what values should be set into the VRF state repository.
Ports and Port Groups
DtAnalogInputPortmyMovementDirectionInputPort
 Input Port Name: desired-movement-direction
Input Port Description: Desired movement direction of the entity in radians.
DtAnalogInputPortmyFacingDirectionInputPort
 Input Port Name: desired-facing-direction
Input Port Description: Desired facing direction of the entity in radians.
DtAnalogInputPortmySpeedInputPort
 Input Port Name: desired-speed
Input Port Description: Desired speed of the entity in m/s.
DtInputPortGroupmyMovementControlInputPortGroup
 Input Port Group Name: movement-control
Input Port Group Description: Collection of inputs specifying the desired movement of the entity.
DtIntegerInputPortmyDesiredStaticPostureInputPort
 Input Port Name: desired-static-posture
Input Port Description: The desired posture of the entity.
DtVrfMovingObjectStateRepositorymyMovingObjectStateRepository
 Convenience pointers to our state repository.
DtHumanStateRepositorymyHumanStateRepository
 Convenience pointers to our state repository.
- Protected Attributes inherited from DtActuatorComponent
DtSimRadiomyRadio
 Actuators can send messages.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 Pointer to the DtComponentSystem that this component belongs.
DtListItem * myListItem
DtInputPortMap myInputPortList
DtOutputPortMap myOutputPortList
DtInputPortGroupMap myInputPortGroupList
DtOutputPortGroupMap myOutputPortGroupList
int myPriority
double myMinTickPeriod
double myMinTickPeriodVariance
double myNextTickTime
double myLastTickSimTime
double myDT
bool myIsEnabled
 Indicates whether this component should be enabled for ticking or not.
bool myFirstTick
 Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptormyComponentDescriptor
- 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.

Private Member Functions

DtHumanMovementActuatoroperator= (const DtHumanMovementActuator &orig)
 Not implemented.
 DtHumanMovementActuator (const DtHumanMovementActuator &orig)
 Not implemented.

Additional Inherited Members

- Protected Types inherited from DtSimComponent
typedef std::map< DtString,
DtInputPort * > 
DtInputPortMap
typedef std::map< DtString,
DtOutputPort * > 
DtOutputPortMap
typedef std::map< DtString,
DtInputPortGroup * > 
DtInputPortGroupMap
typedef std::map< DtString,
DtOutputPortGroup * > 
DtOutputPortGroupMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

DtHumanMovementActuator is a simple movement actuator for lifeforms.

Developer Description: It moves in the requested speed (clamped by the max speed of the entity) and direction. The entity will speed up, slow down, and turn instantly when the requested values change.

Uses Descriptor Type: DtHumanMovementActuatorDescriptor

Member Typedef Documentation

Constructor & Destructor Documentation

DtHumanMovementActuator::DtHumanMovementActuator ( const DtHumanMovementActuator orig)
private

Not implemented.

DtHumanMovementActuator::DtHumanMovementActuator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtHumanMovementActuator::~DtHumanMovementActuator ( )
virtual

destructor

Member Function Documentation

DtHumanMovementActuator& DtHumanMovementActuator::operator= ( const DtHumanMovementActuator orig)
private

Not implemented.

virtual bool DtHumanMovementActuator::init ( )
virtual

to get access to the entity's localStateRepository, which this component will update, and then connect to the controller's ports.

Reimplemented from DtActuatorComponent.

virtual DtString DtHumanMovementActuator::type ( ) const
virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns
DtHumanMovementActuatorType

Reimplemented from DtSimComponent.

virtual void DtHumanMovementActuator::tick ( )
virtual

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

static DtSimComponent* DtHumanMovementActuator::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.
virtual double DtHumanMovementActuator::calculateMaxSpeed ( ) const
protectedvirtual
Returns
The current max speed based on pitch, soil type, and capabilities of the entity.
virtual double DtHumanMovementActuator::maxSpeedSoilFactor ( ) const
protectedvirtual
virtual DtVector DtHumanMovementActuator::calculateProjectedLocation ( const DtVector oldLocalPosition,
const DtVector newBodyVelocity,
double  newHeading 
)
protectedvirtual
virtual void DtHumanMovementActuator::calculateOrientationAndPosition ( const DtVector newLocalProjectedLocation,
double  newHeading,
double  newFacingOrientation,
DtDcm &  newLocalOrientation,
DtDcm &  newLocalDirectionOfMovement,
DtVector newLocalPosition 
)
protectedvirtual

Given the new location as projected along the current velocity vector, its movement heading, and its facing, find the terrain under the new location and compute the final entity state.

Parameters
newLocalProjectedLocationThe tentative new position as projected from the current velocity.
newHeadingThe current heading angle of movement.
newFacingOrientationThe current heading angle of facing. This can be different from the newHeading if the entity isn't moving in the direction it is facing.
newLocalOrientation(Output) The new direction of facing, including a pitch to match the terrain pitch if the entity is prone or crawling.
newLocalDirectionOfMovement(Output) The new direction of movement, including the pitch of the terrain.
newLocalPosition(Output) The new position on the terrain.
virtual double DtHumanMovementActuator::stepUpFractionLimit ( ) const
protectedvirtual

The limit on how far an entity can step up in one tick.

Expressed as a fraction of the body height. Default value is 0.4.

virtual double DtHumanMovementActuator::underWaterFraction ( ) const
protectedvirtual

The fraction of a human that is below water when it is floating in water.

Default is 0.88.

virtual double DtHumanMovementActuator::altitudeForNoTerrainBelow ( double  projectedPointAlt,
DtVector  projectedPoint,
double  surfacePointAlt 
) const
protectedvirtual

In calculating the new altitude for an entity when it moves, the entity position is first projected along its velocity vector for the last tick (calculateProjectedLocation above), and then the terrain at that location is found (in calculateOrientationAndPosition).

That function checks the terrain under a position stepUpFractionLimit * body height above the projected location. Normally the terrain lookup finds a ground surface and the entity is placed there. However, there may be no terrain under the entity, or the terrain may be more than a step-up down, it may be more than a step-up up, or there may be no terrain at all. These functions handle those situations and determine what altitude the entity should be placed at.

Parameters
projectedPointAltThe altitude of the point projected from the velocity.
projectedPointThe projected point (local coordinates). Useful for debugging.
surfacePointAltThe altitude of the surface found in a terrain lookup at the test position (may be above the projected point).
Returns
Altitude The adjusted altitude of the entity.This function handles the case when there is no terrain under the test point; however, there is a ground surface above the entity somewhere. The default behavior is to keep the same altitude as the projected point. In other words, the entity won't jump up to the surface above. An alternative would be to make the entity rise slowly to the surface.
virtual double DtHumanMovementActuator::altitudeForDropToSurface ( double  projectedPointAlt,
DtVector  projectedPoint,
double  surfacePointAlt 
) const
protectedvirtual

This function handles the case where there is a drop from the projected position to the ground surface below of more than some fraction of the body height.

The default is to output the surface altitude. This causes the entity to jump immediately down if it moves off the edge of a step or rooftop. However, this function can be overridden to make the entity accelerate down with gravity; or, to stay at the same altitude.

virtual double DtHumanMovementActuator::altitudeForNearbySurface ( double  projectedPointAlt,
DtVector  projectedPoint,
double  surfacePointAlt 
) const
protectedvirtual

This function handles the case where a surface is found near the projected position.

The default behavior is to set the output altitude to the surface altitude.

virtual double DtHumanMovementActuator::altitudeForNoSurface ( double  projectedPointAlt,
DtVector  projectedPoint 
) const
protectedvirtual

This function is for the case where no surfaces were found at all in the terrain lookup.

The default behavior is to output the projected point altitude so the entity does not move up or down. Alternatively, the altitude could be clamped to 0.

Parameters
projectedPointAltThe altitude of the point projected from the velocity.
projectedPointThe projected point (local coordinates). Useful for debugging.
surfacePointAltThe altitude of the surface found in a terrain lookup at the test position (above the projected point, in this case).
Returns
Altitude The adjusted altitude of the entity.
virtual void DtHumanMovementActuator::updateRepository ( const DtVector position,
const DtVector velocity,
const DtVector acceleration,
const DtTaitBryan &  localOrientation,
const DtVector rotationalVelocity,
double  newHeading 
)
protectedvirtual
virtual void DtHumanMovementActuator::computeAndSetPosture ( )
protectedvirtual

The main method for everything to do with posture in this actuator.

This determines the correct posture based on the input port and speed of the entity, and then sets this posture to the state repository.

virtual DtLifeformState DtHumanMovementActuator::computeDynamicPosture ( DtLifeformStaticPosture  staticPosture)
protectedvirtual

Determines the correct dynamic posture for the entity based on the desired static posture passed in, and the current state of the entity.

virtual DtLifeformStaticPosture DtHumanMovementActuator::restrictPostureForTerrain ( DtLifeformStaticPosture  desiredPosture)
protectedvirtual
Returns
The static posture closest to the desired posture that is allowed on the current terrain. For example, standing upright on a steep hill is not allowed, so the return would be prone.
virtual bool DtHumanMovementActuator::checkForTerrainCollisions ( ) const
protectedvirtual
Returns
Boolean signifying whether or not the terrain should be checked for collisions with the entity's bounding volume while it moves. If this returns true, the entity will not move through the terrain. If this is false, it may move through terrain polygons, such as building walls when moving to a new location.
Note
it currently just returns the value of the user specified parameter in the automotivePSR.
virtual bool DtHumanMovementActuator::checkBlockedByTerrain ( const DtVector oldLocalPosition,
DtVector newLocalProjectedLocation 
)
protectedvirtual

Checks for terrain polygons between specified old and new positions.

Returns
True if there are any blocking polygons, and in that case also sets newLocalProjectedLocation to the position just before the polygons are hit.
virtual double DtHumanMovementActuator::maxUprightTerrainPitch ( ) const
protectedvirtual
Returns
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. Units in radians. Returns value from myHumanMovementActuatorDescriptor if it exists, otherwise, returns 0.5236 (30 degrees) by default.
virtual double DtHumanMovementActuator::maxWalkingSpeed ( ) const
protectedvirtual
Returns
Maximum speed at which entity will walk. Actuator will switch from a walking posture to a running posture when current speed exceeds this value. Returns value from myHumanmovementActuatorDescriptor if it exists, otherwise returns 2.0 by default. Units in meters/second.
virtual void DtHumanMovementActuator::initializeStaticToDynamicPostureMap ( )
protectedvirtual

Initializes contents of myStaticToDynamicPostureMap, used.

virtual bool DtHumanMovementActuator::computeEntityDirOfMovement ( double &  heading) const
protectedvirtual
Returns
virtual double DtHumanMovementActuator::calculateTerrainPitch ( const DtVector localPosition,
double  heading,
const DtAttachedTerrain terrain 
) const
protectedvirtual
Returns
The pitch of the terrain at the specified position in the specified direction.
virtual bool DtHumanMovementActuator::createPorts ( )
protectedvirtual

Overridden to create the movement control input ports.

Reimplemented from DtSimComponent.

virtual bool DtHumanMovementActuator::createPortGroups ( )
protectedvirtual

Overridden to create the movement control input port group.

Reimplemented from DtSimComponent.

virtual bool DtHumanMovementActuator::getSurfacesBelow ( const DtVector testPosition,
double  underWaterLimit,
const DtAttachedTerrain terrain,
DtChordIntersectRecordList &  intList 
)
protectedvirtual

Find surfaces below the test point, from top to bottom.

The actuator needs to find either a ground surface below, or a water surface and the ground under that, or else a water surface and a check that the water is deep enough that the entity would float on the water anyway. This function tries to be efficient by looking for surfaces only a short distance (10m) below the test position before it looks down to -inf; if it finds one of the above conditions are true in the abbreviated look, then it returns immediately. Thus it may not find ALL the surfaces below.
Returns true if a surface was found; false otherwise.

virtual bool DtHumanMovementActuator::closestSurfaceAbove ( const DtVector testPosition,
const DtAttachedTerrain terrain,
double &  altitude,
DtSurface &  surface 
)
protectedvirtual

Find the closest surface above the test point.

Returns true if a surface was found; false otherwise. If found, returns the altitude of the surface and the surface (type).

virtual bool DtHumanMovementActuator::isWater ( const DtSurface &  surface)
protectedvirtual

Determine whether the surface should be interpreted as water.

For human ground entities, treat as water only if it does not have an Undefined soil type, and if the water-surface medium bit is set.

virtual void DtHumanMovementActuator::calculateOrientationAndPositionCrawling ( const DtVector newLocalProjectedLocation,
double  newHeading,
double  newFacingOrientation,
DtDcm &  newLocalOrientation,
DtDcm &  newLocalDirectionOfMovement,
DtVector newLocalPosition 
)
protectedvirtual

The following functions are no longer used in this actuator (4.3)

virtual void DtHumanMovementActuator::groundClamp ( double  heading,
const DtVector location,
DtAttachedTerrain terrainDatabase,
DtVector newNormal 
)
protectedvirtual

The following functions are no longer used in this actuator (4.3)

virtual void DtHumanMovementActuator::calculateDirectionOfLinearMotion ( const DtDcm &  newLocalOrientation,
double  desiredDirectionOfMovement,
const DtVector newLocalPosition,
DtDcm &  newLocalDirectionOfLinearMotion 
)
protectedvirtual

The following functions are no longer used in this actuator (4.3)

virtual bool DtHumanMovementActuator::closestIntersectionWithBias ( const DtVector localPosition,
DtChordIntersectionRecord &  record,
DtIntersectionRecord::DtIntersectionType  irtFlag,
double  bias,
const DtAttachedTerrain terrain 
)
protectedvirtual

This function looks for an intersection with the terrain.

It first checks the chord from the localPosition to a point that is below the localPosition by "bias" meters. (Bias can be negative.) If there is no terrain surface there, it makes a closestIntersection call from the localPosition and returns the results of that.

virtual void DtHumanMovementActuator::groundClampLowFidelity ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal,
bool dataAvailable 
)
protectedvirtual

The following functions are no longer used in this actuator (4.3)

Member Data Documentation

DtAnalogInputPort* DtHumanMovementActuator::myMovementDirectionInputPort
protected

Input Port Name: desired-movement-direction
Input Port Description: Desired movement direction of the entity in radians.


Input Port Range: 0 - 2*pi
Input Port Default Value: N/A
Input Group Parent: movement-control

DtAnalogInputPort* DtHumanMovementActuator::myFacingDirectionInputPort
protected

Input Port Name: desired-facing-direction
Input Port Description: Desired facing direction of the entity in radians.

NOTE: This input port is currently ignored. It is here for future expansion. The entity currently always faces in its movement direction. Input Port Range: 0 - 2*pi
Input Port Default Value: N/A
Input Group Parent: movement-control

DtAnalogInputPort* DtHumanMovementActuator::mySpeedInputPort
protected

Input Port Name: desired-speed
Input Port Description: Desired speed of the entity in m/s.


Input Port Range: 0 and up. Input Port Default Value: N/A
Input Group Parent: movement-control

DtInputPortGroup* DtHumanMovementActuator::myMovementControlInputPortGroup
protected

Input Port Group Name: movement-control
Input Port Group Description: Collection of inputs specifying the desired movement of the entity.


DtIntegerInputPort* DtHumanMovementActuator::myDesiredStaticPostureInputPort
protected

Input Port Name: desired-static-posture
Input Port Description: The desired posture of the entity.

This is a static (non-moving) posture, and will be mapped to an appropriate moving posture based on the actual speed of the entity.
Input Port Range: See DtLifeformStaticPosture. Input Port Default Value: DtStaticPostureUpright

DtVrfMovingObjectStateRepository* DtHumanMovementActuator::myMovingObjectStateRepository
protected

Convenience pointers to our state repository.

DtHumanStateRepository* DtHumanMovementActuator::myHumanStateRepository
protected

Convenience pointers to our state repository.

double DtHumanMovementActuator::myMutablePitch
mutableprotected

This value is the pitch of the terrain under the entity.

Since it is expensive to calculate, but needed at a number of places each tick, it is stored here when calculated, and then user other times.

bool DtHumanMovementActuator::myMutablePitchValid
mutableprotected
DtVector DtHumanMovementActuator::myLastParentPosition
protected
DtStaticToDynamicPostureMap DtHumanMovementActuator::myStaticToDynamicPostureMap
protected
const DtHumanMovementActuatorDescriptor* DtHumanMovementActuator::myHumanMovementActuatorDescriptor
protected
bool DtHumanMovementActuator::myPreviouslyEmbarked
protected
bool DtHumanMovementActuator::myWasOnGround
protected

These states are used for controlling debug print statements.

DtUpdateRepositoryOutputPortGroup* DtHumanMovementActuator::myUpdateRepositoryOutputPortGroup
protected

Port group used to set what values should be set into the VRF state repository.

All values are in local coordinates


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)