DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component. More...

Inheritance diagram for DtHumanMovementActuatorDescriptor:

Public Member Functions
	DtHumanMovementActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor More...

	DtHumanMovementActuatorDescriptor (const DtHumanMovementActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...

virtual	~DtHumanMovementActuatorDescriptor ()

DtHumanMovementActuatorDescriptor &	operator= (const DtHumanMovementActuatorDescriptor &orig)
	assignment More...

virtual DtString	type () const
	Returns the type of component this descriptor describes. More...

virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const


virtual bool	checkForTerrainCollisions () const
	Accessor/mutator for myCheckForTerrainCollisions. More...

virtual void	setCheckForTerrainCollisions (bool yesOrNo)


virtual bool	checkForEntityCollisions () const
	Accessor/mutator for myCheckForEntityCollisions. More...

virtual void	setCheckForEntityCollisions (bool yesNo)


virtual double	maxUprightTerrainPitch () const
	Accessor/mutator for myMaxUprightTerrainPitch. More...

virtual void	setMaxUprightTerrainPitch (double pitch)


virtual double	maxWalkingSpeed () const
	Accessor/mutator for #myMaxWalkingSpeeed. More...

virtual void	setMaxWalkingSpeed (double speed)


virtual const DtRwStaticDynamicPostureList &	staticToDynamicPostureMap () const
	Accessor for myStaticToDynamicPostureMap. More...


virtual const DtRwSoilSpeedFactorList &	soilToMaxSpeedFactorMap () const
	Accessor for mySoilToMaxSpeedFactorMap. More...


virtual bool	constrainFacingTurnRate () const

virtual void	setConstrainFacingTurnRate (bool v)


virtual double	maxFacingTurnRate () const

virtual void	setMaxFacingTurnRate (double v)


virtual double	stepUpFractionLimit () const

virtual void	setStepUpFractionLimit (double v)


virtual double	stepCheckDistance () const

virtual void	setStepCheckDistance (double v)


virtual double	verticalCrackTolerance () const

virtual void	setVerticalCrackTolerance (double v)


virtual double	horizontalCrackTolerance () const

virtual void	setHorizontalCrackTolerance (double v)


virtual bool	outputAglRequired () const
	Accessor/mutator for myOutputAglRequired. More...

virtual void	setOutputAglRequired (bool outputAgl)

Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor More...

	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment More...

virtual	~DtActuatorComponentDescriptor ()
	destructor More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for #myArtPartDescriptorList. More...

virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const

virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()

virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)
	Accessor/mutator for myArtPartTypes. More...

virtual const ArtPartTypeSet &	artPartTypes () const

virtual DtArtPartType	firstArtPartType () const

Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment More...

virtual	~DtComponentDescriptor ()

virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type. More...

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. More...

virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. More...

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. More...

virtual const DtString &	componentType () const

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. More...

virtual bool	tickPeriodUsesRealTime () const

virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR. More...

virtual void	setProcessStateRepositoryName (const DtString &name)

virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create. More...

virtual void	setProcessStateRepositoryType (const DtString &type)

virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not. More...

virtual bool	isEnabled () const

virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component. More...

virtual bool	debugActive () const

virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)

virtual DtReal	minTaskVisualizationTickPeriod () const

virtual void	setTaskVisualizationsEnabled (bool enabled)

virtual bool	taskVisualizationsEnabled () const

virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not. More...

virtual bool	createComponent () const

virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object. More...

virtual bool	createOnRemoteObject () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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. More...

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. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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. More...

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. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtActuatorComponentDescriptor
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory. More...

static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. More...

static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class. More...

static DtComponentDescriptor *	creator ()

static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor. More...

static void	setFactory (DtComponentDescriptorFactory *factory)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
	DtHumanMovementActuatorDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

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. More...

DtRwBoolean	myCheckForEntityCollisions
	Parameter Name: check-entity-collisions Parameter Description: Specifies whether or not the actuator will check for entity collisions when moving the entity. More...

DtRwReal	myMaxUprightTerrainPitch
	Parameter Name: max-upright-terrain-pitch Parameter Description: Maximum terrain pitch at which entity can maintain a static upright posture (i.e. More...

DtRwReal	myMaxWalkingSpeed
	Parameter Name: max-walking-speed Parameter Description: Maximum speed at which entity will walk. More...

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. More...

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. More...

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. More...

DtRwReal	myMaxFacingTurnRate
	Parameter Name: max-facing-turn-rate Parameter Description: The maximum rate the entity's facing direction will change. More...

DtRwReal	myStepUpFractionLimit
	Parameter Name: step-up-fraction-limit Parameter Description: The maximum size of a step the entity can walk up expressed as a fraction of the entity's body height. More...

DtRwReal	myStepCheckDistance
	Parameter Name: step-check-distance Parameter Description: When running faster than real time, it is possible for the entity to find itself moved under the terrain when it should have been able to perform a series of steps to stay on top of it. More...

DtRwReal	myVerticalCrackTolerance
	Parameter Name: vertical-crack-tolerance Parameter Description: Controls how far down an entity has to step from previous tick in order to activate the step over crack detection. More...

DtRwReal	myHorizontalCrackTolerance
	Parameter Name: horizontal-crack-tolerance Parameter Description: Controls how wide of a crack in the terrain the entity will step over. More...

DtRwBoolean	myOutputAglRequired
	Parameter Name: output-agl-required Parameter Description: Boolean indicating the actuator should output the entity's altitude above ground level. More...

Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
	List of configured articulated parts types associated with this actuator. More...

DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
	Parameter Name: default-art-part-list Parameter Description: This parameter describes the default articulated part settings used by this actuator. More...

Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component. More...

DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component. More...

DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. More...

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. More...

DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. More...

DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. More...

DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. More...

DtRwBoolean	myDebug
	This parameter defaults to false. More...

DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. More...

DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled. More...

DtRwBoolean	myCreateComponent

DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. More...

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. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Additional Inherited Members
Public Types inherited from DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet

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

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Detailed Description

DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component.

Instances of DtHumanMovementActuatorDescriptor are used to specify the parameters for a DtHumanMovementActuator component.

Constructor & Destructor Documentation

DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

real constructor

DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor	(	const DtHumanMovementActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtHumanMovementActuatorDescriptor::~DtHumanMovementActuatorDescriptor ( )

virtual

DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtHumanMovementActuatorDescriptor& DtHumanMovementActuatorDescriptor::operator= ( const DtHumanMovementActuatorDescriptor & orig )

assignment

virtual DtString DtHumanMovementActuatorDescriptor::type ( ) const

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.

Returns: DtHumanMovementActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtHumanMovementActuatorDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

virtual

Reimplemented from DtActuatorComponentDescriptor.

static DtComponentDescriptor* DtHumanMovementActuatorDescriptor::creator ( )

static

Returns: Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

virtual bool DtHumanMovementActuatorDescriptor::checkForTerrainCollisions ( ) const

virtual

Accessor/mutator for myCheckForTerrainCollisions.

virtual void DtHumanMovementActuatorDescriptor::setCheckForTerrainCollisions ( bool yesOrNo )

virtual

virtual bool DtHumanMovementActuatorDescriptor::checkForEntityCollisions ( ) const

virtual

Accessor/mutator for myCheckForEntityCollisions.

virtual void DtHumanMovementActuatorDescriptor::setCheckForEntityCollisions ( bool yesNo )

virtual

virtual double DtHumanMovementActuatorDescriptor::maxUprightTerrainPitch ( ) const

virtual

Accessor/mutator for myMaxUprightTerrainPitch.

virtual void DtHumanMovementActuatorDescriptor::setMaxUprightTerrainPitch ( double pitch )

virtual

virtual double DtHumanMovementActuatorDescriptor::maxWalkingSpeed ( ) const

virtual

Accessor/mutator for #myMaxWalkingSpeeed.

virtual void DtHumanMovementActuatorDescriptor::setMaxWalkingSpeed ( double speed )

virtual

virtual const DtRwStaticDynamicPostureList& DtHumanMovementActuatorDescriptor::staticToDynamicPostureMap ( ) const

virtual

Accessor for myStaticToDynamicPostureMap.

virtual const DtRwSoilSpeedFactorList& DtHumanMovementActuatorDescriptor::soilToMaxSpeedFactorMap ( ) const

virtual

Accessor for mySoilToMaxSpeedFactorMap.

virtual bool DtHumanMovementActuatorDescriptor::constrainFacingTurnRate ( ) const

virtual

See Also: myConstrainFacingTurnRate

virtual void DtHumanMovementActuatorDescriptor::setConstrainFacingTurnRate ( bool v )

virtual

virtual double DtHumanMovementActuatorDescriptor::maxFacingTurnRate ( ) const

virtual

See Also: myMaxFacingTurnRate

virtual void DtHumanMovementActuatorDescriptor::setMaxFacingTurnRate ( double v )

virtual

virtual double DtHumanMovementActuatorDescriptor::stepUpFractionLimit ( ) const

virtual

See Also: myStepUpFractionLimit

virtual void DtHumanMovementActuatorDescriptor::setStepUpFractionLimit ( double v )

virtual

virtual double DtHumanMovementActuatorDescriptor::stepCheckDistance ( ) const

virtual

See Also: myStepCheckDistance

virtual void DtHumanMovementActuatorDescriptor::setStepCheckDistance ( double v )

virtual

virtual double DtHumanMovementActuatorDescriptor::verticalCrackTolerance ( ) const

virtual

See Also: myVerticalCrackTolerance

virtual void DtHumanMovementActuatorDescriptor::setVerticalCrackTolerance ( double v )

virtual

virtual double DtHumanMovementActuatorDescriptor::horizontalCrackTolerance ( ) const

virtual

See Also: myHorizontalCrackTolerance

virtual void DtHumanMovementActuatorDescriptor::setHorizontalCrackTolerance ( double v )

virtual

virtual bool DtHumanMovementActuatorDescriptor::outputAglRequired ( ) const

virtual

Accessor/mutator for myOutputAglRequired.

virtual void DtHumanMovementActuatorDescriptor::setOutputAglRequired ( bool outputAgl )

virtual

Member Data Documentation

DtRwBoolean DtHumanMovementActuatorDescriptor::myCheckForTerrainCollisions

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

DtRwBoolean DtHumanMovementActuatorDescriptor::myCheckForEntityCollisions

protected

Parameter Name: check-entity-collisions
Parameter Description: Specifies whether or not the actuator will check for entity collisions when moving the entity.

If true, then the actuator will not move the entity through another entity.
Parameter Default Value: False

DtRwReal DtHumanMovementActuatorDescriptor::myMaxUprightTerrainPitch

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

DtRwReal DtHumanMovementActuatorDescriptor::myMaxWalkingSpeed

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

DtRwStaticDynamicPostureList DtHumanMovementActuatorDescriptor::myStaticToDynamicPostureMap

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 receives 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:

DtRwSoilSpeedFactorList DtHumanMovementActuatorDescriptor::mySoilToMaxSpeedFactorMap

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:

DtRwBoolean DtHumanMovementActuatorDescriptor::myConstrainFacingTurnRate

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

DtRwReal DtHumanMovementActuatorDescriptor::myMaxFacingTurnRate

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)

DtRwReal DtHumanMovementActuatorDescriptor::myStepUpFractionLimit

protected

Parameter Name: step-up-fraction-limit
Parameter Description: The maximum size of a step the entity can walk up expressed as a fraction of the entity's body height.

Parameter Units: fraction of body height Parameter Default Value: 0.4

DtRwReal DtHumanMovementActuatorDescriptor::myStepCheckDistance

protected

Parameter Name: step-check-distance
Parameter Description: When running faster than real time, it is possible for the entity to find itself moved under the terrain when it should have been able to perform a series of steps to stay on top of it.

This setting specifies the maximum distance an entity is allowed to move without doing a step check an re-clamping to the surface. Decreasing this value will ensure that entities are able to move up slopes correctly when running faster than real time, but it will cause more terrain intersection checks, which may affect performance. Parameter Units: meters Parameter Default Value: 1.0

DtRwReal DtHumanMovementActuatorDescriptor::myVerticalCrackTolerance

protected

Parameter Name: vertical-crack-tolerance
Parameter Description: Controls how far down an entity has to step from previous tick in order to activate the step over crack detection.

Parameter Units: meters Parameter Default Value: 0.2

DtRwReal DtHumanMovementActuatorDescriptor::myHorizontalCrackTolerance

protected

Parameter Name: horizontal-crack-tolerance
Parameter Description: Controls how wide of a crack in the terrain the entity will step over.

Setting this to 0 will disable crack detection. Parameter Units: meters Parameter Default Value: 0.02

DtRwBoolean DtHumanMovementActuatorDescriptor::myOutputAglRequired

protected

Parameter Name: output-agl-required
Parameter Description: Boolean indicating the actuator should output the entity's altitude above ground level.

If not necessary, disabling this eliminates a terrain intersection. Parameter Units: boolean Parameter Default Value: false

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjparam/humanMovementActuatorDescriptor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation