FMovieSceneEntityComponentField

High-level container which acts as a look-up-table for IMovieSceneEntityProviders and their entities and meta-data in a sequence

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "Evaluation/MovieSceneEvaluationField.h"

Syntax

struct FMovieSceneEntityComponentField

Remarks

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.

Functions

Name Description

Public function Const

const FMovie...

 

FindMetaData

(
    const FMovieSceneEvaluationFieldEnt...
)

Retrieve the meta-data for an entity

Public function Const

const FMovie...

 

FindSharedMetaData

(
    const FMovieSceneEvaluationFieldEnt...
)

Retrieve the shared meta-data for an entity

Public function Const

const FMovie...

 

GetEntity

(
    int32 EntityIndex
)

Retrieve an entity from its index

Public function Const

bool

 

HasAnyOneShotEntities()

Check whether this field contains any one-shot entities

Public function Const

bool

 

IsEmpty()

Check if this field is empty

Public function Const

void

 

QueryOneShotEntities

(
    const TRange< FFrameNumber >& Quer...,
    FMovieSceneEvaluationFieldEntitySet...
)

Query the one-shot entities that overlap with the specified query range.

Public function Const

void

 

QueryPersistentEntities

(
    FFrameNumber QueryTime,
    TRange< FFrameNumber >& OutRange,
    FMovieSceneEvaluationFieldEntitySet...
)

Query the persistent entities for any given time within a sequence.

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