 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
Public Member Functions | |
| DtRwSpawnDataList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Actual constructor. | |
| DtRwSpawnDataList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwSpawnDataList (const DtRwSpawnDataList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Copy constructor. | |
| virtual DtRwSpawnDataList * | clone (DtReaderWriterRegistry *parentRegistry) |
| Clone method; makes a new object, and copies the object calling this method. | |
| virtual | ~DtRwSpawnDataList () |
| destructor | |
| DtRwSpawnDataList & | operator= (const DtRwSpawnDataList &orig) |
| Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| void | deleteList () |
| Removes all elements of this list and deletes them. | |
| virtual DtRwSpawnData * | lookUpTemplateByName (const DtString &templateName) const |
| Function to retrieve a template by name. | |
| virtual bool | deleteTemplate (const DtString &templateName) |
| Function to delete a template from the list, given the template name. | |
| virtual DtString | stringRep () |
| Produces a string representation of the templates, suitable for printing. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Functions for reading a list of templates from an mtl file. | |
 Public Member Functions inherited from DtRwList | |
| DtRwList () | |
| default constructor | |
| DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual | ~DtRwList () |
| const DtRwList & | operator= (const DtRwList &orig) |
| Calls down to DtReaderWriter::operator=(). List elements are not copied. | |
| virtual DtListItem * | add (DtReaderWriter *data) |
| Add element to the end of the list. | |
| virtual DtListItem * | addWithAlternateName (DtReaderWriter *data, const DtString &name) |
| Add element to the end of the list, but use the provided name in place of the object name on the data object. | |
| virtual DtListItem * | addToStart (DtReaderWriter *data) |
| Add element to the beginning of the list. | |
| virtual DtListItem * | addToEnd (DtReaderWriter *data) |
| Add element to the end of the list. | |
| virtual void * | remove (DtReaderWriter *data, DtListItem *item) |
| Remove an element from the list. | |
| virtual DtlObjPtr | getLocalData (DtlObjPtr args) |
| Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| virtual DtListItem * | addBefore (DtReaderWriter *data, DtReaderWriter *before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, DtReaderWriter *after) |
| Add element to the list just after the indicated item. | |
| virtual void | removeAll () |
| Removes all the items in the list. | |
| bool | operator== (const DtRwList &rhs) const |
| Iterates over all items and calls the factory to compare. | |
| bool | operator!= (const DtRwList &rhs) const |
| DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Invokes DtReaderWriter copy constructor. | |
| DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Invokes DtReaderWriter copy constructor. | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, const DtString &before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, const DtSymbolString &before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, const DtString &after) |
| Add element to the list just after the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, const DtSymbolString &after) |
| Add element to the list just after the indicated item. | |
| 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 DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| 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 aliasContainer & | aliases () 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 void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| 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 DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Protected Member Functions | |
| DtRwSpawnDataList () | |
| Constructors etc. | |
| void | copyList (const DtRwSpawnDataList &orig) |
| A convenience function for the copy constructor and = op. | |
| Protected Member Functions inherited from DtRwList | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, DtListItem *before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, DtListItem *after) |
| Add element to the list just after the indicated item. | |
| 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. | |
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 |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| 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 void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static DtReaderWriterFactory * | factory () |
| 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. | |
| 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 |
|
protected |
Constructors etc.
default constructor
| DtRwSpawnDataList::DtRwSpawnDataList | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Actual constructor.
| DtRwSpawnDataList::DtRwSpawnDataList | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtRwSpawnDataList::DtRwSpawnDataList | ( | const DtRwSpawnDataList & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Copy constructor.
|
virtual |
destructor
|
virtual |
Clone method; makes a new object, and copies the object calling this method.
| DtRwSpawnDataList& DtRwSpawnDataList::operator= | ( | const DtRwSpawnDataList & | orig | ) |
Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.
|
virtual |
Used to supply a string type that this reader writer type is.
This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create
Reimplemented from DtRwList.
|
protected |
A convenience function for the copy constructor and = op.
Copies by allocating new templates, and adds them to this list. Non-virtual because it is used from constructor/destructor.
| void DtRwSpawnDataList::deleteList | ( | ) |
Removes all elements of this list and deletes them.
Used by the copy constructor and destructor; also available for other modules to clear a list. Non-virtual because it is used from constructor/destructor.
|
virtual |
Function to retrieve a template by name.
Function to delete a template from the list, given the template name.
Returns true if successful, false if the template was not found.
|
virtual |
Produces a string representation of the templates, suitable for printing.
Utility function, primarily for debugging.
|
virtual |
Functions for reading a list of templates from an mtl file.
Reads data for one spawn template and adds it to the list. Note that the getself defined in RwList walks the list of data in the mtl file calling this getdata on each item.
Implements DtRwList.