Navigation
API > API/Runtime > API/Runtime/MovieScene
Builder class used for populating an FMovieSceneEntityComponentField with data. Ensures that null or redundant entities or meta-data are not added to the field, and that all indices are valid and correct.
| Name | FMovieSceneEntityComponentFieldBuilder |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationField.h |
| Include Path | #include "Evaluation/MovieSceneEvaluationField.h" |
Syntax
struct FMovieSceneEntityComponentFieldBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneEntityComponentFieldBuilder
(
FMovieSceneEntityComponentField* InField |
Construction from a field to populate | Evaluation/MovieSceneEvaluationField.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMovieSceneEntityComponentFieldBuilder() |
Destructor that cleans up redundant data if necessary | Evaluation/MovieSceneEvaluationField.h |
Structs
| Name | Remarks |
|---|---|
| FKeyToIndex | Array of entity keys and their field index within FMovieSceneEntityComponentField::Entities |
| FMetaDataToIndex |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvalidEntityID | uint32 | Evaluation/MovieSceneEvaluationField.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Field | FMovieSceneEntityComponentField * | The field that we are building | Evaluation/MovieSceneEvaluationField.h | |
| KeyToFieldIndex | TArray< FKeyToIndex, TInlineAllocator< 4 > > | Evaluation/MovieSceneEvaluationField.h | ||
| MetaDataToFieldIndex | TArray< FMetaDataToIndex, TInlineAllocator< 2 > > | Evaluation/MovieSceneEvaluationField.h | ||
| SharedMetaDataIndex | int32 | (default: INDEX_NONE) The index into FMovieSceneEntityComponentField::SharedMetaData for all entities built by this builder, if it has been defined. | Evaluation/MovieSceneEvaluationField.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddMetaData
(
const FMovieSceneEvaluationFieldEntityMetaData& InMetaData |
Add meta-data to this tree returning its index within this builder | Evaluation/MovieSceneEvaluationField.h | |
void AddOneShotEntity
(
const TRange< FFrameNumber >& OneShotRange, |
Add a one-shot entity to the field for a given range | Evaluation/MovieSceneEvaluationField.h | |
void AddOneShotEntity
(
const TRange< FFrameNumber >& OneShotRange, |
Add a one-shot entity to the field for a given range. | Evaluation/MovieSceneEvaluationField.h | |
void AddPersistentEntity
(
const TRange< FFrameNumber >& Range, |
Add a persistent entity to the field for a given range | Evaluation/MovieSceneEvaluationField.h | |
void AddPersistentEntity
(
const TRange< FFrameNumber >& Range, |
Add a persistent entity to the field for a given range. | Evaluation/MovieSceneEvaluationField.h | |
int32 FindOrAddEntity
(
UObject* EntityOwner, |
Retrieve an index for the entity that is identified by the specified owner and ID | Evaluation/MovieSceneEvaluationField.h | |
FMovieSceneEvaluationFieldSharedEntityMetaData & GetSharedMetaData() |
Access the shared meta-data for all the entities created by this builder. | Evaluation/MovieSceneEvaluationField.h | |
int32 GetSharedMetaDataIndex() |
Access the index of the shared meta-data of this builder. | Evaluation/MovieSceneEvaluationField.h |