#include <MovieSceneEvaluationTrack.h>

Public Member Functions
	FMovieSceneEvaluationTrack ()

MOVIESCENE_API	FMovieSceneEvaluationTrack (const FGuid &InObjectBindingID)

	FMovieSceneEvaluationTrack (const FMovieSceneEvaluationTrack &)=default

FMovieSceneEvaluationTrack &	operator= (const FMovieSceneEvaluationTrack &)=default

	FMovieSceneEvaluationTrack (FMovieSceneEvaluationTrack &&)=default

FMovieSceneEvaluationTrack &	operator= (FMovieSceneEvaluationTrack &&)=default

const FGuid &	GetObjectBindingID () const

TArrayView< FMovieSceneEvalTemplatePtr >	GetChildTemplates ()

TArrayView< const FMovieSceneEvalTemplatePtr >	GetChildTemplates () const

const FMovieSceneEvalTemplate &	GetChildTemplate (int32 TemplateIndex) const

bool	HasChildTemplate (int32 TemplateIndex) const

FName	GetEvaluationGroup () const

void	SetEvaluationGroup (FName InEvaluationGroup)

uint16	GetEvaluationPriority () const

void	SetEvaluationPriority (uint16 InEvaluationPriority=1000)

EEvaluationMethod	GetEvaluationMethod () const

void	SetEvaluationMethod (EEvaluationMethod InMethod)

void	SetPreAndPostrollConditions (bool bInEvaluateInPreroll, bool bInEvaluateInPostroll)

bool	ShouldEvaluateInPreroll () const

bool	ShouldEvaluateInPostroll () const

void	PrioritizeTearDown ()

bool	HasTearDownPriority () const

void	Initialize (TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children, const FMovieSceneEvaluationOperand &Operand, const FMovieSceneContext &Context, FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const

void	Evaluate (TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children, const FMovieSceneEvaluationOperand &Operand, const FMovieSceneContext &Context, const FPersistentEvaluationData &PersistentData, FMovieSceneExecutionTokens &ExecutionTokens) const

MOVIESCENE_API void	DefaultInitialize (TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children, const FMovieSceneEvaluationOperand &Operand, FMovieSceneContext Context, FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const

MOVIESCENE_API void	DefaultEvaluate (TArrayView< const FMovieSceneFieldEntry_ChildTemplate > Children, const FMovieSceneEvaluationOperand &Operand, const FMovieSceneContext &Context, const FPersistentEvaluationData &PersistentData, FMovieSceneExecutionTokens &ExecutionTokens) const

MOVIESCENE_API void	Interrogate (const FMovieSceneContext &Context, FMovieSceneInterrogationData &Container, UObject *BindingOverride=nullptr) const

MOVIESCENE_API void	DefineAsSingleTemplate (FMovieSceneEvalTemplatePtr &&InTemplate)

MOVIESCENE_API int32	AddChildTemplate (FMovieSceneEvalTemplatePtr &&InTemplate)

void	SetSourceTrack (UMovieSceneTrack *InSourceTrack)

UMovieSceneTrack *	GetSourceTrack () const

template<typename T >
TEnableIf< TPointerIsConvertibleFromTo< T, FMovieSceneTrackImplementation >::Value >::Type	SetTrackImplementation (T &&InImpl)

MOVIESCENE_API void	SetupOverrides ()

MOVIESCENE_API void	PostSerialize (const FArchive &Ar)

bool	HasCustomInitialize () const

void	OnBeginEvaluation (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const

void	OnEndEvaluation (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const

Detailed Description

Evaluation track that is stored within an evaluation template for a sequence. Contains user-defined evaluation templates, and an optional track implementation

Constructor & Destructor Documentation

◆ FMovieSceneEvaluationTrack() [1/4]

FMovieSceneEvaluationTrack::FMovieSceneEvaluationTrack ( )

Default construction (only for serialization)

◆ FMovieSceneEvaluationTrack() [2/4]

FMovieSceneEvaluationTrack::FMovieSceneEvaluationTrack ( const FGuid & InObjectBindingID )

User construction, for initialization during compilation

◆ FMovieSceneEvaluationTrack() [3/4]

FMovieSceneEvaluationTrack::FMovieSceneEvaluationTrack ( const FMovieSceneEvaluationTrack & )

default

Copy construction/assignment

◆ FMovieSceneEvaluationTrack() [4/4]

FMovieSceneEvaluationTrack::FMovieSceneEvaluationTrack ( FMovieSceneEvaluationTrack && )

default

Move construction/assignment

Member Function Documentation

◆ AddChildTemplate()

int32 FMovieSceneEvaluationTrack::AddChildTemplate ( FMovieSceneEvalTemplatePtr && InTemplate )

Add an evaluation template to this track with the given track index

Parameters

InTemplate The template to insert

Returns: The index of the new template

◆ DefaultEvaluate()

void FMovieSceneEvaluationTrack::DefaultEvaluate	(	TArrayView< const FMovieSceneFieldEntry_ChildTemplate >	Children,
		const FMovieSceneEvaluationOperand &	Operand,
		const FMovieSceneContext &	Context,
		const FPersistentEvaluationData &	PersistentData,
		FMovieSceneExecutionTokens &	ExecutionTokens
	)		const

Default implementation of evaluation of child templates for the specified segment

Parameters

SegmentID	The segment we are evaluating
Operand	Operand that relates to the thing we will animate
Context	Current sequence context
PersistentData	Persistent data store
ExecutionTokens	Token stack on which to add tokens that will be executed later

◆ DefaultInitialize()

void FMovieSceneEvaluationTrack::DefaultInitialize	(	TArrayView< const FMovieSceneFieldEntry_ChildTemplate >	Children,
		const FMovieSceneEvaluationOperand &	Operand,
		FMovieSceneContext	Context,
		FPersistentEvaluationData &	PersistentData,
		IMovieScenePlayer &	Player
	)		const

Default implementation of initialization of child templates for the specified segment

Parameters

SegmentID	The segment we are evaluating
Operand	Operand that relates to the thing we will animate
Context	Current sequence context
PersistentData	Persistent data store
Player	The player that is responsible for playing back this template

◆ DefineAsSingleTemplate()

void FMovieSceneEvaluationTrack::DefineAsSingleTemplate ( FMovieSceneEvalTemplatePtr && InTemplate )

Assign a single eval template to this track, spanning the entire sequence

Parameters

InTemplate The template to insert

◆ Evaluate()

void FMovieSceneEvaluationTrack::Evaluate	(	TArrayView< const FMovieSceneFieldEntry_ChildTemplate >	Children,
		const FMovieSceneEvaluationOperand &	Operand,
		const FMovieSceneContext &	Context,
		const FPersistentEvaluationData &	PersistentData,
		FMovieSceneExecutionTokens &	ExecutionTokens
	)		const

Called to evaluate the specified segment index

Parameters

SegmentID	The segment we are evaluating
Operand	Operand that relates to the thing we will animate
Context	Current sequence context
PersistentData	Persistent data store
ExecutionTokens	Token stack on which to add tokens that will be executed later

◆ GetChildTemplate()

const FMovieSceneEvalTemplate & FMovieSceneEvaluationTrack::GetChildTemplate ( int32 TemplateIndex ) const

inline

Get the template from the given template index

◆ GetChildTemplates() [1/2]

TArrayView< FMovieSceneEvalTemplatePtr > FMovieSceneEvaluationTrack::GetChildTemplates ( )

inline

Get this track's child templates NOTE that this is intended for use during the compilation phase in-editor. Beware of using this to modify templates afterwards as it will almost certainly break evaluation.

◆ GetChildTemplates() [2/2]

TArrayView< const FMovieSceneEvalTemplatePtr > FMovieSceneEvaluationTrack::GetChildTemplates ( ) const

inline

Get this track's child templates

◆ GetEvaluationGroup()

FName FMovieSceneEvaluationTrack::GetEvaluationGroup ( ) const

inline

Get this track's evaluation group name. Only used during compilation.

Returns: The evaluation group

◆ GetEvaluationMethod()

EEvaluationMethod FMovieSceneEvaluationTrack::GetEvaluationMethod ( ) const

inline

Get the method we should use to evaluate this track

Returns: The method to use when evaluating this track

◆ GetEvaluationPriority()

uint16 FMovieSceneEvaluationTrack::GetEvaluationPriority ( ) const

inline

Get the evaluation bias to apply to this track. Higher priority tracks will be evaluated first.

Returns: The evaluation priority

◆ GetObjectBindingID()

const FGuid & FMovieSceneEvaluationTrack::GetObjectBindingID ( ) const

inline

Get the object binding ID that this track belongs to

◆ GetSourceTrack()

UMovieSceneTrack * FMovieSceneEvaluationTrack::GetSourceTrack ( ) const

inline

Get the source track from which this track originates

◆ HasChildTemplate()

bool FMovieSceneEvaluationTrack::HasChildTemplate ( int32 TemplateIndex ) const

inline

Check whether we have a valid child template for the specified index

◆ HasCustomInitialize()

bool FMovieSceneEvaluationTrack::HasCustomInitialize ( ) const

inline

◆ HasTearDownPriority()

bool FMovieSceneEvaluationTrack::HasTearDownPriority ( ) const

inline

Check whether this track has tear down priority or not

◆ Initialize()

void FMovieSceneEvaluationTrack::Initialize	(	TArrayView< const FMovieSceneFieldEntry_ChildTemplate >	Children,
		const FMovieSceneEvaluationOperand &	Operand,
		const FMovieSceneContext &	Context,
		FPersistentEvaluationData &	PersistentData,
		IMovieScenePlayer &	Player
	)		const

Called to initialize the specified segment index

Parameters

SegmentID	The segment we are evaluating
Operand	Operand that relates to the thing we will animate
Context	Current sequence context
PersistentData	Persistent data store
Player	The player that is responsible for playing back this template

◆ Interrogate()

void FMovieSceneEvaluationTrack::Interrogate	(	const FMovieSceneContext &	Context,
		FMovieSceneInterrogationData &	Container,
		UObject *	BindingOverride = `nullptr`
	)		const

Interrogate this template for its output. Should not have any side effects.

Parameters

Context	Evaluation context specifying the current evaluation time, sub sequence transform and other relevant information.
Container	Container to populate with the desired output from this track
BindingOverride	Optional binding to specify the object that is being animated by this track

◆ OnBeginEvaluation()

void FMovieSceneEvaluationTrack::OnBeginEvaluation	(	FPersistentEvaluationData &	PersistentData,
		IMovieScenePlayer &	Player
	)		const

inline

Called before this track is evaluated for the first time, or since OnEndEvaluation has been called

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

◆ OnEndEvaluation()

void FMovieSceneEvaluationTrack::OnEndEvaluation	(	FPersistentEvaluationData &	PersistentData,
		IMovieScenePlayer &	Player
	)		const

inline

Called after this track is no longer being evaluated

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

◆ operator=() [1/2]

FMovieSceneEvaluationTrack & FMovieSceneEvaluationTrack::operator= ( const FMovieSceneEvaluationTrack & )

default

◆ operator=() [2/2]

FMovieSceneEvaluationTrack & FMovieSceneEvaluationTrack::operator= ( FMovieSceneEvaluationTrack && )

default

◆ PostSerialize()

void FMovieSceneEvaluationTrack::PostSerialize ( const FArchive & Ar )

Post serialize function

◆ PrioritizeTearDown()

void FMovieSceneEvaluationTrack::PrioritizeTearDown ( )

inline

Tell this track to prioritize its tear down over other tracks, regardless of evaluation priority

◆ SetEvaluationGroup()

void FMovieSceneEvaluationTrack::SetEvaluationGroup ( FName InEvaluationGroup )

inline

Set this track's flush group name.

Note: When not 'None', setting an evaluation group indicates that all tracks with similar groups and priorities should be grouped together at runtime. Named groups can be optionally flushed immediately at runtime by calling IMovieSceneTemplateGenerator::FlushGroupImmediately with the appropriate group.

Parameters

InEvaluationGroup The evaluation group to assign this track to

◆ SetEvaluationMethod()

void FMovieSceneEvaluationTrack::SetEvaluationMethod ( EEvaluationMethod InMethod )

inline

Set the method we should use to evaluate this track

Parameters

InMethod The method to use when evaluating this track

◆ SetEvaluationPriority()

void FMovieSceneEvaluationTrack::SetEvaluationPriority ( uint16 InEvaluationPriority = 1000 )

inline

Get the evaluation bias to apply to this track. Higher priority tracks will be evaluated first.

Parameters

InEvaluationPriority The new priority

◆ SetPreAndPostrollConditions()

void FMovieSceneEvaluationTrack::SetPreAndPostrollConditions	(	bool	bInEvaluateInPreroll,
		bool	bInEvaluateInPostroll
	)

inline

Define how this track evaluates in pre and postroll

Parameters

bInEvaluateInPreroll	Whether this track should evaluate in preroll
bInEvaluateInPostroll	Whether this track should evaluate in postroll

◆ SetSourceTrack()

void FMovieSceneEvaluationTrack::SetSourceTrack ( UMovieSceneTrack * InSourceTrack )

inline

Set the source track from which this track originates

◆ SetTrackImplementation()

template<typename T >

TEnableIf< TPointerIsConvertibleFromTo< T, FMovieSceneTrackImplementation >::Value >::Type FMovieSceneEvaluationTrack::SetTrackImplementation ( T && InImpl )

inline

Assign a track implementation template to this track

Note: Track implementations are evaluated once per frame before any segments.

Parameters

InImplementation The track implementation to use

◆ SetupOverrides()

void FMovieSceneEvaluationTrack::SetupOverrides ( )

Setup overrides for any contained templates

◆ ShouldEvaluateInPostroll()

bool FMovieSceneEvaluationTrack::ShouldEvaluateInPostroll ( ) const

inline

Returns: Whether this track should evaluate in postroll

◆ ShouldEvaluateInPreroll()

bool FMovieSceneEvaluationTrack::ShouldEvaluateInPreroll ( ) const

inline

Returns: Whether this track should evaluate in preroll

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

Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationTrack.h
Engine/Source/Runtime/MovieScene/Private/Evaluation/MovieSceneEvaluationTrack.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FMovieSceneEvaluationTrack() [1/4]

◆ FMovieSceneEvaluationTrack() [2/4]

◆ FMovieSceneEvaluationTrack() [3/4]

◆ FMovieSceneEvaluationTrack() [4/4]

Member Function Documentation

◆ AddChildTemplate()

◆ DefaultEvaluate()

◆ DefaultInitialize()

◆ DefineAsSingleTemplate()

◆ Evaluate()

◆ GetChildTemplate()

◆ GetChildTemplates() [1/2]

◆ GetChildTemplates() [2/2]

◆ GetEvaluationGroup()

◆ GetEvaluationMethod()

◆ GetEvaluationPriority()

◆ GetObjectBindingID()

◆ GetSourceTrack()

◆ HasChildTemplate()

◆ HasCustomInitialize()

◆ HasTearDownPriority()

◆ Initialize()

◆ Interrogate()

◆ OnBeginEvaluation()

◆ OnEndEvaluation()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PostSerialize()

◆ PrioritizeTearDown()

◆ SetEvaluationGroup()

◆ SetEvaluationMethod()

◆ SetEvaluationPriority()

◆ SetPreAndPostrollConditions()

◆ SetSourceTrack()

◆ SetTrackImplementation()

◆ SetupOverrides()

◆ ShouldEvaluateInPostroll()

◆ ShouldEvaluateInPreroll()