Instances of DtHumanUseDoorControllerDescriptor are used to specify the parameters for a DtHumanUseDoorController object.

Inheritance diagram for DtHumanUseDoorControllerDescriptor:

[legend]

Public Member Functions
	DtHumanUseDoorControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

virtual	~DtHumanUseDoorControllerDescriptor ()

	DtHumanUseDoorControllerDescriptor (const DtHumanUseDoorControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)

DtHumanUseDoorControllerDescriptor &	operator= (const DtHumanUseDoorControllerDescriptor &orig)

virtual DtString	type () const

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


virtual const DtRwStringList &	doorDynamicTerrainTypes () const

virtual DtRwStringList &	doorDynamicTerrainTypes ()

virtual void	setDoorDynamicTerrainTypes (const DtRwStringList &types)


virtual DtRwReal	timeToOpen () const

virtual void	setTimeToOpen (DtRwReal t)


virtual DtRwReal	headingToUseDoor () const

virtual void	setHeadingToUseDoor (DtRwReal t)


virtual DtRwReal	proximityToHoldDoor () const

virtual void	setProximityToHoldDoor (DtRwReal t)

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)

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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwStringList	myDoorDynamicTerrainTypes

DtRwReal	myTimeToOpen

DtRwReal	myHeadingToUseDoor

DtRwReal	myProximityToHoldDoor

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

Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()

void	addPrefixToStateAndParameterData ()

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

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

DtHumanUseDoorControllerDescriptor::DtHumanUseDoorControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

virtual DtHumanUseDoorControllerDescriptor::~DtHumanUseDoorControllerDescriptor ( )

virtual

destructor

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

copy constructor

Member Function Documentation

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

assignment operator

virtual DtString DtHumanUseDoorControllerDescriptor::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: DtHumanUseDoorControllerDescriptorType

Reimplemented from DtComponentDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

virtual const DtRwStringList& DtHumanUseDoorControllerDescriptor::doorDynamicTerrainTypes ( ) const

virtual

Accessor/mutator for myDoorDynamicTerrainTypes.

virtual DtRwStringList& DtHumanUseDoorControllerDescriptor::doorDynamicTerrainTypes ( )

virtual

Accessor/mutator for myDoorDynamicTerrainTypes.

virtual void DtHumanUseDoorControllerDescriptor::setDoorDynamicTerrainTypes ( const DtRwStringList & types )

virtual

Accessor/mutator for myDoorDynamicTerrainTypes.

virtual DtRwReal DtHumanUseDoorControllerDescriptor::timeToOpen ( ) const

virtual

Accessor/mutator for myTimeToOpen.

virtual void DtHumanUseDoorControllerDescriptor::setTimeToOpen ( DtRwReal t )

virtual

Accessor/mutator for myTimeToOpen.

virtual DtRwReal DtHumanUseDoorControllerDescriptor::headingToUseDoor ( ) const

virtual

Accessor/mutator for myHeadingToUseDoor.

virtual void DtHumanUseDoorControllerDescriptor::setHeadingToUseDoor ( DtRwReal t )

virtual

Accessor/mutator for myHeadingToUseDoor.

virtual DtRwReal DtHumanUseDoorControllerDescriptor::proximityToHoldDoor ( ) const

virtual

Accessor/mutator for myProximityToHoldDoor.

virtual void DtHumanUseDoorControllerDescriptor::setProximityToHoldDoor ( DtRwReal t )

virtual

Accessor/mutator for myProximityToHoldDoor.

static DtComponentDescriptor* DtHumanUseDoorControllerDescriptor::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.

Member Data Documentation

DtRwStringList DtHumanUseDoorControllerDescriptor::myDoorDynamicTerrainTypes

protected

Parameter Name: door-dynamic-terrain-types
Parameter Description: A list of the types of dynamic terrain features that represent to be opened or closed.
Parameter Default Value:
.

DtRwReal DtHumanUseDoorControllerDescriptor::myTimeToOpen

protected

Parameter Name: time-to-open
Parameter Description: The time the entity should wait while the door is opened.
Parameter Default Value: 1.0
Parameter Units: seconds
.

DtRwReal DtHumanUseDoorControllerDescriptor::myHeadingToUseDoor

protected

Parameter Name: heading-to-use-door
Parameter Description: Must turn within a specified number of radians in order to open the door.
Parameter Default Value: 0.15
Parameter Units: radians
.

DtRwReal DtHumanUseDoorControllerDescriptor::myProximityToHoldDoor

protected

Parameter Name: proximity-to-hold-door
Parameter Description: If entities following are within a certain distance, do not close the door on them.
Parameter Default Value: 3
Parameter Units: meters
.

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation