VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions
DtEmitterBeamList Class Reference

DtEmitterBeamList; Readable/writeable container for DtEmitterBeamEntry* items. More...

Inheritance diagram for DtEmitterBeamList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtEmitterBeamList ()
 default constructor
 DtEmitterBeamList (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor
 DtEmitterBeamList (const DtSymbolString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtEmitterBeamList ()
 destructor
 DtEmitterBeamList (const DtString &writeName, const DtEmitterBeamList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtEmitterBeamList (const DtSymbolString &writeName, const DtEmitterBeamList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtEmitterBeamListoperator= (const DtEmitterBeamList &orig)
 assignment operator
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Overridden to call reindexBeams() once everything is read.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtEmitterBeamEntry, reads the data from the mtl stream, and adds it to the list.
virtual void reindexBeams ()
 Finds any beam entries without specified index values and assignes an available index to them.
void removeAndDeleteBeams ()
 removes and deletes all items from the list.
void copyListItemsFrom (const DtEmitterBeamList &sourceList)
 Makes copies of all items on sourceList and adds them to this list.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.

Detailed Description

DtEmitterBeamList; Readable/writeable container for DtEmitterBeamEntry* items.

Instances of DtEmitterBeamList each hold a list of pointers to DtEmitterBeamEntry that describe beam characteristics for an emitter system.


Constructor & Destructor Documentation

default constructor

DtEmitterBeamList::DtEmitterBeamList ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor

DtEmitterBeamList::DtEmitterBeamList ( const DtSymbolString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)

destructor

DtEmitterBeamList::DtEmitterBeamList ( const DtString writeName,
const DtEmitterBeamList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtEmitterBeamList::DtEmitterBeamList ( const DtSymbolString writeName,
const DtEmitterBeamList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

Member Function Documentation

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

assignment operator

virtual void DtEmitterBeamList::getSelf ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [virtual]

Overridden to call reindexBeams() once everything is read.

Reimplemented from DtRwList.

virtual DtlObjPtr DtEmitterBeamList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [protected, virtual]

Constructs a DtEmitterBeamEntry, reads the data from the mtl stream, and adds it to the list.

Implements DtRwList.

virtual void DtEmitterBeamList::reindexBeams ( ) [protected, virtual]

Finds any beam entries without specified index values and assignes an available index to them.

Should be called after the entire list is read from the stream.

removes and deletes all items from the list.

Non-virtual since it is called from constructors/destructor.

void DtEmitterBeamList::copyListItemsFrom ( const DtEmitterBeamList sourceList) [protected]

Makes copies of all items on sourceList and adds them to this list.

Non-virtual since it is called from constructors.

virtual const char* DtEmitterBeamList::readerWriterType ( ) const [protected, 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.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)