entt::basic_runtime_view< Entity > Class Template Reference

Runtime view. More...

#include <runtime_view.hpp>

Public Types
using	entity_type = Entity
	Underlying entity identifier.
using	size_type = std::size_t
	Unsigned integer type.
using	iterator = view_iterator
	Bidirectional iterator type.

Public Member Functions
	basic_runtime_view ()
	Default constructor to use to create empty, invalid views.
	basic_runtime_view (std::vector< const basic_common_type * > cpools, std::vector< const basic_common_type * > epools)
	Constructs a runtime view from a set of storage classes. More...
size_type	size_hint () const
	Estimates the number of entities iterated by the view. More...
iterator	begin () const
	Returns an iterator to the first entity that has the given components. More...
iterator	end () const
	Returns an iterator that is past the last entity that has the given components. More...
bool	contains (const entity_type entt) const
	Checks if a view contains an entity. More...
template<typename Func >
void	each (Func func) const
	Iterates entities and applies the given function object to them. More...

Detailed Description

template<typename Entity>
class entt::basic_runtime_view< Entity >

Runtime view.

Runtime views iterate over those entities that have at least all the given components in their bags. During initialization, a runtime view looks at the number of entities available for each component and picks up a reference to the smallest set of candidate entities in order to get a performance boost when iterate.
Order of elements during iterations are highly dependent on the order of the underlying data structures. See sparse_set and its specializations for more details.

Important

Iterators aren't invalidated if:

• New instances of the given components are created and assigned to entities.
• The entity currently pointed is modified (as an example, if one of the given components is removed from the entity to which the iterator points).
• The entity currently pointed is destroyed.

In all the other cases, modifying the pools of the given components in any way invalidates all the iterators and using them results in undefined behavior.

Note

Views share references to the underlying data structures of the registry that generated them. Therefore any change to the entities and to the components made by means of the registry are immediately reflected by the views, unless a pool was missing when the view was built (in this case, the view won't have a valid reference and won't be updated accordingly).

Warning

Lifetime of a view must not overcome that of the registry that generated it. In any other case, attempting to use a view results in undefined behavior.

Template Parameters

Entity

A valid entity type (see entt_traits for more details).

Definition at line 58 of file runtime_view.hpp.

Constructor & Destructor Documentation

basic_runtime_view()

template<typename Entity >

entt::basic_runtime_view< Entity >::basic_runtime_view ( std::vector< const basic_common_type * >  cpools, std::vector< const basic_common_type * >  epools  )

inline

Constructs a runtime view from a set of storage classes.

Parameters

cpools	The storage for the types to iterate.
epools	The storage for the types used to filter the view.

Definition at line 157 of file runtime_view.hpp.

Member Function Documentation

begin()

template<typename Entity >

iterator entt::basic_runtime_view< Entity >::begin ( ) const

inline

Returns an iterator to the first entity that has the given components.

The returned iterator points to the first entity that has the given components. If the view is empty, the returned iterator will be equal to end().

Returns

An iterator to the first entity that has the given components.

Definition at line 185 of file runtime_view.hpp.

contains()

template<typename Entity >

bool entt::basic_runtime_view< Entity >::contains ( const entity_type  entt ) const

inline

Checks if a view contains an entity.

Parameters

entt	A valid entity identifier.

Returns

True if the view contains the given entity, false otherwise.

Definition at line 209 of file runtime_view.hpp.

each()

template<typename Entity >

template<typename Func >

void entt::basic_runtime_view< Entity >::each ( Func  func ) const

inline

Iterates entities and applies the given function object to them.

The function object is invoked for each entity. It is provided only with the entity itself. To get the components, users can use the registry with which the view was built.
The signature of the function should be equivalent to the following:

void(const entity_type);

Template Parameters

Func	Type of the function object to invoke.

Parameters

func	A valid function object.

Definition at line 230 of file runtime_view.hpp.

end()

template<typename Entity >

iterator entt::basic_runtime_view< Entity >::end ( ) const

inline

Returns an iterator that is past the last entity that has the given components.

The returned iterator points to the entity following the last entity that has the given components. Attempting to dereference the returned iterator results in undefined behavior.

Returns

An iterator to the entity following the last entity that has the given components.

Definition at line 200 of file runtime_view.hpp.

size_hint()

template<typename Entity >

size_type entt::basic_runtime_view< Entity >::size_hint ( ) const

inline

Estimates the number of entities iterated by the view.

Returns

Estimated number of entities iterated by the view.

Definition at line 171 of file runtime_view.hpp.

---

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

• src/entt/entity/fwd.hpp
• src/entt/entity/runtime_view.hpp