QSDK 1.1 Documentation
Main Page | Modules | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

Q::EntityIterator Struct Reference
[Entity platform]

#include <Q/gamedev.h>

Inheritance diagram for Q::EntityIterator:

Com::Unknown List of all members.

Public Types

typedef Com::Ptr< EntityIteratorPTR

Public Member Functions

virtual Utils::Result getCurrent (EntityInstance **) const=0
EntityInstance::PTR current () const
virtual Utils::Result next ()=0
virtual bool valid () const=0
EntityInstance::PTR operator * () const
 operator EntityInstance * () const
EntityIteratoroperator++ ()

Static Public Attributes

Com::UUID IID
Com::UUID CLSID

Detailed Description

Entity iterator.


Member Typedef Documentation

typedef Com::Ptr<EntityIterator> Q::EntityIterator::PTR
 

A COM pointer to an object of this class


Member Function Documentation

EntityInstance::PTR Q::EntityIterator::current  )  const [inline]
 

See also:
getCurrent

virtual Utils::Result Q::EntityIterator::getCurrent EntityInstance **   )  const [pure virtual]
 

Return the current EntityInstance in the iteration list.

Note:
The reference count of the EntityInstance will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::EntityIterator::next  )  [pure virtual]
 

Go to the next element in the iteration.

EntityInstance::PTR Q::EntityIterator::operator *  )  const [inline]
 

See also:
getCurrent

Q::EntityIterator::operator EntityInstance *  )  const [inline]
 

See also:
getCurrent

EntityIterator& Q::EntityIterator::operator++  )  [inline]
 

See also:
next

virtual bool Q::EntityIterator::valid  )  const [pure virtual]
 

Indicates whether there is any elements left in the iteration or not.


Member Data Documentation

Com::UUID Q::EntityIterator::CLSID [static]
 

COM CLSID 0bc0b7dd-738b-4a41-9ceb-5fe8d2255bf6

Com::UUID Q::EntityIterator::IID [static]
 

COM IID c6c398b5-ff58-45b1-a9a4-b1396f8dd710

Reimplemented from Com::Unknown.

Return to QSDK documentation Contents page. Contact details for support, information and fault-reporting.
Qube Software Limited © 2000-2004