IEntityIt

C++
struct IEntityIt {
};
File

IEntitySystem.h

Description

Entity iterator interface. This interface is used to traverse trough all the entities in an entity system. In a way, this iterator works a lot like a stl iterator.

IEntityIt::~IEntityIt Destructor
C++
virtual ~IEntityIt();
IEntityIt::AddRef Method
C++
virtual void AddRef() = 0;
IEntityIt::IsEnd Method

Checks whether current iterator position is the end position.

C++
virtual bool IsEnd() = 0;
Returns

True if iterator at end position.

IEntityIt::MoveFirst Method

Positions the iterator at the beginning of the entity list.

C++
virtual void MoveFirst() = 0;
IEntityIt::Next Method

Retrieves next entity.

C++
virtual IEntity * Next() = 0;
Returns

A pointer to the entity that the iterator points to before it goes to the next.

IEntityIt::Release Method

Deletes this iterator and frees any memory it might have allocated.

C++
virtual void Release() = 0;
IEntityIt::This Method

Retrieves current entity.

C++
virtual IEntity * This() = 0;
Returns

The entity that the iterator points to.