DtRwDIGuyCharacterInfo Class Reference

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.

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 ()
virtual DtString	nextRandomHandItem ()
virtual DtString	nextRandomHead ()
virtual DtRwDIGuyCharacterInfo *	clone (DtReaderWriterRegistry *const parentRegistry=0) const
bool	operator== (const DtRwDIGuyCharacterInfo &) const
virtual void	setDIGuyCharacter (const DtString &character)
virtual const DtString &	diguyCharacter () const
virtual bool	usingRandomAppearances () const
virtual void	setUsingRandomAppearances (bool useRandom)
virtual void	setRandomAppearancesList (const DtRwNLengthStringVector &list)
virtual const DtRwNLengthStringVector &	randomAppearancesList () const
virtual DtRwNLengthStringVector *	randomAppearancesList ()
virtual bool	usingRandomHandItems () const
virtual void	setUsingRandomHandItems (bool useRandom)
virtual void	setRandomHandItemsList (const DtRwNLengthStringVector &list)
virtual const DtRwNLengthStringVector &	randomHandItemsList () const
virtual DtRwNLengthStringVector *	randomHandItemsList ()
virtual bool	usingRandomHeads () const
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 &rhs) const
virtual void	setDiguyAnimation (const DtString &animation)
virtual const DtString &	diguyAnimation () const
virtual void	setDiguyUsingAnimationOffset (bool usingOffset)
virtual bool	diguyUsingAnimationOffset () const
virtual void	setDiguyAnimationOffset (const DtVector &offset)
virtual const DtVector &	diguyAnimationOffset () const
virtual void	setDiguyTransitionSpeed (float transitionSpeed)
virtual float	diguyTransitionSpeed () const
virtual void	setDiguyAppearance (const DtString &appearance)
virtual const DtString &	diguyAppearance () const
virtual void	setDiguyBodyWeight (double)
virtual double	diguyBodyWeight () const
virtual void	setDiguyHandItem (const DtString &app)
virtual const DtString &	diguyHandItem () const
virtual void	setDiguyHead (const DtString &app)
virtual const DtString &	diguyHead () const
virtual void	setPrimaryUnitPatch (const DtPatchIdentifier &patchId)
virtual DtPatchIdentifier	primaryUnitPatchId () const
virtual void	setSecondaryUnitPatch (const DtPatchIdentifier &patchId)
virtual DtPatchIdentifier	secondaryUnitPatchId () const
virtual void	setRankPatch (const DtPatchIdentifier &patchId)
virtual DtPatchIdentifier	rankPatchId () const
virtual void	setCharacterName (const DtString &name)
virtual DtString	characterName () const
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 *	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	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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)

Protected Attributes
DtRwString	myCharacterType
DtRwBoolean	myUsingRandomAppearances
DtRwNLengthStringVector	myRandomAppearances
DtRwBoolean	myUsingRandomHandItems
DtRwNLengthStringVector	myRandomHandItems
DtRwBoolean	myUsingRandomHeads
DtRwNLengthStringVector	myRandomHeads
std::vector< DtString >	myUsedAppearances
Protected Attributes inherited from DtRwDIGuyCharacterState
DtRwString	myCharacterAppearance
DtRwString	myCharacterHandItem
DtRwString	myCharacterHead
DtRwString	myCurrentAnimation
DtRwBoolean	myUsingAnimationOffset
DtRwVector	myCurrentAnimationOffset
DtRwReal	myCurrentTransitionSpeed
DtRwReal	myBodyWeight
DtRwUnsigned	myPrimaryUnitPatchCountry
DtRwUnsigned	myPrimaryUnitPatchService
DtRwUnsigned	myPrimaryUnitPatchId
DtRwUnsigned	mySecondaryUnitPatchCountry
DtRwUnsigned	mySecondaryUnitPatchService
DtRwUnsigned	mySecondaryUnitPatchId
DtRwUnsigned	myRankPatchCountry
DtRwUnsigned	myRankPatchService
DtRwUnsigned	myRankPatchId
DtRwString	myCharacterName
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 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 inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

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

The DI-Guy Character string for this entity.

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

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::setRandomAppearancesList ( const DtRwNLengthStringVector &  list )

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 const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomAppearancesList ( ) 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 DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomAppearancesList ( )

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

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::setRandomHandItemsList ( const DtRwNLengthStringVector &  list )

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 const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomHandItemsList ( ) 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 DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomHandItemsList ( )

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

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::setRandomHeadsList ( const DtRwNLengthStringVector &  list )

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 const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomHeadsList ( ) 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 DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomHeadsList ( )

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 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.vrf5-1-branch/include/vrfutil/rwDIGuyCharacterInfo.h