DtRwDIGuyCharacterInfo Class Reference

The DtRwDIGuyCharactertInfo class is a readable/writable class that can store itself and read itself from a file. More...

Inheritance diagram for DtRwDIGuyCharacterInfo:

Public Member Functions
	DtRwDIGuyCharacterInfo ()
	DtRwDIGuyCharacterInfo (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwDIGuyCharacterInfo (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwDIGuyCharacterInfo (const DtRwDIGuyCharacterInfo &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwDIGuyCharacterInfo ()
DtRwDIGuyCharacterInfo &	operator= (const DtRwDIGuyCharacterInfo &orig)
virtual const char *	readerWriterType () const
virtual DtString	nextRandomAppearance ()
	Chooses a random appearance from the available list. More...
virtual DtString	nextRandomHandItem ()
	Chooses a random hand item from the available list. More...
virtual DtString	nextRandomHead ()
	Chooses a random hand item from the available list. More...
virtual DtRwDIGuyCharacterInfo *	clone (DtReaderWriterRegistry *const parentRegistry=0) const
	Returns a newly created clone of this class. More...
bool	operator== (const DtRwDIGuyCharacterInfo &) const
virtual void	setDIGuyCharacter (const DtString &character)
	The DI-Guy Character string for this entity. More...
virtual const DtString &	dIGuyCharacter () const
virtual bool	usingRandomAppearances () const
	Sets whether, when this entity is placed, the user wishes it to be created with a random appearance from the attached list of possible appearances. More...
virtual void	setUsingRandomAppearances (bool useRandom)
virtual void	setRandomAppearancesList (const DtRwNLengthStringVector &list)
virtual const DtRwNLengthStringVector &	randomAppearancesList () const
virtual DtRwNLengthStringVector *	randomAppearancesList ()
virtual bool	usingRandomHandItems () const
	Sets whether, when this entity is placed, the user wishes it to be created with a random hand item from the attached list of possible hand items. More...
virtual void	setUsingRandomHandItems (bool useRandom)
virtual void	setRandomHandItemsList (const DtRwNLengthStringVector &list)
virtual const DtRwNLengthStringVector &	randomHandItemsList () const
virtual DtRwNLengthStringVector *	randomHandItemsList ()
virtual bool	usingRandomHeads () const
	Sets whether, when this entity is placed, the user wishes it to be created with a random head from the attached list of possible head items. More...
virtual void	setUsingRandomHeads (bool useRandom)
virtual void	setRandomHeadsList (const DtRwNLengthStringVector &list)
virtual const DtRwNLengthStringVector &	randomHeadsList () const
virtual DtRwNLengthStringVector *	randomHeadsList ()
Public Member Functions inherited from DtRwDIGuyCharacterState
	DtRwDIGuyCharacterState ()
	DtRwDIGuyCharacterState (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwDIGuyCharacterState (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwDIGuyCharacterState (const DtRwDIGuyCharacterState &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwDIGuyCharacterState ()
DtRwDIGuyCharacterState &	operator= (const DtRwDIGuyCharacterState &orig)
bool	operator== (const DtRwDIGuyCharacterState &) const
virtual void	setDIGuyAnimation (const DtString &animation)
	The current DI-Guy animation the entity is displaying. More...
virtual const DtString &	dIGuyAnimation () const
virtual void	setDIGuyUsingAnimationOffset (bool usingOffset)
	The current DI-Guy animation offset. More...
virtual bool	dIGuyUsingAnimationOffset () const
virtual void	setDIGuyAnimationOffset (const DtVector &offset)
	The current DI-Guy animation offset. More...
virtual const DtVector &	dIGuyAnimationOffset () const
virtual void	setDIGuyAppearance (const DtString &app)
	The current Di-Guy character appearance of the entity. More...
virtual const DtString &	dIGuyAppearance () const
virtual void	setDIGuyBodyWeight (double)
	The current Di-Guy character body weight. More...
virtual double	dIGuyBodyWeight () const
virtual void	setDIGuyHandItem (const DtString &app)
	The current Di-Guy character hand item of the entity. More...
virtual const DtString &	dIGuyHandItem () const
virtual void	setDIGuyHead (const DtString &app)
	The current Di-Guy character head of the entity. More...
virtual const DtString &	dIGuyHead () 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	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. 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 *	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	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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...

Protected Attributes
DtRwString	myCharacterType
DtRwBoolean	myUsingRandomAppearances
DtRwNLengthStringVector	myRandomAppearances
DtRwBoolean	myUsingRandomHandItems
DtRwNLengthStringVector	myRandomHandItems
DtRwBoolean	myUsingRandomHeads
DtRwNLengthStringVector	myRandomHeads
std::vector< DtString >	myUsedAppearances
	If using a random appearance upon creation, when an appearance has been used it is removed from the appearances list and added to this one. More...
Protected Attributes inherited from DtRwDIGuyCharacterState
DtRwString	myCharacterAppearance
DtRwString	myCharacterHandItem
DtRwString	myCharacterHead
DtRwString	myCurrentAnimation
DtRwBoolean	myUsingAnimationOffset
DtRwVector	myCurrentAnimationOffset
DtRwReal	myBodyWeight
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 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 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 inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...
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

The DtRwDIGuyCharactertInfo class is a readable/writable class that can store itself and read itself from a file.

This stores the DI-Guy character information that can be configured for an entity type and that is used to display this entity as a DI-Guy character in any 3-D app that is hooked up to DI-Guy. Includes the default settings for run-time changeable state as well as configured values that cannot be changed at run-time.

Notes: This class should store DI-Guy data that is part of configuration data. Any data that is changeable at run-time and should therefore be stored in a scenario should be part of the parent class, DtRwDIGuyCharacterState. This class should be used to set defaults for run-time changeable state data, however.

Constructor & Destructor Documentation

DtRwDIGuyCharacterInfo::DtRwDIGuyCharacterInfo

(

)

DtRwDIGuyCharacterInfo::DtRwDIGuyCharacterInfo	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwDIGuyCharacterInfo::DtRwDIGuyCharacterInfo	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwDIGuyCharacterInfo::DtRwDIGuyCharacterInfo	(	const DtRwDIGuyCharacterInfo &	orig,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

virtual DtRwDIGuyCharacterInfo::~DtRwDIGuyCharacterInfo ( )

virtual

Member Function Documentation

DtRwDIGuyCharacterInfo& DtRwDIGuyCharacterInfo::operator=

(

const DtRwDIGuyCharacterInfo &

orig

)

virtual const char* DtRwDIGuyCharacterInfo::readerWriterType ( ) const

virtual

Returns

DtRwDIGuyCharacterInfoType from rwTypes.h.

Reimplemented from DtRwDIGuyCharacterState.

virtual void DtRwDIGuyCharacterInfo::setDIGuyCharacter ( const DtString &  character )

virtual

The DI-Guy Character string for this entity.

virtual const DtString& DtRwDIGuyCharacterInfo::dIGuyCharacter ( ) const

virtual

virtual bool DtRwDIGuyCharacterInfo::usingRandomAppearances ( ) const

virtual

Sets whether, when this entity is placed, the user wishes it to be created with a random appearance from the attached list of possible appearances.

virtual void DtRwDIGuyCharacterInfo::setUsingRandomAppearances ( bool  useRandom )

virtual

virtual void DtRwDIGuyCharacterInfo::setRandomAppearancesList ( const DtRwNLengthStringVector &  list )

virtual

virtual const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomAppearancesList ( ) const

virtual

virtual DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomAppearancesList ( )

virtual

virtual DtString DtRwDIGuyCharacterInfo::nextRandomAppearance ( )

virtual

Chooses a random appearance from the available list.

virtual bool DtRwDIGuyCharacterInfo::usingRandomHandItems ( ) const

virtual

Sets whether, when this entity is placed, the user wishes it to be created with a random hand item from the attached list of possible hand items.

virtual void DtRwDIGuyCharacterInfo::setUsingRandomHandItems ( bool  useRandom )

virtual

virtual void DtRwDIGuyCharacterInfo::setRandomHandItemsList ( const DtRwNLengthStringVector &  list )

virtual

virtual const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomHandItemsList ( ) const

virtual

virtual DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomHandItemsList ( )

virtual

virtual DtString DtRwDIGuyCharacterInfo::nextRandomHandItem ( )

virtual

Chooses a random hand item from the available list.

virtual bool DtRwDIGuyCharacterInfo::usingRandomHeads ( ) const

virtual

Sets whether, when this entity is placed, the user wishes it to be created with a random head from the attached list of possible head items.

virtual void DtRwDIGuyCharacterInfo::setUsingRandomHeads ( bool  useRandom )

virtual

virtual void DtRwDIGuyCharacterInfo::setRandomHeadsList ( const DtRwNLengthStringVector &  list )

virtual

virtual const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomHeadsList ( ) const

virtual

virtual DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomHeadsList ( )

virtual

virtual DtString DtRwDIGuyCharacterInfo::nextRandomHead ( )

virtual

Chooses a random hand item from the available list.

virtual DtRwDIGuyCharacterInfo* DtRwDIGuyCharacterInfo::clone ( DtReaderWriterRegistry *const  parentRegistry = 0 ) const

virtual

Returns a newly created clone of this class.

Reimplemented from DtRwDIGuyCharacterState.

bool DtRwDIGuyCharacterInfo::operator==

(

const DtRwDIGuyCharacterInfo &

)

const

Member Data Documentation

DtRwString DtRwDIGuyCharacterInfo::myCharacterType

protected

DtRwBoolean DtRwDIGuyCharacterInfo::myUsingRandomAppearances

protected

DtRwNLengthStringVector DtRwDIGuyCharacterInfo::myRandomAppearances

protected

DtRwBoolean DtRwDIGuyCharacterInfo::myUsingRandomHandItems

protected

DtRwNLengthStringVector DtRwDIGuyCharacterInfo::myRandomHandItems

protected

DtRwBoolean DtRwDIGuyCharacterInfo::myUsingRandomHeads

protected

DtRwNLengthStringVector DtRwDIGuyCharacterInfo::myRandomHeads

protected

std::vector<DtString> DtRwDIGuyCharacterInfo::myUsedAppearances

protected

If using a random appearance upon creation, when an appearance has been used it is removed from the appearances list and added to this one.

Once the appearances list is empty we reset it.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/rwDIGuyCharacterInfo.h