DtHumanFleeControllerDescriptor Class Reference

DtHumanFleeControllerDescriptor; descriptor for the DtHumanFleeController component.

Instances of DtHumanFleeControllerDescriptor are used to specify the parameters for a DtHumanFleeController component.

Inheritance diagram for DtHumanFleeControllerDescriptor:

Public Member Functions
	DtHumanFleeControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtHumanFleeControllerDescriptor (const DtHumanFleeControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtHumanFleeControllerDescriptor ()
DtHumanFleeControllerDescriptor &	operator= (const DtHumanFleeControllerDescriptor &orig)
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual double	angleBetweenPoints () const
virtual void	setAngleBetweenPoints (double angle)
virtual double	fleeFromThreshold () const
virtual void	setFleeFromThreshold (double threshold)
virtual bool	showFleePoint () const
virtual void	setShowFleePoint (bool)
virtual double	atDistance () const
virtual void	setAtDistance (double distance)
virtual bool	allowToFleePastFleePoint () const
virtual void	setAllowToFleePastFleePoint (bool)
virtual double	fleeCone () const
virtual void	setFleeCone (double)
virtual double	reevaluatePeriod () const
virtual void	setReevaluatePeriod (double v)
virtual double	reevaluatePeriodVariance () const
virtual void	setReevaluatePeriodVariance (double v)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
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)
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	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
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)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
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 ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
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)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
	DtHumanFleeControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myAngleBetweenPoints
DtRwReal	myFleeFromThreshold
DtRwReal	myAtDistance
DtRwBoolean	myShowFleePoint
DtRwBoolean	myAllowToFleePastFleePoint
DtRwReal	myFleeCone
DtRwReal	myReevaluatePeriod
DtRwReal	myReevaluatePeriodVariance
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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
bool	myInvalid
bool	myChangedFlag

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

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtHumanFleeControllerDescriptor::~DtHumanFleeControllerDescriptor ( )

virtual

DtHumanFleeControllerDescriptor::DtHumanFleeControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtHumanFleeControllerDescriptor& DtHumanFleeControllerDescriptor::operator=

(

const DtHumanFleeControllerDescriptor &

orig

)

assignment

virtual DtString DtHumanFleeControllerDescriptor::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

DtHumanFleeControllerDescriptorType

Reimplemented from DtComponentDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtHumanFleeControllerDescriptor::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 double DtHumanFleeControllerDescriptor::angleBetweenPoints ( ) const

virtual

Accessor/mutator for #myAngleBetweenPpoint.

virtual void DtHumanFleeControllerDescriptor::setAngleBetweenPoints ( double  angle )

virtual

Accessor/mutator for #myAngleBetweenPpoint.

virtual double DtHumanFleeControllerDescriptor::fleeFromThreshold ( ) const

virtual

Accessor/mutator for myFleeFromThreshold.

virtual void DtHumanFleeControllerDescriptor::setFleeFromThreshold ( double  threshold )

virtual

Accessor/mutator for myFleeFromThreshold.

virtual bool DtHumanFleeControllerDescriptor::showFleePoint ( ) const

virtual

Accessor/mutator for myShowFleePoint.

virtual void DtHumanFleeControllerDescriptor::setShowFleePoint ( bool  )

virtual

Accessor/mutator for myShowFleePoint.

virtual double DtHumanFleeControllerDescriptor::atDistance ( ) const

virtual

Accessor/mutator for myAtDistance.

virtual void DtHumanFleeControllerDescriptor::setAtDistance ( double  distance )

virtual

Accessor/mutator for myShowFleePoint.

virtual bool DtHumanFleeControllerDescriptor::allowToFleePastFleePoint ( ) const

virtual

Accessor/mutator for myAllowToFleePastFleePoint.

virtual void DtHumanFleeControllerDescriptor::setAllowToFleePastFleePoint ( bool  )

virtual

Accessor/mutator for myAllowToFleePastFleePoint.

virtual double DtHumanFleeControllerDescriptor::fleeCone ( ) const

virtual

Accessor/mutator for myFleeCone.

virtual void DtHumanFleeControllerDescriptor::setFleeCone ( double  )

virtual

Accessor/mutator for myFleeCone.

virtual double DtHumanFleeControllerDescriptor::reevaluatePeriod ( ) const

virtual

Accessor/mutator for myReevaluatePeriod.

virtual void DtHumanFleeControllerDescriptor::setReevaluatePeriod ( double  v )

virtual

Accessor/mutator for myReevaluatePeriod.

virtual double DtHumanFleeControllerDescriptor::reevaluatePeriodVariance ( ) const

virtual

Accessor/mutator for myReevaluatePeriodVariance.

virtual void DtHumanFleeControllerDescriptor::setReevaluatePeriodVariance ( double  v )

virtual

Accessor/mutator for myReevaluatePeriodVariance.

Member Data Documentation

DtRwReal DtHumanFleeControllerDescriptor::myAngleBetweenPoints

protected

Parameter Name: angle-between-points
Parameter Description: Specifies the distance between the angles at which we will search outwards for possible flee points. Parameter Units: radians Parameter Default Value: pi/4.

DtRwReal DtHumanFleeControllerDescriptor::myFleeFromThreshold

protected

Parameter Name: flee-from-threshold
Parameter Description: When the object from which we are fleeing moves by more than this distance, a new flee point will be chosen. Parameter Units: meters Parameter Default Value: 5.

DtRwReal DtHumanFleeControllerDescriptor::myAtDistance

protected

Parameter Name: at-distance
Parameter Description: Maximum distance from goal entity is considered to be 'at' desired location. Parameter Units: meters Parameter Default Value: 0.5.

DtRwBoolean DtHumanFleeControllerDescriptor::myShowFleePoint

protected

Parameter Name: show-flee-point
Parameter Description: Whether or not to show calculated flee point Parameter Units: Parameter Default Value: False.

DtRwBoolean DtHumanFleeControllerDescriptor::myAllowToFleePastFleePoint

protected

Parameter Name: allow-to-flee-past-flee-point
Parameter Description: Whether or not the object can try and flee past the flee point Parameter Units: Parameter Default Value: False.

DtRwReal DtHumanFleeControllerDescriptor::myFleeCone

protected

Parameter Name: flee-cone
Parameter Description: The wedge, in degrees, the flee heading can be off of the heading to the flee point at the maximum when deciding if an entity can flee in that direction Parameter Units: Parameter Default Value: 90.

DtRwReal DtHumanFleeControllerDescriptor::myReevaluatePeriod

protected

Parameter Name: reevaluate-period
Parameter Description: The time period for reevaluating a flee point while fleeing if it hasn't yet reached a flee point. Parameter Units: Seconds Parameter Default Value: 4.0.

DtRwReal DtHumanFleeControllerDescriptor::myReevaluatePeriodVariance

protected

Parameter Name: reevaluate-period-variance
Parameter Description: In order to prevent a crowd of entities from reevaluating a flee at at the same time, a variance is added to the myReevaluatePeriod. Parameter Units: Seconds Parameter Default Value: 2.0.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/humanFleeControllerDescriptor.h