The DtRwDIGuyCharacterState class is a readable/writable class that can store itself and read itself from a file. This stores the DI-Guy character state that can be changed at run-time and is used to display this entity as a DI-Guy character in any 3-D app that is hooked up to DI-Guy.

Further notes: attached to a DtVrfMovingObjectStateRepository object, to hold DI-Guy-specific state for a particular character instance. Can be serialized out to disk when a scenario is saved. This class should only be used to store DI-Guy data that is changeable at run-time and should be saved into scenarios. For DI-Guy data that is part of configuration and should NOT be saved in into scenarios, use DtRwDIGuyCharacterInfo.

Inheritance diagram for DtRwDIGuyCharacterState:

[legend]

Public Member Functions
virtual DtRwDIGuyCharacterState *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const

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

DtRwDIGuyCharacterState &	operator= (const DtRwDIGuyCharacterState &orig)

bool	operator== (const DtRwDIGuyCharacterState &rhs) const

virtual const char *	readerWriterType () const override


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

DtRwDIGuyCharacterState::DtRwDIGuyCharacterState ( )

Default CTOR.

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

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

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

virtual DtRwDIGuyCharacterState::~DtRwDIGuyCharacterState ( )

overridevirtual

Virtual DTOR.

Member Function Documentation

virtual DtRwDIGuyCharacterState* DtRwDIGuyCharacterState::clone ( DtReaderWriterRegistry *const parentRegistry = NULL ) const

virtual

Returns a newly created clone of this class.

Reimplemented in DtRwDIGuyCharacterInfo.

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

Assignment operator.

bool DtRwDIGuyCharacterState::operator== ( const DtRwDIGuyCharacterState & rhs ) const

Equality operator.

virtual const char* DtRwDIGuyCharacterState::readerWriterType ( ) const

overridevirtual

Returns: DtRwDIGuyCharacterStateType from rwTypes.h.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwDIGuyCharacterInfo.

virtual void DtRwDIGuyCharacterState::setDiguyAnimation ( const DtString & animation )

virtual

The current DI-Guy animation the entity is displaying.

virtual const DtString& DtRwDIGuyCharacterState::diguyAnimation ( ) const

virtual

The current DI-Guy animation the entity is displaying.

virtual void DtRwDIGuyCharacterState::setDiguyUsingAnimationOffset ( bool usingOffset )

virtual

The current DI-Guy animation offset.

virtual bool DtRwDIGuyCharacterState::diguyUsingAnimationOffset ( ) const

virtual

The current DI-Guy animation offset.

virtual void DtRwDIGuyCharacterState::setDiguyAnimationOffset ( const DtVector & offset )

virtual

The current DI-Guy animation offset.

virtual const DtVector& DtRwDIGuyCharacterState::diguyAnimationOffset ( ) const

virtual

The current DI-Guy animation offset.

virtual void DtRwDIGuyCharacterState::setDiguyTransitionSpeed ( float transitionSpeed )

virtual

The current transition speed used for this character's actions.

virtual float DtRwDIGuyCharacterState::diguyTransitionSpeed ( ) const

virtual

The current transition speed used for this character's actions.

virtual void DtRwDIGuyCharacterState::setDiguyAppearance ( const DtString & appearance )

virtual

The current Di-Guy character appearance of the entity.

virtual const DtString& DtRwDIGuyCharacterState::diguyAppearance ( ) const

virtual

The current Di-Guy character appearance of the entity.

virtual void DtRwDIGuyCharacterState::setDiguyBodyWeight ( double )

virtual

The current Di-Guy character body weight.

virtual double DtRwDIGuyCharacterState::diguyBodyWeight ( ) const

virtual

The current Di-Guy character body weight.

virtual void DtRwDIGuyCharacterState::setDiguyHandItem ( const DtString & app )

virtual

The current Di-Guy character hand item of the entity.

virtual const DtString& DtRwDIGuyCharacterState::diguyHandItem ( ) const

virtual

The current Di-Guy character hand item of the entity.

virtual void DtRwDIGuyCharacterState::setDiguyHead ( const DtString & app )

virtual

The current Di-Guy character head of the entity.

virtual const DtString& DtRwDIGuyCharacterState::diguyHead ( ) const

virtual

The current Di-Guy character head of the entity.

virtual void DtRwDIGuyCharacterState::setPrimaryUnitPatch ( const DtPatchIdentifier & patchId )

virtual