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\FEntityManager).

API > API/Runtime > API/Runtime/MovieScene

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)

   
Name TOverlappingEntityTrackerImpl
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneOverlappingEntityTracker.h
Include Path #include "EntitySystem/MovieSceneOverlappingEntityTracker.h"

Syntax

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

Derived Classes

Structs

Name Remarks
FOutput  

Typedefs

Name Type Remarks Include Path
KeyType TOverlappingEntityInput< InputKeyTypes... >   EntitySystem/MovieSceneOverlappingEntityTracker.h
ParamType typename TCallTraits< KeyType >::ParamType   EntitySystem/MovieSceneOverlappingEntityTracker.h

Constants

Name Type Remarks Include Path
NO_OUTPUT uint16   EntitySystem/MovieSceneOverlappingEntityTracker.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Destroy ( HandlerType&& InHandler
)

 Destroy all the outputs currently being tracked EntitySystem/MovieSceneOverlappingEntityTracker.h  

void FindEntityIDs ( ParamType Key,
TArray< FMovieSceneEntityID >& OutEntityIDs
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

const OutputType * FindOutput ( FMovieSceneEntityID EntityID
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

const OutputType * FindOutput ( ParamType Key
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

bool IsEmpty()

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

bool IsInitialized()

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

bool NeedsRestoration ( ParamType Key,
bool bEnsureOutput
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

void ProcessInvalidatedOutputs ( UMovieSceneEntitySystemLinker* Linker,
HandlerType&& InHandler
)

 Process any outputs that were invalidated as a result of Update being called using a custom handler. EntitySystem/MovieSceneOverlappingEntityTracker.h  

void SetNeedsRestoration ( ParamType Key,
bool bNeedsRestoration,
bool bEnsureOutput
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

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 EntitySystem/MovieSceneOverlappingEntityTracker.h  

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 EntitySystem/MovieSceneOverlappingEntityTracker.h  

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 EntitySystem/MovieSceneOverlappingEntityTracker.h  

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

 Update this tracker by (re)linking the specified allocation EntitySystem/MovieSceneOverlappingEntityTracker.h  

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

 Update this tracker by (re)linking the specified allocation EntitySystem/MovieSceneOverlappingEntityTracker.h  

void VisitUnlinkedAllocation ( const FEntityAllocation* Allocation
)

 Update this tracker by unlinking the specified allocation EntitySystem/MovieSceneOverlappingEntityTracker.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearOutputByEntity ( FMovieSceneEntityID EntityID
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

uint16 CreateOutputByKey ( ParamType Key
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

uint16 FindOutputByEntity ( FMovieSceneEntityID EntityID
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

uint16 FindOutputByKey ( ParamType Key
) const

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

bool IsOutputValid ( uint16 OutputIndex
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

uint16 MakeOutput ( FMovieSceneEntityID EntityID,
ParamType InKey,
bool bAlwaysInvalidate
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

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

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

void VisitUnlinkedAllocationImpl ( const FEntityAllocation* Allocation
)

   EntitySystem/MovieSceneOverlappingEntityTracker.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page