|
EnTT 3.13.2
|
Basic storage implementation. More...
#include <storage.hpp>


Public Types | |
| using | base_type = underlying_type |
| Base type. | |
| using | value_type = Type |
| Type of the objects assigned to entities. | |
| using | traits_type = component_traits<value_type> |
| Component traits. | |
| using | entity_type = Entity |
| Underlying entity identifier. | |
| using | size_type = std::size_t |
| Unsigned integer type. | |
| using | allocator_type = Allocator |
| Allocator type. | |
| using | pointer = typename container_type::pointer |
| Pointer type to contained elements. | |
| using | const_pointer = typename alloc_traits::template rebind_traits<typename alloc_traits::const_pointer>::const_pointer |
| Constant pointer type to contained elements. | |
| using | iterator = internal::storage_iterator<container_type, traits_type::page_size> |
| Random access iterator type. | |
| using | const_iterator = internal::storage_iterator<const container_type, traits_type::page_size> |
| Constant random access iterator type. | |
| using | reverse_iterator = std::reverse_iterator<iterator> |
| Reverse iterator type. | |
| using | const_reverse_iterator = std::reverse_iterator<const_iterator> |
| Constant reverse iterator type. | |
| using | iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::iterator, iterator>> |
| Extended iterable storage proxy. | |
| using | const_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::const_iterator, const_iterator>> |
| Constant extended iterable storage proxy. | |
| using | reverse_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::reverse_iterator, reverse_iterator>> |
| Extended reverse iterable storage proxy. | |
| using | const_reverse_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::const_reverse_iterator, const_reverse_iterator>> |
| Constant extended reverse iterable storage proxy. | |
Public Types inherited from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > > | |
| using | traits_type |
| Entity traits. | |
| using | entity_type |
| Underlying entity identifier. | |
| using | version_type |
| Underlying version type. | |
| using | size_type |
| Unsigned integer type. | |
| using | allocator_type |
| Allocator type. | |
| using | pointer |
| Pointer type to contained entities. | |
| using | iterator |
| Random access iterator type. | |
| using | const_iterator |
| Constant random access iterator type. | |
| using | reverse_iterator |
| Reverse iterator type. | |
| using | const_reverse_iterator |
| Constant reverse iterator type. | |
Public Member Functions | |
| basic_storage () | |
| Default constructor. | |
| basic_storage (const allocator_type &allocator) | |
| Constructs an empty storage with a given allocator. | |
| basic_storage (basic_storage &&other) noexcept | |
| Move constructor. | |
| basic_storage (basic_storage &&other, const allocator_type &allocator) noexcept | |
| Allocator-extended move constructor. | |
| ~basic_storage () override | |
| Default destructor. | |
| basic_storage & | operator= (basic_storage &&other) noexcept |
| Move assignment operator. | |
| void | swap (basic_storage &other) |
| Exchanges the contents with those of a given storage. | |
| constexpr allocator_type | get_allocator () const noexcept |
| Returns the associated allocator. | |
| void | reserve (const size_type cap) override |
| Increases the capacity of a storage. | |
| size_type | capacity () const noexcept override |
| Returns the number of elements that a storage has currently allocated space for. | |
| void | shrink_to_fit () override |
| Requests the removal of unused capacity. | |
| const_pointer | raw () const noexcept |
| Direct access to the array of objects. | |
| pointer | raw () noexcept |
| Direct access to the array of objects. | |
| const_iterator | cbegin () const noexcept |
| Returns an iterator to the beginning. | |
| const_iterator | begin () const noexcept |
| Returns an iterator to the beginning. | |
| iterator | begin () noexcept |
| Returns an iterator to the beginning. | |
| const_iterator | cend () const noexcept |
| Returns an iterator to the end. | |
| const_iterator | end () const noexcept |
| Returns an iterator to the end. | |
| iterator | end () noexcept |
| Returns an iterator to the end. | |
| const_reverse_iterator | crbegin () const noexcept |
| Returns a reverse iterator to the beginning. | |
| const_reverse_iterator | rbegin () const noexcept |
| Returns a reverse iterator to the beginning. | |
| reverse_iterator | rbegin () noexcept |
| Returns a reverse iterator to the beginning. | |
| const_reverse_iterator | crend () const noexcept |
| Returns a reverse iterator to the end. | |
| const_reverse_iterator | rend () const noexcept |
| Returns a reverse iterator to the end. | |
| reverse_iterator | rend () noexcept |
| Returns a reverse iterator to the end. | |
| const value_type & | get (const entity_type entt) const noexcept |
| Returns the object assigned to an entity. | |
| value_type & | get (const entity_type entt) noexcept |
| Returns the object assigned to an entity. | |
| std::tuple< const value_type & > | get_as_tuple (const entity_type entt) const noexcept |
| Returns the object assigned to an entity as a tuple. | |
| std::tuple< value_type & > | get_as_tuple (const entity_type entt) noexcept |
| Returns the object assigned to an entity as a tuple. | |
| template<typename... Args> | |
| value_type & | emplace (const entity_type entt, Args &&...args) |
| Assigns an entity to a storage and constructs its object. | |
| template<typename... Func> | |
| value_type & | patch (const entity_type entt, Func &&...func) |
| Updates the instance assigned to a given entity in-place. | |
| template<typename It > | |
| iterator | insert (It first, It last, const value_type &value={}) |
| Assigns one or more entities to a storage and constructs their objects from a given instance. | |
| template<typename EIt , typename CIt , typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, value_type>>> | |
| iterator | insert (EIt first, EIt last, CIt from) |
| Assigns one or more entities to a storage and constructs their objects from a given range. | |
| iterable | each () noexcept |
| Returns an iterable object to use to visit a storage. | |
| const_iterable | each () const noexcept |
| Returns an iterable object to use to visit a storage. | |
| reverse_iterable | reach () noexcept |
| Returns a reverse iterable object to use to visit a storage. | |
| const_reverse_iterable | reach () const noexcept |
| Returns a reverse iterable object to use to visit a storage. | |
Public Member Functions inherited from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > > | |
| basic_sparse_set () | |
| Default constructor. | |
| basic_sparse_set (const allocator_type &allocator) | |
| Constructs an empty container with a given allocator. | |
| basic_sparse_set (deletion_policy pol, const allocator_type &allocator={}) | |
| Constructs an empty container with the given policy and allocator. | |
| basic_sparse_set (const type_info &elem, deletion_policy pol=deletion_policy::swap_and_pop, const allocator_type &allocator={}) | |
| Constructs an empty container with the given value type, policy and allocator. | |
| basic_sparse_set (basic_sparse_set &&other) noexcept | |
| Move constructor. | |
| basic_sparse_set (basic_sparse_set &&other, const allocator_type &allocator) noexcept | |
| Allocator-extended move constructor. | |
| virtual | ~basic_sparse_set () |
| Default destructor. | |
| basic_sparse_set & | operator= (basic_sparse_set &&other) noexcept |
| Move assignment operator. | |
| void | swap (basic_sparse_set &other) |
| Exchanges the contents with those of a given sparse set. | |
| constexpr allocator_type | get_allocator () const noexcept |
| Returns the associated allocator. | |
| deletion_policy | policy () const noexcept |
| Returns the deletion policy of a sparse set. | |
| size_type | free_list () const noexcept |
| Returns the head of the free list, if any. | |
| void | free_list (const size_type len) noexcept |
| Sets the head of the free list, if possible. | |
| size_type | extent () const noexcept |
| Returns the extent of a sparse set. | |
| size_type | size () const noexcept |
| Returns the number of elements in a sparse set. | |
| bool | empty () const noexcept |
| Checks whether a sparse set is empty. | |
| bool | contiguous () const noexcept |
| Checks whether a sparse set is fully packed. | |
| pointer | data () const noexcept |
| Direct access to the internal packed array. | |
| iterator | begin () const noexcept |
| Returns an iterator to the beginning. | |
| iterator | begin (int) const noexcept |
| Returns an iterator to the beginning. Useful only in case of swap-only policy. | |
| const_iterator | cbegin () const noexcept |
| Returns an iterator to the beginning. | |
| const_iterator | cbegin (int) const noexcept |
| Returns an iterator to the beginning. Useful only in case of swap-only policy. | |
| iterator | end () const noexcept |
| Returns an iterator to the end. | |
| iterator | end (int) const noexcept |
| Returns an iterator to the end. Useful only in case of swap-only policy. | |
| const_iterator | cend () const noexcept |
| Returns an iterator to the end. | |
| const_iterator | cend (int) const noexcept |
| Returns an iterator to the end. Useful only in case of swap-only policy. | |
| reverse_iterator | rbegin () const noexcept |
| Returns a reverse iterator to the beginning. | |
| reverse_iterator | rbegin (int) const noexcept |
| Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
| const_reverse_iterator | crbegin () const noexcept |
| Returns a reverse iterator to the beginning. | |
| const_reverse_iterator | crbegin (int) const noexcept |
| Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
| reverse_iterator | rend () const noexcept |
| Returns a reverse iterator to the end. | |
| reverse_iterator | rend (int) const noexcept |
| Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
| const_reverse_iterator | crend () const noexcept |
| Returns a reverse iterator to the end. | |
| const_reverse_iterator | crend (int) const noexcept |
| Returns a reverse iterator to the beginning. Useful only in case of swap-only policy. | |
| const_iterator | find (const entity_type entt) const noexcept |
| Finds an entity. | |
| bool | contains (const entity_type entt) const noexcept |
| Checks if a sparse set contains an entity. | |
| version_type | current (const entity_type entt) const noexcept |
| Returns the contained version for an identifier. | |
| size_type | index (const entity_type entt) const noexcept |
| Returns the position of an entity in a sparse set. | |
| entity_type | at (const size_type pos) const noexcept |
| Returns the entity at specified location, with bounds checking. | |
| entity_type | operator[] (const size_type pos) const noexcept |
| Returns the entity at specified location, without bounds checking. | |
| const void * | value (const entity_type entt) const noexcept |
| Returns the element assigned to an entity, if any. | |
| void * | value (const entity_type entt) noexcept |
| Returns the element assigned to an entity, if any. | |
| iterator | push (const entity_type entt, const void *elem=nullptr) |
| Assigns an entity to a sparse set. | |
| iterator | push (It first, It last) |
| Assigns one or more entities to a sparse set. | |
| version_type | bump (const entity_type entt) |
| Bump the version number of an entity. | |
| void | erase (const entity_type entt) |
| Erases an entity from a sparse set. | |
| void | erase (It first, It last) |
| Erases entities from a set. | |
| bool | remove (const entity_type entt) |
| Removes an entity from a sparse set if it exists. | |
| size_type | remove (It first, It last) |
| Removes entities from a sparse set if they exist. | |
| void | compact () |
| Removes all tombstones from a sparse set. | |
| void | swap_elements (const entity_type lhs, const entity_type rhs) |
| Swaps two entities in a sparse set. | |
| void | sort_n (const size_type length, Compare compare, Sort algo=Sort{}, Args &&...args) |
| Sort the first count elements according to the given comparison function. | |
| void | sort (Compare compare, Sort algo=Sort{}, Args &&...args) |
| Sort all elements according to the given comparison function. | |
| void | sort_as (It first, It last) |
| Sort entities according to their order in a range. | |
| void | sort_as (const basic_sparse_set &other) |
| Sort entities according to their order in a range. | |
| void | clear () |
| Clears a sparse set. | |
| const type_info & | type () const noexcept |
| Returned value type, if any. | |
| virtual void | bind (any) noexcept |
| Forwards variables to derived classes, if any. | |
Protected Member Functions | |
| void | pop (underlying_iterator first, underlying_iterator last) override |
| Erases entities from a storage. | |
| void | pop_all () override |
| Erases all entities of a storage. | |
| underlying_iterator | try_emplace (const Entity entt, const bool force_back, const void *value) override |
| Assigns an entity to a storage. | |
Protected Member Functions inherited from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > > | |
| void | swap_only (const basic_iterator it) |
| Erases an entity from a sparse set. | |
| void | swap_and_pop (const basic_iterator it) |
| Erases an entity from a sparse set. | |
| void | in_place_pop (const basic_iterator it) |
| Erases an entity from a sparse set. | |
Additional Inherited Members | |
Protected Types inherited from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > > | |
| using | basic_iterator |
| Random access iterator type. | |
Basic storage implementation.
Internal data structures arrange elements to maximize performance. There are no guarantees that objects are returned in the insertion order when iterate a storage. Do not make assumption on the order in any case.
| Type | Type of objects assigned to the entities. |
| Entity | A valid entity type. |
| Allocator | Type of allocator used to manage memory and elements. |
Definition at line 229 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::allocator_type = Allocator |
Allocator type.
Definition at line 402 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::base_type = underlying_type |
Base type.
Definition at line 392 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::const_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::const_iterator, const_iterator>> |
Constant extended iterable storage proxy.
Definition at line 418 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::const_iterator = internal::storage_iterator<const container_type, traits_type::page_size> |
Constant random access iterator type.
Definition at line 410 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::const_pointer = typename alloc_traits::template rebind_traits<typename alloc_traits::const_pointer>::const_pointer |
Constant pointer type to contained elements.
Definition at line 406 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::const_reverse_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::const_reverse_iterator, const_reverse_iterator>> |
Constant extended reverse iterable storage proxy.
Definition at line 422 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::const_reverse_iterator = std::reverse_iterator<const_iterator> |
Constant reverse iterator type.
Definition at line 414 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::entity_type = Entity |
Underlying entity identifier.
Definition at line 398 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::iterator, iterator>> |
Extended iterable storage proxy.
Definition at line 416 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::iterator = internal::storage_iterator<container_type, traits_type::page_size> |
Random access iterator type.
Definition at line 408 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::pointer = typename container_type::pointer |
Pointer type to contained elements.
Definition at line 404 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::reverse_iterable = iterable_adaptor<internal::extended_storage_iterator<typename base_type::reverse_iterator, reverse_iterator>> |
Extended reverse iterable storage proxy.
Definition at line 420 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::reverse_iterator = std::reverse_iterator<iterator> |
Reverse iterator type.
Definition at line 412 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::size_type = std::size_t |
Unsigned integer type.
Definition at line 400 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::traits_type = component_traits<value_type> |
Component traits.
Definition at line 396 of file storage.hpp.
| using entt::basic_storage< Type, Entity, Allocator, typename >::value_type = Type |
Type of the objects assigned to entities.
Definition at line 394 of file storage.hpp.
|
inline |
Default constructor.
Definition at line 425 of file storage.hpp.
|
inlineexplicit |
Constructs an empty storage with a given allocator.
| allocator | The allocator to use. |
Definition at line 432 of file storage.hpp.
|
inlinenoexcept |
Move constructor.
| other | The instance to move from. |
Definition at line 440 of file storage.hpp.
|
inlinenoexcept |
Allocator-extended move constructor.
| other | The instance to move from. |
| allocator | The allocator to use. |
Definition at line 449 of file storage.hpp.
|
inlineoverride |
Default destructor.
Definition at line 456 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning.
If the storage is empty, the returned iterator will be equal to end().
Definition at line 548 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning.
If the storage is empty, the returned iterator will be equal to end().
Definition at line 553 of file storage.hpp.
|
inlineoverridevirtualnoexcept |
Returns the number of elements that a storage has currently allocated space for.
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 512 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the beginning.
If the storage is empty, the returned iterator will be equal to end().
Definition at line 542 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the end.
Definition at line 563 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning.
If the storage is empty, the returned iterator will be equal to rend().
Definition at line 584 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the end.
Definition at line 603 of file storage.hpp.
|
inlinenoexcept |
Returns an iterable object to use to visit a storage.
The iterable object returns a tuple that contains the current entity and a reference to its component.
Definition at line 746 of file storage.hpp.
|
inlinenoexcept |
Returns an iterable object to use to visit a storage.
The iterable object returns a tuple that contains the current entity and a reference to its component.
Definition at line 741 of file storage.hpp.
|
inline |
Assigns an entity to a storage and constructs its object.
| Args | Types of arguments to use to construct the object. |
| entt | A valid identifier. |
| args | Parameters to use to construct an object for the entity. |
Definition at line 663 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the end.
Definition at line 568 of file storage.hpp.
|
inlinenoexcept |
Returns an iterator to the end.
Definition at line 573 of file storage.hpp.
|
inlinenoexcept |
Returns the object assigned to an entity.
| entt | A valid identifier. |
Definition at line 627 of file storage.hpp.
|
inlinenoexcept |
Returns the object assigned to an entity.
| entt | A valid identifier. |
Definition at line 632 of file storage.hpp.
|
inlineconstexprnoexcept |
Returns the associated allocator.
Definition at line 488 of file storage.hpp.
|
inlinenoexcept |
Returns the object assigned to an entity as a tuple.
| entt | A valid identifier. |
Definition at line 641 of file storage.hpp.
|
inlinenoexcept |
Returns the object assigned to an entity as a tuple.
| entt | A valid identifier. |
Definition at line 646 of file storage.hpp.
|
inline |
Assigns one or more entities to a storage and constructs their objects from a given range.
| EIt | Type of input iterator. |
| CIt | Type of input iterator. |
| first | An iterator to the first element of the range of entities. |
| last | An iterator past the last element of the range of entities. |
| from | An iterator to the first element of the range of objects. |
Definition at line 725 of file storage.hpp.
|
inline |
Assigns one or more entities to a storage and constructs their objects from a given instance.
| It | Type of input iterator. |
| first | An iterator to the first element of the range of entities. |
| last | An iterator past the last element of the range of entities. |
| value | An instance of the object to construct. |
Definition at line 703 of file storage.hpp.
|
inlinenoexcept |
Move assignment operator.
| other | The instance to move from. |
Definition at line 465 of file storage.hpp.
|
inline |
Updates the instance assigned to a given entity in-place.
| Func | Types of the function objects to invoke. |
| entt | A valid identifier. |
| func | Valid function objects. |
Definition at line 681 of file storage.hpp.
|
inlineoverrideprotectedvirtual |
Erases entities from a storage.
| first | An iterator to the first element of the range of entities. |
| last | An iterator past the last element of the range of entities. |
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 332 of file storage.hpp.
|
inlineoverrideprotectedvirtual |
Erases all entities of a storage.
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 351 of file storage.hpp.
|
inlinenoexcept |
Direct access to the array of objects.
Definition at line 526 of file storage.hpp.
|
inlinenoexcept |
Direct access to the array of objects.
Definition at line 531 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning.
If the storage is empty, the returned iterator will be equal to rend().
Definition at line 589 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the beginning.
If the storage is empty, the returned iterator will be equal to rend().
Definition at line 594 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterable object to use to visit a storage.
Definition at line 762 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterable object to use to visit a storage.
Definition at line 757 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the end.
Definition at line 608 of file storage.hpp.
|
inlinenoexcept |
Returns a reverse iterator to the end.
Definition at line 613 of file storage.hpp.
|
inlineoverridevirtual |
Increases the capacity of a storage.
If the new capacity is greater than the current capacity, new storage is allocated, otherwise the method does nothing.
| cap | Desired capacity. |
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 500 of file storage.hpp.
|
inlineoverridevirtual |
Requests the removal of unused capacity.
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 517 of file storage.hpp.
|
inline |
Exchanges the contents with those of a given storage.
| other | Storage to exchange the content with. |
Definition at line 478 of file storage.hpp.
|
inlineoverrideprotectedvirtual |
Assigns an entity to a storage.
| entt | A valid identifier. |
| value | Optional opaque value. |
| force_back | Force back insertion. |
Reimplemented from entt::basic_sparse_set< Entity, std::allocator_traits< Allocator >::template rebind_alloc< Entity > >.
Definition at line 374 of file storage.hpp.