Navigation
API > API/Runtime > API/Runtime/MovieScene
High-level container which acts as a look-up-table for IMovieSceneEntityProviders and their entities and meta-data in a sequence
Generally generated and accessed through UMovieSceneCompiledDataManager, but can also be used independently. Entity fields are constructed using FMovieSceneEntityComponentFieldBuilder which ensures the invariants of this class are maintained along with guaranteeing no redundant entries exist.
| Name | FMovieSceneEntityComponentField |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationField.h |
| Include Path | #include "Evaluation/MovieSceneEvaluationField.h" |
Syntax
USTRUCT ()
struct FMovieSceneEntityComponentField
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Entities | TArray< FMovieSceneEvaluationFieldEntity > | 16 bytes - Flat array of unique entities. The 2 tree types specify indices into this array | Evaluation/MovieSceneEvaluationField.h | |
| EntityMetaData | TArray< FMovieSceneEvaluationFieldEntityMetaData > | 16 bytes - Optional meta-data for specific entities. | Evaluation/MovieSceneEvaluationField.h | |
| OneShotEntityTree | FMovieSceneEvaluationFieldEntityTree | A hierarchical tree specifiying indices into the Entities array for any given time such one-shot entities are active | Evaluation/MovieSceneEvaluationField.h | |
| PersistentEntityTree | FMovieSceneEvaluationFieldEntityTree | A hierarchical tree specifiying indices into the Entities array for any given time such persistent entities are active | Evaluation/MovieSceneEvaluationField.h | |
| SharedMetaData | TArray< FMovieSceneEvaluationFieldSharedEntityMetaData > | 16 bytes - Optional shared meta-data for groups of entities. | Evaluation/MovieSceneEvaluationField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FMovieSceneEvaluationFieldEntityMetaData * FindMetaData
(
const FMovieSceneEvaluationFieldEntityQuery& InQuery |
Retrieve the meta-data for an entity | Evaluation/MovieSceneEvaluationField.h | |
const FMovieSceneEvaluationFieldSharedEntityMetaData * FindSharedMetaData
(
const FMovieSceneEvaluationFieldEntityQuery& InQuery |
Retrieve the shared meta-data for an entity | Evaluation/MovieSceneEvaluationField.h | |
const FMovieSceneEvaluationFieldEntity & GetEntity
(
int32 EntityIndex |
Retrieve an entity from its index | Evaluation/MovieSceneEvaluationField.h | |
bool HasAnyOneShotEntities() |
Check whether this field contains any one-shot entities | Evaluation/MovieSceneEvaluationField.h | |
bool IsEmpty() |
Check if this field is empty | Evaluation/MovieSceneEvaluationField.h | |
void QueryOneShotEntities
(
const TRange< FFrameNumber >& QueryRange, |
Query the one-shot entities that overlap with the specified query range. | Evaluation/MovieSceneEvaluationField.h | |
void QueryPersistentEntities
(
FFrameNumber QueryTime, |
Query the persistent entities for any given time within a sequence. | Evaluation/MovieSceneEvaluationField.h | |
void QueryPersistentEntities
(
FFrameNumber QueryTime, |
Query the persistent entities for any given time within a sequence. | Evaluation/MovieSceneEvaluationField.h |