Utility class for continuous loading. More...

#include <snapshot.hpp>

Public Types
using	entity_type = Entity
	Underlying entity identifier.

Public Member Functions
	basic_continuous_loader (basic_registry< entity_type > &source)
	Constructs an instance that is bound to a given registry. More...

	basic_continuous_loader (basic_continuous_loader &&)=default
	Default move constructor.

basic_continuous_loader &	operator= (basic_continuous_loader &&)=default
	Default move assignment operator. More...

template<typename Archive >
basic_continuous_loader &	entities (Archive &archive)
	Restores entities that were in use during serialization. More...

template<typename... Component, typename Archive , typename... Type, typename... Member>
basic_continuous_loader &	component (Archive &archive, Member Type::*...member)
	Restores components and assigns them to the right entities. More...

basic_continuous_loader &	shrink ()
	Helps to purge entities that no longer have a conterpart. More...

basic_continuous_loader &	orphans ()
	Destroys those entities that have no components. More...

bool	contains (entity_type entt) const
	Tests if a loader knows about a given entity. More...

entity_type	map (entity_type entt) const
	Returns the identifier to which an entity refers. More...

Detailed Description

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

Utility class for continuous loading.

A continuous loader is designed to load data from a source registry to a (possibly) non-empty destination. The loader can accommodate in a registry more than one snapshot in a sort of continuous loading that updates the destination one step at a time.
Identifiers that entities originally had are not transferred to the target. Instead, the loader maps remote identifiers to local ones while restoring a snapshot.
An example of use is the implementation of a client-server applications with the requirement of transferring somehow parts of the representation side to side.

Template Parameters

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

Definition at line 296 of file snapshot.hpp.

Constructor & Destructor Documentation

◆ basic_continuous_loader()

template<typename Entity >

entt::basic_continuous_loader< Entity >::basic_continuous_loader ( basic_registry< entity_type > & source )

inline

Constructs an instance that is bound to a given registry.

Parameters

source A valid reference to a registry.

Definition at line 412 of file snapshot.hpp.

Member Function Documentation

◆ component()

template<typename Entity >

template<typename... Component, typename Archive , typename... Type, typename... Member>

basic_continuous_loader& entt::basic_continuous_loader< Entity >::component	(	Archive &	archive,
		Member Type::*...	member
	)

inline

Restores components and assigns them to the right entities.

The template parameter list must be exactly the same used during serialization. In the event that the entity to which the component is assigned doesn't exist yet, the loader will take care to create a local counterpart for it.
Members can be either data members of type entity_type or containers of entities. In both cases, the loader will visit them and update the entities by replacing each one with its local counterpart.

Template Parameters

Component	Type of component to restore.
Archive	Type of input archive.
Type	Types of components to update with local counterparts.
Member	Types of members to update with their local counterparts.

Parameters

archive	A valid reference to an input archive.
member	Members to update with their local counterparts.

Returns: A non-const reference to this loader.

Definition at line 473 of file snapshot.hpp.

◆ contains()

template<typename Entity >

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

inline

Tests if a loader knows about a given entity.

Parameters

entt	A valid identifier.

Returns: True if entity is managed by the loader, false otherwise.

Definition at line 534 of file snapshot.hpp.

◆ entities()

template<typename Entity >

template<typename Archive >

basic_continuous_loader& entt::basic_continuous_loader< Entity >::entities ( Archive & archive )

inline

Restores entities that were in use during serialization.

This function restores the entities that were in use during serialization and creates local counterparts for them if required.

Template Parameters

Archive Type of input archive.

Parameters

archive A valid reference to an input archive.

Returns: A non-const reference to this loader.

Definition at line 432 of file snapshot.hpp.

◆ map()

template<typename Entity >

entity_type entt::basic_continuous_loader< Entity >::map ( entity_type entt ) const

inline

Returns the identifier to which an entity refers.

Parameters

entt	A valid identifier.

Returns: The local identifier if any, the null entity otherwise.

Definition at line 543 of file snapshot.hpp.

◆ operator=()

template<typename Entity >

basic_continuous_loader& entt::basic_continuous_loader< Entity >::operator= ( basic_continuous_loader< Entity > && )

default

Default move assignment operator.

Returns: This loader.

◆ orphans()

template<typename Entity >

basic_continuous_loader& entt::basic_continuous_loader< Entity >::orphans ( )

inline

Destroys those entities that have no components.

In case all the entities were serialized but only part of the components was saved, it could happen that some of the entities have no components once restored.
This functions helps to identify and destroy those entities.

Returns: A non-const reference to this loader.

Definition at line 519 of file snapshot.hpp.

◆ shrink()

template<typename Entity >

basic_continuous_loader& entt::basic_continuous_loader< Entity >::shrink ( )

inline

Helps to purge entities that no longer have a conterpart.

Users should invoke this member function after restoring each snapshot, unless they know exactly what they are doing.

Returns: A non-const reference to this loader.

Definition at line 487 of file snapshot.hpp.

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

src/entt/entity/fwd.hpp
src/entt/entity/snapshot.hpp

Public Types

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ basic_continuous_loader()

Member Function Documentation

◆ component()

◆ contains()

◆ entities()

◆ map()

◆ operator=()

◆ orphans()

◆ shrink()

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