1. Epic GamesDeveloper
  3. TOverlappingEntityTrackerImpl

TOverlappingEntityTrackerImpl

Templated utility class that assists in tracking the state of many -> one data relationships in an [FEntityManager](API\Runtime\MovieScene\EntitySystem\FEntityManager).

API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/EntitySystem

Inheritance Hierarchy

References

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

Syntax

template<typename OutputType, typename... InputKeyTypes>  
struct TOverlappingEntityTrackerImpl

Remarks

Templated utility class that assists in tracking the state of many -> one data relationships in an FEntityManager. InputKeyTypes defines the component type(s) which defines the key that determines whether an entity animates the same output. OutputType defines the user-specfied data to be associated with the multiple inputs (ie, its output)

Variables

  Type Name Description
Protected variable bool bIsInitialized  
Protected variable TMap< FMovieSceneEntityID, uint16 > EntityToOutput  
Protected variable TBitArray InvalidatedOutputs  
Protected variable TMap< KeyType, uint16 > KeyToOutput  
Protected variable TBitArray NewOutputs  
Protected variable TSparseArray< FOutput > Outputs  
Protected variable TMultiMap< uint16, FMovieSceneEntityID > OutputToEntity  

Functions

  Type Name Description
Protected function void  
Protected function uint16  
Public function void

Destroy ( HandlerType&& InHandler
)

 Destroy all the outputs currently being tracked
Public function Const void  
Public function Const const OutputType *  
Public function Const const OutputType *  
Protected function Const uint16  
Protected function Const uint16  
Public function Const bool

IsEmpty ()

  
Public function Const bool  
Protected function bool

IsOutputValid ( uint16 OutputIndex
)

  
Protected function uint16

MakeOutput ( FMovieSceneEntityID EntityID,

ParamType InKey,

bool bAlwaysInvalidate
)

  
Public function Const bool

NeedsRestoration (

ParamType Key,

bool bEnsureOutput
)

  
Public function void

ProcessInvalidatedOutputs ( UMovieSceneEntitySystemLinker* Linker,
HandlerType&& InHandler
)

 Process any outputs that were invalidated as a result of Update being called using a custom handler.
Public function void

SetNeedsRestoration (

ParamType Key,

bool bNeedsRestoration,
bool bEnsureOutput
)

  
Public function void

Update ( UMovieSceneEntitySystemLinker* Linker,
TComponentTypeID< InputKeyTypes >... InKeyComponents,
const FEntityComponentFilter& InFilter
)

 Update this tracker by iterating any entity that contains InKeyComponent, and matches the additional optional filter Only entities tagged as NeedsLink or NeedsUnlink are iterated, invalidating their outputs
Public function void

UpdateFromComponents ( UMovieSceneEntitySystemLinker* Linker,
const FEntityComponentFilter& InFilter,
TComponentTypeID< ComponentTypes >... InKeyComponents
)

 Update this tracker by iterating any entity that contains InKeyComponent, and matches the additional optional filter Only entities tagged as NeedsLink or NeedsUnlink are iterated, invalidating their outputs
Public function void

UpdateUnlinkedOnly ( UMovieSceneEntitySystemLinker* Linker,
TComponentTypeID< ComponentTypes >... InKeyComponent,
const FEntityComponentFilter& InFilter
)

 Update this tracker by iterating any entity that contains InKeyComponent, and matches the additional optional filter Only entities tagged as NeedsUnlink are iterated, invalidating their outputs
Public function void

VisitActiveAllocation ( const FEntityAllocation* Allocation,
TComponentPtr< const ComponentTypes >... ReadKeys
)

 Update this tracker by (re)linking the specified allocation
Protected function void

VisitActiveAllocationImpl ( const FEntityAllocation* Allocation,
TComponentPtr< const ComponentTypes >... Keys
)

  
Public function void

VisitLinkedAllocation ( const FEntityAllocation* Allocation,
TComponentPtr< const ComponentTypes >... ReadKeys
)

 Update this tracker by (re)linking the specified allocation
Public function void Update this tracker by unlinking the specified allocation
Protected function void  

Classes

  Type Name Description
Protected struct FOutput    

Typedefs

Name Description
KeyType  
ParamType  

Constants

Name Description
NO_OUTPUT  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page