FMovieSceneEntityComponentField Struct Reference

#include <MovieSceneEvaluationField.h>

Public Member Functions
bool	IsEmpty () const
const FMovieSceneEvaluationFieldEntity &	GetEntity (int32 EntityIndex) const
const FMovieSceneEvaluationFieldEntityMetaData *	FindMetaData (const FMovieSceneEvaluationFieldEntityQuery &InQuery) const
const FMovieSceneEvaluationFieldSharedEntityMetaData *	FindSharedMetaData (const FMovieSceneEvaluationFieldEntityQuery &InQuery) const
MOVIESCENE_API void	QueryPersistentEntities (FFrameNumber QueryTime, TRange< FFrameNumber > &OutRange, FMovieSceneEvaluationFieldEntitySet &OutEntities) const
MOVIESCENE_API void	QueryPersistentEntities (FFrameNumber QueryTime, TFunctionRef< bool(const FMovieSceneEvaluationFieldEntityQuery &)> QueryCallback, TRange< FFrameNumber > &OutRange) const
MOVIESCENE_API bool	HasAnyOneShotEntities () const
MOVIESCENE_API void	QueryOneShotEntities (const TRange< FFrameNumber > &QueryRange, FMovieSceneEvaluationFieldEntitySet &OutEntityIndices) const

Friends
struct	FMovieSceneEntityComponentFieldBuilder

Detailed Description

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.

Member Function Documentation

FindMetaData()

const FMovieSceneEvaluationFieldEntityMetaData * FMovieSceneEntityComponentField::FindMetaData ( const FMovieSceneEvaluationFieldEntityQuery &  InQuery ) const

inline

Retrieve the meta-data for an entity

Returns

The meta-data for an entity or nullptr if it has none associated with it

FindSharedMetaData()

const FMovieSceneEvaluationFieldSharedEntityMetaData * FMovieSceneEntityComponentField::FindSharedMetaData ( const FMovieSceneEvaluationFieldEntityQuery &  InQuery ) const

inline

Retrieve the shared meta-data for an entity

Returns

The shared meta-data for an entity or nullptr if it has none associated with it

GetEntity()

const FMovieSceneEvaluationFieldEntity & FMovieSceneEntityComponentField::GetEntity ( int32  EntityIndex ) const

inline

Retrieve an entity from its index

HasAnyOneShotEntities()

bool FMovieSceneEntityComponentField::HasAnyOneShotEntities

(

)

const

Check whether this field contains any one-shot entities

IsEmpty()

bool FMovieSceneEntityComponentField::IsEmpty ( ) const

inline

Check if this field is empty

QueryOneShotEntities()

void FMovieSceneEntityComponentField::QueryOneShotEntities	(	const TRange< FFrameNumber > &	QueryRange,
		FMovieSceneEvaluationFieldEntitySet &	OutEntityIndices
	)		const

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

Note

: One-shot entities only ever live for a single frame of evaluation.

Parameters

QueryRange	The ranger over which to query the field (in the TickResolution of the sequence this was generated from)
OutEntities	A set that will be populated with all the entities that overlapped at all with the specified range

QueryPersistentEntities() [1/2]

void FMovieSceneEntityComponentField::QueryPersistentEntities	(	FFrameNumber	QueryTime,
		TFunctionRef< bool(const FMovieSceneEvaluationFieldEntityQuery &)>	QueryCallback,
		TRange< FFrameNumber > &	OutRange
	)		const

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

Note

: Persistent entities should remain alive until they are no longer present at the current time.

Parameters

QueryTime	The time at which to query the field (in the TickResolution of the sequence this was generated from)
QueryCallback	A handler for dealing with the resulting entities
OutRange	Will receive the hull of the range that was intersected for which the resulting OutEntities remains constant

QueryPersistentEntities() [2/2]

void FMovieSceneEntityComponentField::QueryPersistentEntities	(	FFrameNumber	QueryTime,
		TRange< FFrameNumber > &	OutRange,
		FMovieSceneEvaluationFieldEntitySet &	OutEntities
	)		const

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

Note

: Persistent entities should remain alive until they are no longer present at the current time.

Parameters

QueryTime	The time at which to query the field (in the TickResolution of the sequence this was generated from)
OutRange	Will receive the hull of the range that was intersected for which the resulting OutEntities remains constant
OutEntities	A set that will be populated with all the entities that exist at the specified time

Friends And Related Symbol Documentation

FMovieSceneEntityComponentFieldBuilder

friend struct FMovieSceneEntityComponentFieldBuilder

friend

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationField.h
• Engine/Source/Runtime/MovieScene/Private/Evaluation/MovieSceneEvaluationField.cpp