EnTT 3.11.0
Classes | Public Types | Public Member Functions | List of all members
entt::basic_registry< Entity, Allocator > Class Template Reference

Fast and reliable entity-component system. More...

#include <registry.hpp>

Public Types

using allocator_type = Allocator
 Allocator type. More...
 
using entity_type = Entity
 Underlying entity identifier. More...
 
using version_type = typename entity_traits::version_type
 Underlying version type. More...
 
using size_type = std::size_t
 Unsigned integer type. More...
 
using base_type = basic_common_type
 Common type among all storage types. More...
 
using context = internal::registry_context
 Context type. More...
 

Public Member Functions

 basic_registry ()
 Default constructor. More...
 
 basic_registry (const allocator_type &allocator)
 Constructs an empty registry with a given allocator. More...
 
 basic_registry (const size_type count, const allocator_type &allocator=allocator_type{})
 Allocates enough memory upon construction to store count pools. More...
 
 basic_registry (basic_registry &&other) noexcept
 Move constructor. More...
 
basic_registryoperator= (basic_registry &&other) noexcept
 Move assignment operator. More...
 
void swap (basic_registry &other)
 Exchanges the contents with those of a given registry. More...
 
constexpr allocator_type get_allocator () const noexcept
 Returns the associated allocator. More...
 
auto storage () noexcept
 Returns an iterable object to use to visit a registry. More...
 
auto storage () const noexcept
 Returns an iterable object to use to visit a registry. More...
 
base_typestorage (const id_type id)
 Finds the storage associated with a given name, if any. More...
 
const base_typestorage (const id_type id) const
 Finds the storage associated with a given name, if any. More...
 
template<typename Type >
decltype(auto) storage (const id_type id=type_hash< Type >::value())
 Returns the storage for a given component type. More...
 
template<typename Type >
decltype(auto) storage (const id_type id=type_hash< Type >::value()) const
 Returns the storage for a given component type. More...
 
size_type size () const noexcept
 Returns the number of entities created so far. More...
 
size_type alive () const
 Returns the number of entities still in use. More...
 
void reserve (const size_type cap)
 Increases the capacity (number of entities) of the registry. More...
 
size_type capacity () const noexcept
 Returns the number of entities that a registry has currently allocated space for. More...
 
bool empty () const
 Checks whether the registry is empty (no entities still in use). More...
 
const entity_typedata () const noexcept
 Direct access to the list of entities of a registry. More...
 
entity_type released () const noexcept
 Returns the head of the list of released entities. More...
 
bool valid (const entity_type entt) const
 Checks if an identifier refers to a valid entity. More...
 
version_type current (const entity_type entt) const
 Returns the actual version for an identifier. More...
 
entity_type create ()
 Creates a new entity or recycles a destroyed one. More...
 
entity_type create (const entity_type hint)
 Creates a new entity or recycles a destroyed one. More...
 
template<typename It >
void create (It first, It last)
 Assigns each element in a range an identifier. More...
 
template<typename It >
void assign (It first, It last, const entity_type destroyed)
 Assigns identifiers to an empty registry. More...
 
version_type release (const entity_type entt)
 Releases an identifier. More...
 
version_type release (const entity_type entt, const version_type version)
 Releases an identifier. More...
 
template<typename It >
void release (It first, It last)
 Releases all identifiers in a range. More...
 
version_type destroy (const entity_type entt)
 Destroys an entity and releases its identifier. More...
 
version_type destroy (const entity_type entt, const version_type version)
 Destroys an entity and releases its identifier. More...
 
template<typename It >
void destroy (It first, It last)
 Destroys all entities in a range and releases their identifiers. More...
 
template<typename Type , typename... Args>
decltype(auto) emplace (const entity_type entt, Args &&...args)
 Assigns the given component to an entity. More...
 
template<typename Type , typename It >
void insert (It first, It last, const Type &value={})
 Assigns each entity in a range the given component. More...
 
template<typename Type , typename EIt , typename CIt , typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>>
void insert (EIt first, EIt last, CIt from)
 Assigns each entity in a range the given components. More...
 
template<typename Type , typename... Args>
decltype(auto) emplace_or_replace (const entity_type entt, Args &&...args)
 Assigns or replaces the given component for an entity. More...
 
template<typename Type , typename... Func>
decltype(auto) patch (const entity_type entt, Func &&...func)
 Patches the given component for an entity. More...
 
template<typename Type , typename... Args>
decltype(auto) replace (const entity_type entt, Args &&...args)
 Replaces the given component for an entity. More...
 
template<typename Type , typename... Other>
size_type remove (const entity_type entt)
 Removes the given components from an entity. More...
 
template<typename Type , typename... Other, typename It >
size_type remove (It first, It last)
 Removes the given components from all the entities in a range. More...
 
template<typename Type , typename... Other>
void erase (const entity_type entt)
 Erases the given components from an entity. More...
 
template<typename Type , typename... Other, typename It >
void erase (It first, It last)
 Erases the given components from all the entities in a range. More...
 
template<typename... Type>
void compact ()
 Removes all tombstones from a registry or only the pools for the given components. More...
 
template<typename... Type>
bool all_of (const entity_type entt) const
 Check if an entity is part of all the given storage. More...
 
template<typename... Type>
bool any_of (const entity_type entt) const
 Check if an entity is part of at least one given storage. More...
 
template<typename... Type>
decltype(auto) get (const entity_type entt) const
 Returns references to the given components for an entity. More...
 
template<typename... Type>
decltype(auto) get (const entity_type entt)
 Returns references to the given components for an entity. More...
 
template<typename Type , typename... Args>
decltype(auto) get_or_emplace (const entity_type entt, Args &&...args)
 Returns a reference to the given component for an entity. More...
 
template<typename... Type>
auto try_get (const entity_type entt) const
 Returns pointers to the given components for an entity. More...
 
template<typename... Type>
auto try_get (const entity_type entt)
 Returns pointers to the given components for an entity. More...
 
template<typename... Type>
void clear ()
 Clears a whole registry or the pools for the given components. More...
 
template<typename Func >
void each (Func func) const
 Iterates all the entities that are still in use. More...
 
bool orphan (const entity_type entt) const
 Checks if an entity has components assigned. More...
 
template<typename Type >
auto on_construct ()
 Returns a sink object for the given component. More...
 
template<typename Type >
auto on_update ()
 Returns a sink object for the given component. More...
 
template<typename Type >
auto on_destroy ()
 Returns a sink object for the given component. More...
 
template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< const Type >, storage_for_type< const Other >... >, exclude_t< storage_for_type< const Exclude >... > > view (exclude_t< Exclude... >={}) const
 Returns a view for the given components. More...
 
template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< Type >, storage_for_type< Other >... >, exclude_t< storage_for_type< Exclude >... > > view (exclude_t< Exclude... >={})
 Returns a view for the given components. More...
 
template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< Owned >... >, get_t< storage_for_type< Get >... >, exclude_t< storage_for_type< Exclude >... > > group (get_t< Get... >={}, exclude_t< Exclude... >={})
 Returns a group for the given components. More...
 
template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< const Owned >... >, get_t< storage_for_type< const Get >... >, exclude_t< storage_for_type< const Exclude >... > > group_if_exists (get_t< Get... >={}, exclude_t< Exclude... >={}) const
 Returns a group for the given components. More...
 
template<typename... Type>
bool owned () const
 Checks whether the given components belong to any group. More...
 
template<typename... Owned, typename... Get, typename... Exclude>
bool sortable (const basic_group< owned_t< Owned... >, get_t< Get... >, exclude_t< Exclude... > > &) noexcept
 Checks whether a group can be sorted. More...
 
template<typename Type , typename Compare , typename Sort = std_sort, typename... Args>
void sort (Compare compare, Sort algo=Sort{}, Args &&...args)
 Sorts the elements of a given component. More...
 
template<typename To , typename From >
void sort ()
 Sorts two pools of components in the same way. More...
 
contextctx () noexcept
 Returns the context object, that is, a general purpose container. More...
 
const contextctx () const noexcept
 Returns the context object, that is, a general purpose container. More...
 

Detailed Description

template<typename Entity, typename Allocator>
class entt::basic_registry< Entity, Allocator >

Fast and reliable entity-component system.

Template Parameters
EntityA valid entity type (see entt_traits for more details).
AllocatorType of allocator used to manage memory and elements.

Definition at line 253 of file registry.hpp.

Member Typedef Documentation

◆ allocator_type

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::allocator_type = Allocator

Allocator type.

Definition at line 370 of file registry.hpp.

◆ base_type

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::base_type = basic_common_type

Common type among all storage types.

Definition at line 378 of file registry.hpp.

◆ context

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::context = internal::registry_context

Context type.

Definition at line 380 of file registry.hpp.

◆ entity_type

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::entity_type = Entity

Underlying entity identifier.

Definition at line 372 of file registry.hpp.

◆ size_type

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::size_type = std::size_t

Unsigned integer type.

Definition at line 376 of file registry.hpp.

◆ version_type

template<typename Entity , typename Allocator >
using entt::basic_registry< Entity, Allocator >::version_type = typename entity_traits::version_type

Underlying version type.

Definition at line 374 of file registry.hpp.

Constructor & Destructor Documentation

◆ basic_registry() [1/4]

template<typename Entity , typename Allocator >
entt::basic_registry< Entity, Allocator >::basic_registry ( )
inline

Default constructor.

Definition at line 383 of file registry.hpp.

◆ basic_registry() [2/4]

template<typename Entity , typename Allocator >
entt::basic_registry< Entity, Allocator >::basic_registry ( const allocator_type allocator)
inlineexplicit

Constructs an empty registry with a given allocator.

Parameters
allocatorThe allocator to use.

Definition at line 390 of file registry.hpp.

◆ basic_registry() [3/4]

template<typename Entity , typename Allocator >
entt::basic_registry< Entity, Allocator >::basic_registry ( const size_type  count,
const allocator_type allocator = allocator_type{} 
)
inline

Allocates enough memory upon construction to store count pools.

Parameters
countThe number of pools to allocate memory for.
allocatorThe allocator to use.

Definition at line 398 of file registry.hpp.

◆ basic_registry() [4/4]

template<typename Entity , typename Allocator >
entt::basic_registry< Entity, Allocator >::basic_registry ( basic_registry< Entity, Allocator > &&  other)
inlinenoexcept

Move constructor.

Parameters
otherThe instance to move from.

Definition at line 411 of file registry.hpp.

Member Function Documentation

◆ alive()

template<typename Entity , typename Allocator >
size_type entt::basic_registry< Entity, Allocator >::alive ( ) const
inline

Returns the number of entities still in use.

Returns
Number of entities still in use.

Definition at line 536 of file registry.hpp.

◆ all_of()

template<typename Entity , typename Allocator >
template<typename... Type>
bool entt::basic_registry< Entity, Allocator >::all_of ( const entity_type  entt) const
inline

Check if an entity is part of all the given storage.

Template Parameters
TypeType of storage to check for.
Parameters
enttA valid identifier.
Returns
True if the entity is part of all the storage, false otherwise.

Definition at line 1033 of file registry.hpp.

◆ any_of()

template<typename Entity , typename Allocator >
template<typename... Type>
bool entt::basic_registry< Entity, Allocator >::any_of ( const entity_type  entt) const
inline

Check if an entity is part of at least one given storage.

Template Parameters
TypeType of storage to check for.
Parameters
enttA valid identifier.
Returns
True if the entity is part of at least one storage, false otherwise.

Definition at line 1045 of file registry.hpp.

◆ assign()

template<typename Entity , typename Allocator >
template<typename It >
void entt::basic_registry< Entity, Allocator >::assign ( It  first,
It  last,
const entity_type  destroyed 
)
inline

Assigns identifiers to an empty registry.

This function is intended for use in conjunction with data, size and released.
Don't try to inject ranges of randomly generated entities nor the wrong head for the list of destroyed entities. There is no guarantee that a registry will continue to work properly in this case.

Warning
There must be no entities still alive for this to work properly.
Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
destroyedThe head of the list of destroyed entities.

Definition at line 701 of file registry.hpp.

◆ capacity()

template<typename Entity , typename Allocator >
size_type entt::basic_registry< Entity, Allocator >::capacity ( ) const
inlinenoexcept

Returns the number of entities that a registry has currently allocated space for.

Returns
Capacity of the registry.

Definition at line 559 of file registry.hpp.

◆ clear()

template<typename Entity , typename Allocator >
template<typename... Type>
void entt::basic_registry< Entity, Allocator >::clear ( )
inline

Clears a whole registry or the pools for the given components.

Template Parameters
TypeTypes of components to remove from their entities.

Definition at line 1138 of file registry.hpp.

◆ compact()

template<typename Entity , typename Allocator >
template<typename... Type>
void entt::basic_registry< Entity, Allocator >::compact ( )
inline

Removes all tombstones from a registry or only the pools for the given components.

Template Parameters
TypeTypes of components for which to clear all tombstones.

Definition at line 1016 of file registry.hpp.

◆ create() [1/3]

template<typename Entity , typename Allocator >
entity_type entt::basic_registry< Entity, Allocator >::create ( )
inline

Creates a new entity or recycles a destroyed one.

Returns
A valid identifier.

Definition at line 624 of file registry.hpp.

◆ create() [2/3]

template<typename Entity , typename Allocator >
entity_type entt::basic_registry< Entity, Allocator >::create ( const entity_type  hint)
inline

Creates a new entity or recycles a destroyed one.

If the requested entity isn't in use, the suggested identifier is used. Otherwise, a new identifier is generated.

Parameters
hintRequired identifier.
Returns
A valid identifier.

Definition at line 637 of file registry.hpp.

◆ create() [3/3]

template<typename Entity , typename Allocator >
template<typename It >
void entt::basic_registry< Entity, Allocator >::create ( It  first,
It  last 
)
inline

Assigns each element in a range an identifier.

See also
create
Template Parameters
ItType of forward iterator.
Parameters
firstAn iterator to the first element of the range to generate.
lastAn iterator past the last element of the range to generate.

Definition at line 670 of file registry.hpp.

◆ ctx() [1/2]

template<typename Entity , typename Allocator >
const context & entt::basic_registry< Entity, Allocator >::ctx ( ) const
inlinenoexcept

Returns the context object, that is, a general purpose container.

Returns
The context object, that is, a general purpose container.

Definition at line 1515 of file registry.hpp.

◆ ctx() [2/2]

template<typename Entity , typename Allocator >
context & entt::basic_registry< Entity, Allocator >::ctx ( )
inlinenoexcept

Returns the context object, that is, a general purpose container.

Returns
The context object, that is, a general purpose container.

Definition at line 1510 of file registry.hpp.

◆ current()

template<typename Entity , typename Allocator >
version_type entt::basic_registry< Entity, Allocator >::current ( const entity_type  entt) const
inline

Returns the actual version for an identifier.

Parameters
enttA valid identifier.
Returns
The version for the given identifier if valid, the tombstone version otherwise.

Definition at line 615 of file registry.hpp.

◆ data()

template<typename Entity , typename Allocator >
const entity_type * entt::basic_registry< Entity, Allocator >::data ( ) const
inlinenoexcept

Direct access to the list of entities of a registry.

The returned pointer is such that range [data(), data() + size()) is always a valid range, even if the registry is empty.

Warning
This list contains both valid and destroyed entities and isn't suitable for direct use.
Returns
A pointer to the array of entities.

Definition at line 583 of file registry.hpp.

◆ destroy() [1/3]

template<typename Entity , typename Allocator >
version_type entt::basic_registry< Entity, Allocator >::destroy ( const entity_type  entt)
inline

Destroys an entity and releases its identifier.

See also
release
Warning
Adding or removing components to an entity that is being destroyed can result in undefined behavior. Attempting to use an invalid entity results in undefined behavior.
Parameters
enttA valid identifier.
Returns
The version of the recycled entity.

Definition at line 769 of file registry.hpp.

◆ destroy() [2/3]

template<typename Entity , typename Allocator >
version_type entt::basic_registry< Entity, Allocator >::destroy ( const entity_type  entt,
const version_type  version 
)
inline

Destroys an entity and releases its identifier.

The suggested version or the valid version closest to the suggested one is used instead of the implicitly generated version.

See also
destroy
Parameters
enttA valid identifier.
versionA desired version upon destruction.
Returns
The version actually assigned to the entity.

Definition at line 785 of file registry.hpp.

◆ destroy() [3/3]

template<typename Entity , typename Allocator >
template<typename It >
void entt::basic_registry< Entity, Allocator >::destroy ( It  first,
It  last 
)
inline

Destroys all entities in a range and releases their identifiers.

See also
destroy
Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Definition at line 803 of file registry.hpp.

◆ each()

template<typename Entity , typename Allocator >
template<typename Func >
void entt::basic_registry< Entity, Allocator >::each ( Func  func) const
inline

Iterates all the entities that are still in use.

The signature of the function should be equivalent to the following:

void(const Entity);

It's not defined whether entities created during iteration are returned.

Template Parameters
FuncType of the function object to invoke.
Parameters
funcA valid function object.

Definition at line 1165 of file registry.hpp.

◆ emplace()

template<typename Entity , typename Allocator >
template<typename Type , typename... Args>
decltype(auto) entt::basic_registry< Entity, Allocator >::emplace ( const entity_type  entt,
Args &&...  args 
)
inline

Assigns the given component to an entity.

The component must have a proper constructor or be of aggregate type.

Warning
Attempting to assign a component to an entity that already owns it results in undefined behavior.
Template Parameters
TypeType of component to create.
ArgsTypes of arguments to use to construct the component.
Parameters
enttA valid identifier.
argsParameters to use to initialize the component.
Returns
A reference to the newly created component.

Definition at line 825 of file registry.hpp.

◆ emplace_or_replace()

template<typename Entity , typename Allocator >
template<typename Type , typename... Args>
decltype(auto) entt::basic_registry< Entity, Allocator >::emplace_or_replace ( const entity_type  entt,
Args &&...  args 
)
inline

Assigns or replaces the given component for an entity.

See also
emplace
replace
Template Parameters
TypeType of component to assign or replace.
ArgsTypes of arguments to use to construct the component.
Parameters
enttA valid identifier.
argsParameters to use to initialize the component.
Returns
A reference to the newly created component.

Definition at line 875 of file registry.hpp.

◆ empty()

template<typename Entity , typename Allocator >
bool entt::basic_registry< Entity, Allocator >::empty ( ) const
inline

Checks whether the registry is empty (no entities still in use).

Returns
True if the registry is empty, false otherwise.

Definition at line 567 of file registry.hpp.

◆ erase() [1/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other>
void entt::basic_registry< Entity, Allocator >::erase ( const entity_type  entt)
inline

Erases the given components from an entity.

Warning
Attempting to erase a component from an entity that doesn't own it results in undefined behavior.
Template Parameters
TypeTypes of components to erase.
OtherOther types of components to erase.
Parameters
enttA valid identifier.

Definition at line 984 of file registry.hpp.

◆ erase() [2/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other, typename It >
void entt::basic_registry< Entity, Allocator >::erase ( It  first,
It  last 
)
inline

Erases the given components from all the entities in a range.

See also
erase
Template Parameters
TypeTypes of components to erase.
OtherOther types of components to erase.
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Definition at line 1000 of file registry.hpp.

◆ get() [1/2]

template<typename Entity , typename Allocator >
template<typename... Type>
decltype(auto) entt::basic_registry< Entity, Allocator >::get ( const entity_type  entt)
inline

Returns references to the given components for an entity.

Warning
Attempting to get a component from an entity that doesn't own it results in undefined behavior.
Template Parameters
TypeTypes of components to get.
Parameters
enttA valid identifier.
Returns
References to the components owned by the entity.

Definition at line 1071 of file registry.hpp.

◆ get() [2/2]

template<typename Entity , typename Allocator >
template<typename... Type>
decltype(auto) entt::basic_registry< Entity, Allocator >::get ( const entity_type  entt) const
inline

Returns references to the given components for an entity.

Warning
Attempting to get a component from an entity that doesn't own it results in undefined behavior.
Template Parameters
TypeTypes of components to get.
Parameters
enttA valid identifier.
Returns
References to the components owned by the entity.

Definition at line 1061 of file registry.hpp.

◆ get_allocator()

template<typename Entity , typename Allocator >
constexpr allocator_type entt::basic_registry< Entity, Allocator >::get_allocator ( ) const
inlineconstexprnoexcept

Returns the associated allocator.

Returns
The associated allocator.

Definition at line 457 of file registry.hpp.

◆ get_or_emplace()

template<typename Entity , typename Allocator >
template<typename Type , typename... Args>
decltype(auto) entt::basic_registry< Entity, Allocator >::get_or_emplace ( const entity_type  entt,
Args &&...  args 
)
inline

Returns a reference to the given component for an entity.

In case the entity doesn't own the component, the parameters provided are used to construct it.

See also
get
emplace
Template Parameters
TypeType of component to get.
ArgsTypes of arguments to use to construct the component.
Parameters
enttA valid identifier.
argsParameters to use to initialize the component.
Returns
Reference to the component owned by the entity.

Definition at line 1095 of file registry.hpp.

◆ group()

template<typename Entity , typename Allocator >
template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< Owned >... >, get_t< storage_for_type< Get >... >, exclude_t< storage_for_type< Exclude >... > > entt::basic_registry< Entity, Allocator >::group ( get_t< Get... >  = {},
exclude_t< Exclude... >  = {} 
)
inline

Returns a group for the given components.

Groups are created on the fly and share with the registry its internal data structures. Feel free to discard them after the use.
Creating and destroying a group is an incredibly cheap operation. As a rule of thumb, storing a group should never be an option.

Groups support exclusion lists and can own types of components. The more types are owned by a group, the faster it is to iterate entities and components.
However, groups also affect some features of the registry such as the creation and destruction of components.

Note
Pools of components that are owned by a group cannot be sorted anymore. The group takes the ownership of the pools and arrange components so as to iterate them as fast as possible.
Template Parameters
OwnedType of storage owned by the group.
GetType of storage observed by the group.
ExcludeType of storage used to filter the group.
Returns
A newly created group.

Definition at line 1309 of file registry.hpp.

◆ group_if_exists()

template<typename Entity , typename Allocator >
template<typename... Owned, typename... Get, typename... Exclude>
basic_group< owned_t< storage_for_type< const Owned >... >, get_t< storage_for_type< const Get >... >, exclude_t< storage_for_type< const Exclude >... > > entt::basic_registry< Entity, Allocator >::group_if_exists ( get_t< Get... >  = {},
exclude_t< Exclude... >  = {} 
) const
inline

Returns a group for the given components.

Groups are created on the fly and share with the registry its internal data structures. Feel free to discard them after the use.
Creating and destroying a group is an incredibly cheap operation. As a rule of thumb, storing a group should never be an option.

Groups support exclusion lists and can own types of components. The more types are owned by a group, the faster it is to iterate entities and components.
However, groups also affect some features of the registry such as the creation and destruction of components.

Note
Pools of components that are owned by a group cannot be sorted anymore. The group takes the ownership of the pools and arrange components so as to iterate them as fast as possible.
Template Parameters
OwnedType of storage owned by the group.
GetType of storage observed by the group.
ExcludeType of storage used to filter the group.
Returns
A newly created group.

Definition at line 1392 of file registry.hpp.

◆ insert() [1/2]

template<typename Entity , typename Allocator >
template<typename Type , typename EIt , typename CIt , typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>>
void entt::basic_registry< Entity, Allocator >::insert ( EIt  first,
EIt  last,
CIt  from 
)
inline

Assigns each entity in a range the given components.

See also
emplace
Template Parameters
TypeType of component to create.
EItType of input iterator.
CItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
fromAn iterator to the first element of the range of components.

Definition at line 858 of file registry.hpp.

◆ insert() [2/2]

template<typename Entity , typename Allocator >
template<typename Type , typename It >
void entt::basic_registry< Entity, Allocator >::insert ( It  first,
It  last,
const Type &  value = {} 
)
inline

Assigns each entity in a range the given component.

See also
emplace
Template Parameters
TypeType of component to create.
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
valueAn instance of the component to assign.

Definition at line 841 of file registry.hpp.

◆ on_construct()

template<typename Entity , typename Allocator >
template<typename Type >
auto entt::basic_registry< Entity, Allocator >::on_construct ( )
inline

Returns a sink object for the given component.

Use this function to receive notifications whenever a new instance of the given component is created and assigned to an entity.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);
Fast and reliable entity-component system.
Definition: registry.hpp:253

Listeners are invoked after assigning the component to the entity.

See also
sink
Template Parameters
TypeType of component of which to get the sink.
Returns
A temporary sink object.

Definition at line 1207 of file registry.hpp.

◆ on_destroy()

template<typename Entity , typename Allocator >
template<typename Type >
auto entt::basic_registry< Entity, Allocator >::on_destroy ( )
inline

Returns a sink object for the given component.

Use this function to receive notifications whenever an instance of the given component is removed from an entity and thus destroyed.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);

Listeners are invoked before removing the component from the entity.

See also
sink
Template Parameters
TypeType of component of which to get the sink.
Returns
A temporary sink object.

Definition at line 1253 of file registry.hpp.

◆ on_update()

template<typename Entity , typename Allocator >
template<typename Type >
auto entt::basic_registry< Entity, Allocator >::on_update ( )
inline

Returns a sink object for the given component.

Use this function to receive notifications whenever an instance of the given component is explicitly updated.
The function type for a listener is equivalent to:

void(basic_registry<Entity> &, Entity);

Listeners are invoked after updating the component.

See also
sink
Template Parameters
TypeType of component of which to get the sink.
Returns
A temporary sink object.

Definition at line 1230 of file registry.hpp.

◆ operator=()

template<typename Entity , typename Allocator >
basic_registry & entt::basic_registry< Entity, Allocator >::operator= ( basic_registry< Entity, Allocator > &&  other)
inlinenoexcept

Move assignment operator.

Parameters
otherThe instance to move from.
Returns
This registry.

Definition at line 425 of file registry.hpp.

◆ orphan()

template<typename Entity , typename Allocator >
bool entt::basic_registry< Entity, Allocator >::orphan ( const entity_type  entt) const
inline

Checks if an entity has components assigned.

Parameters
enttA valid identifier.
Returns
True if the entity has no components assigned, false otherwise.

Definition at line 1184 of file registry.hpp.

◆ owned()

template<typename Entity , typename Allocator >
template<typename... Type>
bool entt::basic_registry< Entity, Allocator >::owned ( ) const
inline

Checks whether the given components belong to any group.

Template Parameters
ComponentTypes of components in which one is interested.
Returns
True if the pools of the given components are free, false otherwise.

Definition at line 1415 of file registry.hpp.

◆ patch()

template<typename Entity , typename Allocator >
template<typename Type , typename... Func>
decltype(auto) entt::basic_registry< Entity, Allocator >::patch ( const entity_type  entt,
Func &&...  func 
)
inline

Patches the given component for an entity.

The signature of the function should be equivalent to the following:

void(Type &);
Note
Empty types aren't explicitly instantiated and therefore they are never returned. However, this function can be used to trigger an update signal for them.
Warning
Attempting to to patch a component of an entity that doesn't own it results in undefined behavior.
Template Parameters
TypeType of component to patch.
FuncTypes of the function objects to invoke.
Parameters
enttA valid identifier.
funcValid function objects.
Returns
A reference to the patched component.

Definition at line 908 of file registry.hpp.

◆ release() [1/3]

template<typename Entity , typename Allocator >
version_type entt::basic_registry< Entity, Allocator >::release ( const entity_type  entt)
inline

Releases an identifier.

The version is updated and the identifier can be recycled at any time.

Warning
Attempting to use an invalid entity results in undefined behavior.
Parameters
enttA valid identifier.
Returns
The version of the recycled entity.

Definition at line 718 of file registry.hpp.

◆ release() [2/3]

template<typename Entity , typename Allocator >
version_type entt::basic_registry< Entity, Allocator >::release ( const entity_type  entt,
const version_type  version 
)
inline

Releases an identifier.

The suggested version or the valid version closest to the suggested one is used instead of the implicitly generated version.

See also
release
Parameters
enttA valid identifier.
versionA desired version upon destruction.
Returns
The version actually assigned to the entity.

Definition at line 734 of file registry.hpp.

◆ release() [3/3]

template<typename Entity , typename Allocator >
template<typename It >
void entt::basic_registry< Entity, Allocator >::release ( It  first,
It  last 
)
inline

Releases all identifiers in a range.

See also
release
Template Parameters
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.

Definition at line 750 of file registry.hpp.

◆ released()

template<typename Entity , typename Allocator >
entity_type entt::basic_registry< Entity, Allocator >::released ( ) const
inlinenoexcept

Returns the head of the list of released entities.

This function is intended for use in conjunction with assign.
The returned entity has an invalid identifier in all cases.

Returns
The head of the list of released entities.

Definition at line 595 of file registry.hpp.

◆ remove() [1/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other>
size_type entt::basic_registry< Entity, Allocator >::remove ( const entity_type  entt)
inline

Removes the given components from an entity.

Template Parameters
TypeType of component to remove.
OtherOther types of components to remove.
Parameters
enttA valid identifier.
Returns
The number of components actually removed.

Definition at line 941 of file registry.hpp.

◆ remove() [2/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other, typename It >
size_type entt::basic_registry< Entity, Allocator >::remove ( It  first,
It  last 
)
inline

Removes the given components from all the entities in a range.

See also
remove
Template Parameters
TypeType of component to remove.
OtherOther types of components to remove.
ItType of input iterator.
Parameters
firstAn iterator to the first element of the range of entities.
lastAn iterator past the last element of the range of entities.
Returns
The number of components actually removed.

Definition at line 958 of file registry.hpp.

◆ replace()

template<typename Entity , typename Allocator >
template<typename Type , typename... Args>
decltype(auto) entt::basic_registry< Entity, Allocator >::replace ( const entity_type  entt,
Args &&...  args 
)
inline

Replaces the given component for an entity.

The component must have a proper constructor or be of aggregate type.

Warning
Attempting to replace a component of an entity that doesn't own it results in undefined behavior.
Template Parameters
TypeType of component to replace.
ArgsTypes of arguments to use to construct the component.
Parameters
enttA valid identifier.
argsParameters to use to initialize the component.
Returns
A reference to the component being replaced.

Definition at line 928 of file registry.hpp.

◆ reserve()

template<typename Entity , typename Allocator >
void entt::basic_registry< Entity, Allocator >::reserve ( const size_type  cap)
inline

Increases the capacity (number of entities) of the registry.

Parameters
capDesired capacity.

Definition at line 550 of file registry.hpp.

◆ size()

template<typename Entity , typename Allocator >
size_type entt::basic_registry< Entity, Allocator >::size ( ) const
inlinenoexcept

Returns the number of entities created so far.

Returns
Number of entities created so far.

Definition at line 528 of file registry.hpp.

◆ sort() [1/2]

template<typename Entity , typename Allocator >
template<typename To , typename From >
void entt::basic_registry< Entity, Allocator >::sort ( )
inline

Sorts two pools of components in the same way.

Being To and From the two sets, after invoking this function an iterator for To returns elements according to the following rules:

  • All entities in To that are also in From are returned first according to the order they have in From.
  • All entities in To that are not in From are returned in no particular order after all the other entities.

Any subsequent change to From won't affect the order in To.

Warning
Pools of components owned by a group cannot be sorted.
Template Parameters
ToType of components to sort.
FromType of components to use to sort.

Definition at line 1501 of file registry.hpp.

◆ sort() [2/2]

template<typename Entity , typename Allocator >
template<typename Type , typename Compare , typename Sort = std_sort, typename... Args>
void entt::basic_registry< Entity, Allocator >::sort ( Compare  compare,
Sort  algo = Sort{},
Args &&...  args 
)
inline

Sorts the elements of a given component.

The order remains valid until a component of the given type is assigned to or removed from an entity.
The comparison function object returns true if the first element is less than the second one, false otherwise. Its signature is also equivalent to one of the following:

bool(const Entity, const Entity);
bool(const Type &, const Type &);

Moreover, it shall induce a strict weak ordering on the values.
The sort function object offers an operator() that accepts:

  • An iterator to the first element of the range to sort.
  • An iterator past the last element of the range to sort.
  • A comparison function object to use to compare the elements.

The comparison function object hasn't necessarily the type of the one passed along with the other parameters to this member function.

Warning
Pools of components owned by a group cannot be sorted.
Template Parameters
TypeType of components to sort.
CompareType of comparison function object.
SortType of sort function object.
ArgsTypes of arguments to forward to the sort function object.
Parameters
compareA valid comparison function object.
algoA valid sort function object.
argsArguments to forward to the sort function object, if any.

Definition at line 1469 of file registry.hpp.

◆ sortable()

template<typename Entity , typename Allocator >
template<typename... Owned, typename... Get, typename... Exclude>
bool entt::basic_registry< Entity, Allocator >::sortable ( const basic_group< owned_t< Owned... >, get_t< Get... >, exclude_t< Exclude... > > &  )
inlinenoexcept

Checks whether a group can be sorted.

Template Parameters
OwnedType of storage owned by the group.
GetType of storage observed by the group.
ExcludeType of storage used to filter the group.
Returns
True if the group can be sorted, false otherwise.

Definition at line 1427 of file registry.hpp.

◆ storage() [1/6]

template<typename Entity , typename Allocator >
auto entt::basic_registry< Entity, Allocator >::storage ( ) const
inlinenoexcept

Returns an iterable object to use to visit a registry.

The iterable object returns a pair that contains the name and a reference to the current storage.

Returns
An iterable object to use to visit the registry.

Definition at line 474 of file registry.hpp.

◆ storage() [2/6]

template<typename Entity , typename Allocator >
auto entt::basic_registry< Entity, Allocator >::storage ( )
inlinenoexcept

Returns an iterable object to use to visit a registry.

The iterable object returns a pair that contains the name and a reference to the current storage.

Returns
An iterable object to use to visit the registry.

Definition at line 469 of file registry.hpp.

◆ storage() [3/6]

template<typename Entity , typename Allocator >
base_type * entt::basic_registry< Entity, Allocator >::storage ( const id_type  id)
inline

Finds the storage associated with a given name, if any.

Parameters
idName used to map the storage within the registry.
Returns
A pointer to the storage if it exists, a null pointer otherwise.

Definition at line 483 of file registry.hpp.

◆ storage() [4/6]

template<typename Entity , typename Allocator >
const base_type * entt::basic_registry< Entity, Allocator >::storage ( const id_type  id) const
inline

Finds the storage associated with a given name, if any.

Parameters
idName used to map the storage within the registry.
Returns
A pointer to the storage if it exists, a null pointer otherwise.

Definition at line 492 of file registry.hpp.

◆ storage() [5/6]

template<typename Entity , typename Allocator >
template<typename Type >
decltype(auto) entt::basic_registry< Entity, Allocator >::storage ( const id_type  id = type_hash<Type>::value())
inline

Returns the storage for a given component type.

Template Parameters
TypeType of component of which to return the storage.
Parameters
idOptional name used to map the storage within the registry.
Returns
The storage for the given component type.

Definition at line 504 of file registry.hpp.

◆ storage() [6/6]

template<typename Entity , typename Allocator >
template<typename Type >
decltype(auto) entt::basic_registry< Entity, Allocator >::storage ( const id_type  id = type_hash<Type>::value()) const
inline

Returns the storage for a given component type.

Warning
If a storage for the given component doesn't exist yet, a temporary placeholder is returned instead.
Template Parameters
TypeType of component of which to return the storage.
Parameters
idOptional name used to map the storage within the registry.
Returns
The storage for the given component type.

Definition at line 520 of file registry.hpp.

◆ swap()

template<typename Entity , typename Allocator >
void entt::basic_registry< Entity, Allocator >::swap ( basic_registry< Entity, Allocator > &  other)
inline

Exchanges the contents with those of a given registry.

Parameters
otherRegistry to exchange the content with.

Definition at line 441 of file registry.hpp.

◆ try_get() [1/2]

template<typename Entity , typename Allocator >
template<typename... Type>
auto entt::basic_registry< Entity, Allocator >::try_get ( const entity_type  entt)
inline

Returns pointers to the given components for an entity.

Note
The registry retains ownership of the pointed-to components.
Template Parameters
TypeTypes of components to get.
Parameters
enttA valid identifier.
Returns
Pointers to the components owned by the entity.

Definition at line 1125 of file registry.hpp.

◆ try_get() [2/2]

template<typename Entity , typename Allocator >
template<typename... Type>
auto entt::basic_registry< Entity, Allocator >::try_get ( const entity_type  entt) const
inline

Returns pointers to the given components for an entity.

Note
The registry retains ownership of the pointed-to components.
Template Parameters
TypeTypes of components to get.
Parameters
enttA valid identifier.
Returns
Pointers to the components owned by the entity.

Definition at line 1114 of file registry.hpp.

◆ valid()

template<typename Entity , typename Allocator >
bool entt::basic_registry< Entity, Allocator >::valid ( const entity_type  entt) const
inline

Checks if an identifier refers to a valid entity.

Parameters
enttAn identifier, either valid or not.
Returns
True if the identifier is valid, false otherwise.

Definition at line 604 of file registry.hpp.

◆ view() [1/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< Type >, storage_for_type< Other >... >, exclude_t< storage_for_type< Exclude >... > > entt::basic_registry< Entity, Allocator >::view ( exclude_t< Exclude... >  = {})
inline

Returns a view for the given components.

Views are created on the fly and share with the registry its internal data structures. Feel free to discard them after the use.
Creating and destroying a view is an incredibly cheap operation. As a rule of thumb, storing a view should never be an option.

Template Parameters
TypeType of component used to construct the view.
OtherOther types of components used to construct the view.
ExcludeTypes of components used to filter the view.
Returns
A newly created view.

Definition at line 1279 of file registry.hpp.

◆ view() [2/2]

template<typename Entity , typename Allocator >
template<typename Type , typename... Other, typename... Exclude>
basic_view< get_t< storage_for_type< const Type >, storage_for_type< const Other >... >, exclude_t< storage_for_type< const Exclude >... > > entt::basic_registry< Entity, Allocator >::view ( exclude_t< Exclude... >  = {}) const
inline

Returns a view for the given components.

Views are created on the fly and share with the registry its internal data structures. Feel free to discard them after the use.
Creating and destroying a view is an incredibly cheap operation. As a rule of thumb, storing a view should never be an option.

Template Parameters
TypeType of component used to construct the view.
OtherOther types of components used to construct the view.
ExcludeTypes of components used to filter the view.
Returns
A newly created view.

Definition at line 1272 of file registry.hpp.


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