entt::basic_snapshot Class Reference

Utility class to create snapshots from a registry. More...

#include <entt.hpp>

Public Member Functions
	basic_snapshot (basic_snapshot &&)=default
	Default move constructor. More...
basic_snapshot &	operator= (basic_snapshot &&)=default
	Default move assignment operator. More...
template<typename Archive >
const basic_snapshot &	entities (Archive &archive) const
	Puts aside all the entities that are still in use. More...
template<typename Archive >
const basic_snapshot &	destroyed (Archive &archive) const
	Puts aside destroyed entities. More...
template<typename... Component, typename Archive >
const basic_snapshot &	component (Archive &archive) const
	Puts aside the given components. More...
template<typename... Component, typename Archive , typename It >
const basic_snapshot &	component (Archive &archive, It first, It last) const
	Puts aside the given components for the entities in a range. More...

Friends
class	basic_registry< Entity >
	A registry is allowed to create snapshots. More...

Detailed Description

Utility class to create snapshots from a registry.

A snapshot can be either a dump of the entire registry or a narrower selection of components of interest.
This type can be used in both cases if provided with a correctly configured output archive.

Template Parameters

Entity

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

Constructor & Destructor Documentation

basic_snapshot()

entt::basic_snapshot::basic_snapshot ( basic_snapshot &&  )

default

Default move constructor.

Member Function Documentation

component() [1/2]

template<typename... Component, typename Archive >

const basic_snapshot& entt::basic_snapshot::component ( Archive &  archive ) const

inline

Puts aside the given components.

Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.

Template Parameters

Component	Types of components to serialize.
Archive	Type of output archive.

Parameters

archive

A valid reference to an output archive.

Returns

An object of this type to continue creating the snapshot.

component() [2/2]

template<typename... Component, typename Archive , typename It >

const basic_snapshot& entt::basic_snapshot::component ( Archive &  archive, It  first, It  last  ) const

inline

Puts aside the given components for the entities in a range.

Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.

Template Parameters

Component	Types of components to serialize.
Archive	Type of output archive.
It	Type of input iterator.

Parameters

archive	A valid reference to an output archive.
first	An iterator to the first element of the range to serialize.
last	An iterator past the last element of the range to serialize.

Returns

An object of this type to continue creating the snapshot.

destroyed()

template<typename Archive >

const basic_snapshot& entt::basic_snapshot::destroyed ( Archive &  archive ) const

inline

Puts aside destroyed entities.

Entities are serialized along with their versions. Entities that are still in use are not taken in consideration by this function.

Template Parameters

Archive

Type of output archive.

Parameters

archive

A valid reference to an output archive.

Returns

An object of this type to continue creating the snapshot.

entities()

template<typename Archive >

const basic_snapshot& entt::basic_snapshot::entities ( Archive &  archive ) const

inline

Puts aside all the entities that are still in use.

Entities are serialized along with their versions. Destroyed entities are not taken in consideration by this function.

Template Parameters

Archive

Type of output archive.

Parameters

archive

A valid reference to an output archive.

Returns

An object of this type to continue creating the snapshot.

operator=()

basic_snapshot& entt::basic_snapshot::operator= ( basic_snapshot &&  )

default

Default move assignment operator.

Returns

This snapshot.

Friends And Related Function Documentation

basic_registry< Entity >

friend class basic_registry< Entity >

friend

A registry is allowed to create snapshots.

---

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

• D:/CadworkJobs/SoftwareProjekte/Lexocad/LexoGit/Lexocad/lexocad/Base/include/Base/entt.hpp