FMovieSceneEntityComponentFieldBuilder

Builder class used for populating an [FMovieSceneEntityComponentField](API\Runtime\MovieScene\Evaluation\FMovieSceneEntityComponentField) with data.

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationField.h

Include

#include "Evaluation/MovieSceneEvaluationField.h"

Syntax

struct FMovieSceneEntityComponentFieldBuilder

Remarks

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.

Constructors

Name Description

Public function

FMovieSceneEntityComponentFieldBuilder

Construction from a field to populate

Destructors

Name Description

Public function

~FMovieSceneEntityComponentFieldBuilder()

Destructor that cleans up redundant data if necessary

Functions

Name Description

Public function

int32

 

AddMetaData

(
    const FMovieSceneEvaluationFieldEnt...
)

Add meta-data to this tree returning its index within this builder

Public function

void

 

AddOneShotEntity

(
    const TRange< FFrameNumber >& OneS...,
    int32 LocalIndex,
    int32 InMetaDataIndex
)

Add a one-shot entity to the field for a given range @note One-shot entities are only ever alive for a single evaluation, regardless of the range within the field.

Public function

void

 

AddOneShotEntity

(
    const TRange< FFrameNumber >& OneS...,
    UObject* EntityOwner,
    uint32 EntityID,
    int32 InMetaDataIndex
)

Add a one-shot entity to the field for a given range.

Public function

void

 

AddPersistentEntity

(
    const TRange< FFrameNumber >& Rang...,
    int32 LocalIndex,
    int32 InMetaDataIndex
)

Add a persistent entity to the field for a given range @note Persistent entities remain alive for the entire duration of their applicable ranges.

Public function

void

 

AddPersistentEntity

(
    const TRange< FFrameNumber >& Rang...,
    UObject* EntityOwner,
    uint32 EntityID,
    int32 InMetaDataIndex
)

Add a persistent entity to the field for a given range.

Public function

int32

 

FindOrAddEntity

(
    UObject* EntityOwner,
    uint32 EntityID
)

Retrieve an index for the entity that is identified by the specified owner and ID

Public function

FMovieSceneE...

 

GetSharedMetaData()

Access the shared meta-data for all the entities created by this builder.

Constants

Name

Description

InvalidEntityID

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss