Class CEntity::CEntityIterator#

Nested Relationships#

This class is a nested type of Class CEntity.

Inheritance Relationships#

Base Types#

Class Documentation#

class CEntityIterator : public sdv::idl::IEntityIterator, public sdv::IInterfaceAccess

Entity iterator helper class.

Public Functions

CEntityIterator(CEntityVector &rvecEntities)

Constructor.

Parameters:

rvecEntities – [in] Reference to the entity vector to create the iterator for.

virtual sdv::interface_t GetInterface(sdv::interface_id idInterface) override

Get access to another interface. Overload of IInterfaceAccess::GetInterface.

Parameters:

idInterface – [in] The interface id to get access to.

Returns:

Returns a pointer to the interface or NULL when the interface is not supported.

virtual uint32_t GetCount() const override

Get amount of child entities. Overload of IEntityIterator::GetCount.

Returns:

Returns the amount of entities in this iterator.

virtual sdv::IInterfaceAccess *GetEntityByIndex(uint32_t uiIndex) override

Get entity at supplied index. Overload of IEntityIterator::GetEntityByIndex.

Parameters:

uiIndex – [in] Index of the entity to return.

Returns:

Returns interface pointer to the entity or NULL when the index was too large.