FMovieSceneEvaluationTree | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/MovieScene

A tree structure used to efficiently reference overlapping time ranges hierarchically. Each node represents a unique combination of 'entities' overlapping for a given range. Example structure (dependent on order of addition): Time -inf 10 20 25 30 inf [============= 0 ===========] [============= 1 ==================] [========================== 2 ==================================] [================== 3 ==========================] [================== 4 ==========================] [===== 5 ======]

Where each time range is added in order, this is represented as: [======== 3 =======][========== 0,2,3 ==========][============= 1,2 ================][============ 4 ===========] | \ [===== 5 ====] [======== 4 ========]

Unique Ranges [ 3 | 0,2,3 | 0,2,3,5 | 0,2,3 | 1,2 | 1,2,4 | 4 ]


Name	FMovieSceneEvaluationTree
Type	struct
Header File	/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvaluationTree.h
Include Path	#include "Evaluation/MovieSceneEvaluationTree.h"

Syntax

struct FMovieSceneEvaluationTree

Derived Classes

TMovieSceneEvaluationTree

Constructors

Name	Remarks	Include Path
FMovieSceneEvaluationTree ( const FMovieSceneEvaluationTree& RHS )		Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTree ()		Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTree ( FMovieSceneEvaluationTree&& RHS )	Move construction must ensure that the root node is correctly restored to its default to ensure that invariant	Evaluation/MovieSceneEvaluationTree.h

Functions

Public

Name	Remarks	Include Path
void AddTimeRange ( TRange< FFrameNumber > InTimeRange )	Insert the specified time range into this tree	Evaluation/MovieSceneEvaluationTree.h
TArrayView< FMovieSceneEvaluationTreeNode > GetChildren ( const FMovieSceneEvaluationTreeNode& InNode )	Get the children associated with the specified node	Evaluation/MovieSceneEvaluationTree.h
TArrayView< const FMovieSceneEvaluationTreeNode > GetChildren ( const FMovieSceneEvaluationTreeNode& InNode ) const	Get the children associated with the specified node	Evaluation/MovieSceneEvaluationTree.h
const FMovieSceneEvaluationTreeNode & GetNode ( FMovieSceneEvaluationTreeNodeHandle Handle ) const	Const access to a node from its handle. Handle must be valid.	Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTreeNode & GetNode ( FMovieSceneEvaluationTreeNodeHandle Handle )	Non-const access to a node from its handle. Handle must be valid.	Evaluation/MovieSceneEvaluationTree.h
const FMovieSceneEvaluationTreeNode & GetRootNode()	Access this tree's root node (infinite range)	Evaluation/MovieSceneEvaluationTree.h
bool IsValid ( FMovieSceneEvaluationTreeNodeHandle Handle ) const	Check whether the specified handle corresponds to a node within this tree	Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTreeRangeIterator IterateFromLowerBound ( TRangeBound< FFrameNumber > InStartingLowerBound ) const	Start iterating this tree from the specified lower boundary	Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTreeRangeIterator IterateFromTime ( FFrameNumber Time ) const	Start iterating this tree from the specified time	Evaluation/MovieSceneEvaluationTree.h
void Reset()		Evaluation/MovieSceneEvaluationTree.h

Protected

Name	Remarks	Include Path
void AddTimeRange ( TRange< FFrameNumber > InTimeRange, const IMovieSceneEvaluationTreeNodeOperator& InOperator, FMovieSceneEvaluationTreeNodeHandle InParent, const TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)>* Predicate )	Insert the specified time range into this tree	Evaluation/MovieSceneEvaluationTree.h
const FMovieSceneEvaluationTreeNode & GetNode ( FEvaluationTreeEntryHandle ChildrenID, int32 Index ) const	Const access to a node from its parent's ChildrenID and this node's index.	Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTreeNode & GetNode ( FEvaluationTreeEntryHandle ChildrenID, int32 Index )	Non-const access to a node from its parent's ChildrenID and this node's index.	Evaluation/MovieSceneEvaluationTree.h
void InsertNewChild ( TRange< FFrameNumber > InEffectiveRange, const IMovieSceneEvaluationTreeNodeOperator& InOperator, int32 InsertIndex, FMovieSceneEvaluationTreeNodeHandle InParent )	Helper function that creates a new child for the specified parent node	Evaluation/MovieSceneEvaluationTree.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FMovieSceneEvaluationTree & operator= ( const FMovieSceneEvaluationTree& RHS )		Evaluation/MovieSceneEvaluationTree.h
FMovieSceneEvaluationTree & operator= ( FMovieSceneEvaluationTree&& RHS )	Move assignment must ensure that the root node is correctly restored to its default to ensure that invariant	Evaluation/MovieSceneEvaluationTree.h

Navigation