VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

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 ()
DtRwDIGuyCharacterInfooperator= (const DtRwDIGuyCharacterInfo &orig)
virtual const char * readerWriterType () const
virtual DtString nextRandomAppearance ()
 Choices a random appearance from the available list.
virtual DtRwDIGuyCharacterInfoclone (DtReaderWriterRegistry *const parentRegistry=0) const
 Returns a newly created clone of this class.
virtual void setDIGuyCharacter (const DtString &character)
 The DI-Guy Character string for this entity.
virtual const DtStringdIGuyCharacter () const
 The DI-Guy Character string for this entity.
virtual void setDIGuyAnimation (const DtString &animation)
 The current DI-Guy animation the entity is displaying.
virtual const DtStringdIGuyAnimation () const
 The current DI-Guy animation the entity is displaying.
virtual void setDIGuyAppearance (const DtString &app)
 The current Di-Guy character appearance of the entity.
virtual const DtStringdIGuyAppearance () const
 The current Di-Guy character appearance of the entity.
virtual DtRwBooleanusingRandomAppearances ()
 Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.
virtual void setUsingRandomAppearances (bool useRandom)
 Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.
virtual void setRandomAppearancesList (const DtRwNLengthStringVector &list)
 Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.
virtual const
DtRwNLengthStringVector
randomAppearancesList () const
 Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.
virtual DtRwNLengthStringVectorrandomAppearancesList ()
 Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
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.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes

DtRwString myCharacterType
DtRwString myCharacterAppearance
DtRwString myCurrentAnimation
DtRwBoolean myUsingRandomAppearances
DtRwNLengthStringVector myRandomAppearances
std::vector< DtStringmyUsedAppearances
 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.
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

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::pair
< DtSymbolString, DtString
DtVariableNameType
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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.
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

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 is used to display this entity as a DI-Guy character in any 3-D app that is hooked up to DI-Guy.

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

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 void DtRwDIGuyCharacterInfo::setDIGuyAnimation ( const DtString animation)
virtual

The current DI-Guy animation the entity is displaying.

virtual const DtString& DtRwDIGuyCharacterInfo::dIGuyAnimation ( ) const
virtual

The current DI-Guy animation the entity is displaying.

virtual void DtRwDIGuyCharacterInfo::setDIGuyAppearance ( const DtString app)
virtual

The current Di-Guy character appearance of the entity.

virtual const DtString& DtRwDIGuyCharacterInfo::dIGuyAppearance ( ) const
virtual

The current Di-Guy character appearance of the entity.

virtual DtRwBoolean& DtRwDIGuyCharacterInfo::usingRandomAppearances ( )
virtual

Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.

virtual void DtRwDIGuyCharacterInfo::setUsingRandomAppearances ( bool  useRandom)
virtual

Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.

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

Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.

virtual const DtRwNLengthStringVector& DtRwDIGuyCharacterInfo::randomAppearancesList ( ) const
virtual

Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.

virtual DtRwNLengthStringVector* DtRwDIGuyCharacterInfo::randomAppearancesList ( )
virtual

Sets whether when placin this entity the user wishes it to be created with a random appearnace from the attached list of possible appearances.

virtual DtString DtRwDIGuyCharacterInfo::nextRandomAppearance ( )
virtual

Choices a random appearance from the available list.

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

Returns a newly created clone of this class.

Member Data Documentation

DtRwString DtRwDIGuyCharacterInfo::myCharacterType
protected
DtRwString DtRwDIGuyCharacterInfo::myCharacterAppearance
protected
DtRwString DtRwDIGuyCharacterInfo::myCurrentAnimation
protected
DtRwBoolean DtRwDIGuyCharacterInfo::myUsingRandomAppearances
protected
DtRwNLengthStringVector DtRwDIGuyCharacterInfo::myRandomAppearances
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:

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)