Nui::ECS::Internal::EntityComponentIterator< Types > Class Template Reference

Iterator class to allow easy iteration over entities with components. More...

#include <Entity.h>

Public Member Functions
	EntityComponentIterator (Context *context, U64 index, bool isEnd, bool includePendingDestroy)
	Initializes the iterator with necessary information.
U64	GetIndex () const noexcept
	Gets the index of the current entity in the iteration.
bool	IncludePendingDestroy () const noexcept
	Whether the iterator should include pending destruction entities.
Context *	GetContext () const noexcept
	Gets the ECS context associated with the iterator.
bool	IsEnd () const noexcept
	Checks if the iterator is at the end.
Entity *	GetEntity () const noexcept
	Gets the current entity held by the iterator.
Entity *	operator* () const noexcept
	Gets the current entity held by the iterator.
bool	operator== (const EntityComponentIterator< Types... > &other) const
	Checks if two iterators are equal.
bool	operator!= (const EntityComponentIterator< Types... > &other) const
	Checks if two iterators are not equal.
EntityComponentIterator< Types... > &	operator++ ()
	Moves the iterator to the next entity and skips over entities based on input criteria.

Detailed Description

template<typename... Types>
class Nui::ECS::Internal::EntityComponentIterator< Types >

Iterator class to allow easy iteration over entities with components.

Template Parameters

...Types

Types of components to include in the iteration

Constructor & Destructor Documentation

EntityComponentIterator()

template<typename... Types>

Nui::ECS::Internal::EntityComponentIterator< Types >::EntityComponentIterator ( Context * context, U64 index, bool isEnd, bool includePendingDestroy )

inline

Initializes the iterator with necessary information.

Parameters

context	Pointer to the ECS Context
index	Starting index for iteration
isEnd	Flag indicating if the iterator is at the end
includePendingDestroy	Flag indicating if the iterator should include pending destruction entities

Member Function Documentation

GetContext()

template<typename... Types>

Context * Nui::ECS::Internal::EntityComponentIterator< Types >::GetContext ( ) const

inlinenoexcept

Gets the ECS context associated with the iterator.

Returns

Pointer to the ECS context

GetEntity()

template<typename... Types>

Entity * Nui::ECS::Internal::EntityComponentIterator< Types >::GetEntity ( ) const

inlinenoexcept

Gets the current entity held by the iterator.

Returns

Pointer to the current entity

GetIndex()

template<typename... Types>

U64 Nui::ECS::Internal::EntityComponentIterator< Types >::GetIndex ( ) const

inlinenoexcept

Gets the index of the current entity in the iteration.

Returns

Index of the current entity

IncludePendingDestroy()

template<typename... Types>

bool Nui::ECS::Internal::EntityComponentIterator< Types >::IncludePendingDestroy ( ) const

inlinenoexcept

Whether the iterator should include pending destruction entities.

Returns

True if the iterator should include pending destruction entities

IsEnd()

template<typename... Types>

bool Nui::ECS::Internal::EntityComponentIterator< Types >::IsEnd ( ) const

inlinenoexcept

Checks if the iterator is at the end.

Returns

True if the iterator is at the end

operator!=()

template<typename... Types>

bool Nui::ECS::Internal::EntityComponentIterator< Types >::operator!= ( const EntityComponentIterator< Types... > & other ) const

inline

Checks if two iterators are not equal.

Parameters

other

Other iterator

Returns

True if the iterators are not equal

operator*()

template<typename... Types>

Entity * Nui::ECS::Internal::EntityComponentIterator< Types >::operator* ( ) const

inlinenoexcept

Gets the current entity held by the iterator.

Returns

Pointer to the current entity

operator++()

template<typename... Types>

Internal::EntityComponentIterator< Types... > & Nui::ECS::Internal::EntityComponentIterator< Types >::operator++ ( )

inline

Moves the iterator to the next entity and skips over entities based on input criteria.

Returns

Reference to the iterator

operator==()

template<typename... Types>

bool Nui::ECS::Internal::EntityComponentIterator< Types >::operator== ( const EntityComponentIterator< Types... > & other ) const

inline

Checks if two iterators are equal.

Parameters

other

Other iterator

Returns

True if the iterators are equal

---

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

• Engine/Core/Engine/ECS/Entity.h
• Engine/Core/Engine/ECS/ECS.h