VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtRecursiveResourceIterator Class Reference

File: recRsrcIter.h. More...

Inheritance diagram for DtRecursiveResourceIterator:
Inheritance graph
[legend]

Public Member Functions

 DtRecursiveResourceIterator (const DtList &list)
 Constructor. More...
 
virtual ~DtRecursiveResourceIterator ()
 Destructor. More...
 
DtSimResourcefirst (bool move=true)
 Calls reset() if reset arg is true (useful for for() loops). More...
 
DtSimResourcecurrent () const
 returns the current object. List index is unmodified. More...
 
DtSimResourcenext (bool move=true, bool recurse=false)
 moves the index to the next position and returns the object at that position in the list. More...
 
void reset ()
 sets the current pointer to the start of the list. More...
 
- Public Member Functions inherited from DtIteratorBase< DtSimResource >
 DtIteratorBase (const DtList &list)
 Constructor. Supply the DtList to be iterated over. More...
 
 DtIteratorBase (const DtIteratorBase &orig)
 Copy constructor. More...
 
virtual ~DtIteratorBase ()
 
virtual unsigned int size () const
 
virtual bool empty () const
 
virtual const DtList & list ()
 
virtual bool reset (bool reverse=false)
 Sets the cursor and the direction of this iterator over the list. More...
 
virtual bool reset (DtIteratorLocation location, DtIteratorDirection direction=DtIteratorForward)
 Sets the cursor and the direction of this iterator over the list. More...
 
virtual void reverse ()
 Reverses the direction if this iterator. The cursor is not moved. More...
 
virtual void setDirection (DtIteratorDirection direction)
 Sets the direction of this iterator. The cursor is not moved. More...
 
virtual DtIteratorDirection direction ()
 Returns the current direction of the iterator. More...
 
virtual int cursorIndex () const
 Returns current cursor index in list. More...
 
virtual void setCursorIndex (int i)
 
virtual DtSimResourceinternalFirst (bool move=true)
 Returns the first vertex in the list if going DtIteratorForward, and the last vertex if going DtIteratorReverse. More...
 
DtSimResourceoperator-> ()
 
DtSimResourceoperator* ()
 
virtual DtSimResourceinternalCurrent () const
 Returns the current vertex. The cursor is not moved. More...
 
virtual DtListItem * cursor () const
 Returns the current cursor. Use with caution. More...
 
virtual DtSimResourceitemToObject (DtListItem *item, bool move)
 
virtual DtSimResourceinternalNext (bool move=true)
 
virtual DtSimResourceinternalLast (bool move=true)
 Returns the last vertex in the list if going DtIteratorForward, and the first vertex if going DtIteratorReverse. More...
 
virtual DtSimResourceinternalWrapNext (bool move=true)
 If the cursor is 0, returns 0 (move is ignored in this case). More...
 
virtual DtSimResourceinternalPrev (bool move=true)
 If the cursor is 0, returns 0 (move is ignored in this case). More...
 
virtual DtSimResourceinternalWrapPrev (bool move=true)
 
virtual DtSimResourcecurrent ()
 
virtual DtSimResourcenext (bool move=true)
 
virtual DtSimResourceprev (bool move=true)
 
virtual DtSimResourcelast (bool move=true)
 
virtual DtSimResourcewrapNext (bool move=true)
 
virtual DtSimResourcewrapPrev (bool move=true)
 
DtSimResourceoperator++ ()
 
DtSimResourceoperator-- ()
 

Protected Attributes

DtRecursiveResourceIteratormyChildIterator
 
- Protected Attributes inherited from DtIteratorBase< DtSimResource >
const DtList & myList
 
DtListItem * myCursor
 
DtIteratorDirection myDirection
 

Private Member Functions

 DtRecursiveResourceIterator ()
 Default Constructor. Do not use. More...
 
 DtRecursiveResourceIterator (const DtRecursiveResourceIterator &orig)
 Copy Constructor. More...
 
const DtRecursiveResourceIteratoroperator= (const DtRecursiveResourceIterator &orig)
 Assignment Operator. More...
 

Detailed Description

File: recRsrcIter.h.

Class: DtRecursiveResourceIteratorDescription: DtRecursiveResourceIterator is an iterator for iterating over a DtResourceList of DtSimResource pointers. It has recursive ability if the user wants to iterator over all resources and their subresources. Default is no recursion.

Constructor & Destructor Documentation

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( )
private

Default Constructor. Do not use.

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( const DtRecursiveResourceIterator orig)
private

Copy Constructor.

DtRecursiveResourceIterator::DtRecursiveResourceIterator ( const DtList &  list)
inline

Constructor.

virtual DtRecursiveResourceIterator::~DtRecursiveResourceIterator ( )
inlinevirtual

Destructor.

Member Function Documentation

const DtRecursiveResourceIterator& DtRecursiveResourceIterator::operator= ( const DtRecursiveResourceIterator orig)
private

Assignment Operator.

DtSimResource* DtRecursiveResourceIterator::first ( bool  move = true)
inlinevirtual

Calls reset() if reset arg is true (useful for for() loops).

Returns the first object on the list

Reimplemented from DtIteratorBase< DtSimResource >.

References DtIteratorBase< T >::first().

Referenced by DtMunitionResourceIterator::first().

DtSimResource* DtRecursiveResourceIterator::current ( ) const
inline

returns the current object. List index is unmodified.

References myChildIterator.

Referenced by DtMunitionResourceIterator::current(), and DtMunitionResourceIterator::firstMatch().

DtSimResource* DtRecursiveResourceIterator::next ( bool  move = true,
bool  recurse = false 
)
inline

moves the index to the next position and returns the object at that position in the list.

Returns null if already at the end of list. By default we don't recurse into the subresources.

References DtIteratorBase< T >::current(), and DtSimResource::subresources().

Referenced by DtMunitionResourceIterator::firstMatch(), and DtMunitionResourceIterator::next().

void DtRecursiveResourceIterator::reset ( )
inline

sets the current pointer to the start of the list.

Normally this isn't needed if you use the standard for loop syntax.

References DtIteratorBase< T >::reset().

Member Data Documentation

DtRecursiveResourceIterator* DtRecursiveResourceIterator::myChildIterator
protected

Referenced by current().


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)