1. Epic GamesDeveloper
  3. FEntityManager

FEntityManager

Top-level manager class that is responsible for all entity data and interaction/

Unreal Engine C++ API Reference > Runtime > MovieScene > EntitySystem

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityManager.h
Include #include "EntitySystem/MovieSceneEntityManager.h"

Syntax

class FEntityManager : public FUObjectArray::FUObjectDeleteListener

Remarks

Top-level manager class that is responsible for all entity data and interaction/

An entity is a stable index into the manager's EntityLocations, which defines the location for that entity's data. This allows the manager to relocate entity data at will without invalidating client held entity IDs. An entity may contain 0 or more components. Components are concrete pieces of data with a unique type identifier. Additionally, tags can be added to entities or whole batches of entities with zero memory overhead.

Entity Component data is stored in allocations organized by each unique combination of components. Each component type is stored as a contiguous array within each allocation, with each entity's component being a fixed offset from the start of each component array. This enables efficient read/write access into specific component arrays and makes issuing parallel tasks that require component data trivial. See FEntityAllocation for a more detailed explanation of entity component data layout.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void

AccumulateMask ( const FEntityComponentFilter& InFilter,
FComponentMask& OutMask
)

 Accumulate a mask from all entity types that match the specified filter
Public function void Set up an entity to be a child of another.
Public function void

AddComponent ( FMovieSceneEntityID EntityID,
FComponentTypeID ComponentTypeID,
EEntityRecursion Recursion
)

 Add the specified component value to an entity
Public function void

AddComponent ( FMovieSceneEntityID EntityID,
TComponentTypeID< T > ComponentTypeID,
ValueType&& InValue
)

 Add the specified component value to an entity
Public function void

AddComponent ( FMovieSceneEntityID EntityID,
FComponentTypeID ComponentTypeID
)

 Add the specified component type to an entity. The component value will be default-initialized.
Public function void

AddComponents ( FMovieSceneEntityID EntityID,
const FComponentMask& EntityComponentMask
)

 Add the specified components to an entity.
Public function void

AddComponents ( FMovieSceneEntityID EntityID,
const FComponentMask& EntityComponentMask,
EEntityRecursion Recursion
)

 Add the specified components to an entity.
Public function void Run through all entities in this entity manager, ensuring that all mutual components exist
Public function void Run through all entities in this entity manager, ensuring that all mutual components exist for any component types that match the specified filter
Public function void

AddReferencedObjects ( FReferenceCollector& ReferenceCollector
)

 Explicitly add referenced objects from an external source.
Public function FEntityDataLocation

AllocateContiguousEntities ( const FComponentMask& EntityComponentMask,
int32* InOutNum
)

 Attempt to allocate a number of entities of the same type contiguously in memory
Public function FMovieSceneEntityID Allocate a new entity with no components
Public function FEntityInfo

AllocateEntity ( const FComponentMask& EntityComponentMask
)

 Allocate a single entity with the specified components
Public function void

ChangeEntityType ( FMovieSceneEntityID InEntity,
const FComponentMask& InNewMask
)

 Changes the components that exist on an entity to a new mask
Public function Const void  
Public function void

CombineComponents ( FMovieSceneEntityID DestinationEntityID,
FMovieSceneEntityID SourceEntityID,
const FComponentMask* OptionalMask
)

 Combine the components from one entity into another, overwriting any pre-existing component values.
Public function void

Compact ()

 Goes through all entity data and compacts like-for-like allocations into as few allocations as possible, resulting in the optimal data layout
Public function Const EEntityThreadingModel Compute and return this entity manager's threading model.
Public function Const bool

Contains ( const FEntityComponentFilter& InFilter
)

 Efficiently test whether this entity manager contains any allocations that match the specified filter
Public function Const bool

ContainsAllComponents ( std::initializer_list< FComponentTypeID > ComponentTypeIDs
)

 Check whether all of the specified components exist anywhere in this entity manager
Public function Const bool

ContainsAnyComponent ( std::initializer_list< FComponentTypeID > ComponentTypeIDs
)

 Check whether any entity in this manager has any of the specified components
Public function Const bool

ContainsAnyComponent ( const FComponentMask& ComponentTypeIDs
)

 Check whether any entity in this manager has any of the specified components
Public function Const bool

ContainsComponent ( FComponentTypeID ComponentTypeID
)

 Check whether any entity in this manager has the specified component
Public function bool

CopyComponent ( FMovieSceneEntityID SrcEntityID,
FMovieSceneEntityID DstEntityID,
FComponentTypeID ComponentTypeID
)

 Copy the specified component type from an entity if it exists.
Public function void

CopyComponents ( FMovieSceneEntityID SrcEntityID,
FMovieSceneEntityID DstEntityID,
const FComponentMask& ComponentsToCopy
)

 Copy any and all the specified component types from one entity onto another.
Public function void Run a serialization routine over the specified entity to approximate the memory it is using
Public function int32 Defines a new child initializer that applies only to entities factoried within this entity manager
Public function void

Destroy ()

 Destroy this entity manager and all the entities and components contained within it, resetting it back to its default state
Public function void Destroy a previously registered instanced child initializer using its index
Public function FMovieSceneEntityID Duplicate an entity, by creating an exact copy with a new ID
Public function Const void Efficiently test whether this entity manager contains any allocations that match the specified filter
Public function Const void  
Public function void

FilterComponents ( FMovieSceneEntityID EntityID,
const FComponentMask& EntitiesToKeep
)

 Remove all but the specified components from an entity.
Public function Static IComponentTypeHandler *

FindComponentTypeHandler ( const FGuid& ComponentGuid
)

 Find a component type hander from its registered GUID
Public function int32

FreeEntities ( const FEntityComponentFilter& Filter,
TSet< FMovieSceneEntityID >* OutFreedEntities
)

 Free all entities that match the specified filter
Public function int32

FreeEntities ( const FFreeEntityOperation& Operation,
TSet< FMovieSceneEntityID >* OutFreedEntities
)

 Free all entities defined by the specified operation
Public function void Free an entity and relinquish its entity ID
Public function Const const FComponentMask & Retrieve an up-to-date accumulation of all components present on entities in this manager
Public function Const void Retrieve all children, grandchildren etc of the specified entity using a parent first traversal
Public function Const FComponentRegistry *  
Public function Const ENamedThreads::Type  
Public function Const FEntityInfo Retrieve an entity's allocation and component offset from its ID
Public function FEntityHandle Retrieve a handle to an entity
Public function Const const FComponentMask & Retrieve the type mask for this component
Public function Const ENamedThreads::Type  
Public function Const const FEntityComponentFilter & Retrieve the entity filter that should be used for any entity iteration.
Public function Const uint32  
Public function Const void Retrieve the immediate children of the specified entity
Public function Const uint64 Get the current serial number for any system ovserving this entity manager.
Public function Const EEntityThreadingModel Get this entitiy manager's current threading model based on the last time UpdateThreadingModel was called.
Public function Const bool

HasComponent ( FMovieSceneEntityID EntityID,
FComponentTypeID ComponentTypeID
)

 Check whether the specified component has a component of the specified type
Public function Const bool

HasStructureChangedSince ( uint64 CachedSerial
)

 Check whether the structure of this entity manager has changed at all since the specified serial number
Public function void

IncrementSystemSerial ( uint64 IncAmount
)

 Increment the current serial number for systems observing this manager.
Public function void

InitializeChildAllocation ( const FComponentMask& ParentType,
const FComponentMask& ChildType,
const FEntityAllocation* ParentAllocation,
TArrayView< const int32 > ParentAllocationOffsets,
const FEntityRange& InChildEntityRange
)

 Runs all initializers for the specified parent/child allocation
Public function Const bool Check whether an entity is allocated.
Public function Const bool Check whether the specified entity handle is still valid
Public function Const bool  
Public function Const FEntityAllocationIteratorProxy

Iterate ( const FEntityComponentFilter* InFilter
)

 Iterate through all the allocations that match the specified component filter
Public function Const void

IterateChildren_ParentFirst ( FMovieSceneEntityID ParentID,
IteratorType&& Iterator
)

 Iterate all children, grandchildren etc of the specified entity using a parent first traversal
Public function Const void

IterateImmediateChildren ( FMovieSceneEntityID ParentID,
IteratorType&& Iterator
)

 Itereate the immediate children of the specified entity
Public function void  
Public function void Called in order to mimic the entity structure changing, even if it has not
Public function FEntityComponentFilter & Modify the entity filter that should be used for any entity iteration.
Public function int32 Efficiently mutate all entities that match a filter.
Public function int32 Efficiently mutate all entities that match a filter.
Public function void Duplicate an entity over the top of an existing entity ID
Public function Const TComponentLock< TReadOptional< T > >

ReadComponent ( FMovieSceneEntityID Entity,
TComponentTypeID< T > ComponentTypeID
)

 Attempt to read a component from an entity.
Public function Const T

ReadComponentChecked ( FMovieSceneEntityID Entity,
TComponentTypeID< T > ComponentTypeID
)

 Read a component value from an entity that is known to exist.
Public function void  
Public function void

RemoveComponent ( FMovieSceneEntityID EntityID,
FComponentTypeID ComponentTypeID
)

 Remove the specified component type from an entity if it exists.
Public function void

RemoveComponent ( FMovieSceneEntityID EntityID,
FComponentTypeID ComponentTypeID,
EEntityRecursion Recursion
)

 Remove the specified component type from an entity if it exists.
Public function void

RemoveComponents ( FMovieSceneEntityID EntityID,
const FComponentMask& ComponentsToRemove
)

 Remove the specified components from an entity, if they exist.
Public function void

RemoveComponents ( FMovieSceneEntityID EntityID,
const FComponentMask& ComponentsToRemove,
EEntityRecursion Recursion
)

 Remove the specified components from an entity, if they exist.
Public function void

ReplaceEntityID ( FMovieSceneEntityID& InOutEntity,
FMovieSceneEntityID EntityToDiscard
)

 Replace an entity ID with the components from another, discarding the provided entity ID in the process
Public function void  
Public function void

SetDebugName ( FString&& InNewDebugName
)

 Set a debug name for this entity manager
Public function void

SetDispatchThread ( ENamedThreads::Type InDispatchThread
)

  
Public function void  
Public function void Touch the specified entity, cause the allocation and component serial numbers to be incremented.
Public function void Compute and store the current threading model.
Public function TComponentLock< TWriteOptional< T > >

WriteComponent ( FMovieSceneEntityID Entity,
TComponentTypeID< T > ComponentTypeID
)

 Attempt to write to an entity's component.
Public function void

WriteComponentChecked ( FMovieSceneEntityID Entity,
TComponentTypeID< T > ComponentTypeID,
ValueType&& Value
)

 Write a component value that is known to exist to an entity.

Operators

  Type Name Description
Public function void  
Public function void  

Enums

  Type Name Description
Private enum ELockdownState    
Private enum EMemoryType    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page