UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TMovieSceneEvaluationTree< DataType > Struct Template Reference

#include <MovieSceneEvaluationTree.h>

+ Inheritance diagram for TMovieSceneEvaluationTree< DataType >:

Public Member Functions

bool IsEmpty () const
 
void Add (TRange< FFrameNumber > InTimeRange)
 
void AddUnique (TRange< FFrameNumber > InTimeRange, DataType InData)
 
void AddIfEmpty (TRange< FFrameNumber > InTimeRange, DataType InData)
 
void AddIfEmptySelective (TRange< FFrameNumber > InTimeRange, DataType InData, TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)> Predicate)
 
void AddSelective (TRange< FFrameNumber > InTimeRange, DataType InData, TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)> Predicate)
 
void Add (TRange< FFrameNumber > InTimeRange, DataType InData)
 
void Compact ()
 
void Reset ()
 
TArrayView< const DataType > GetDataForSingleNode (const FMovieSceneEvaluationTreeNode &InNode) const
 
TArrayView< DataType > GetMutableDataForSingleNode (const FMovieSceneEvaluationTreeNode &InNode)
 
TMovieSceneEvaluationTreeDataIterator< DataType > GetAllData (FMovieSceneEvaluationTreeNodeHandle NodeHandle) const
 
- Public Member Functions inherited from FMovieSceneEvaluationTree
 FMovieSceneEvaluationTree ()
 
 FMovieSceneEvaluationTree (const FMovieSceneEvaluationTree &RHS)=default
 
FMovieSceneEvaluationTreeoperator= (const FMovieSceneEvaluationTree &RHS)=default
 
 FMovieSceneEvaluationTree (FMovieSceneEvaluationTree &&RHS)
 
FMovieSceneEvaluationTreeoperator= (FMovieSceneEvaluationTree &&RHS)
 
MOVIESCENE_API FMovieSceneEvaluationTreeRangeIterator IterateFromTime (FFrameNumber Time) const
 
MOVIESCENE_API FMovieSceneEvaluationTreeRangeIterator IterateFromLowerBound (TRangeBound< FFrameNumber > InStartingLowerBound) const
 
const FMovieSceneEvaluationTreeNodeGetRootNode () const
 
FMovieSceneEvaluationTreeNodeGetNode (FMovieSceneEvaluationTreeNodeHandle Handle)
 
const FMovieSceneEvaluationTreeNodeGetNode (FMovieSceneEvaluationTreeNodeHandle Handle) const
 
MOVIESCENE_API TArrayView< const FMovieSceneEvaluationTreeNodeGetChildren (const FMovieSceneEvaluationTreeNode &InNode) const
 
MOVIESCENE_API TArrayView< FMovieSceneEvaluationTreeNodeGetChildren (const FMovieSceneEvaluationTreeNode &InNode)
 
bool IsValid (FMovieSceneEvaluationTreeNodeHandle Handle) const
 
void Reset ()
 
MOVIESCENE_API void AddTimeRange (TRange< FFrameNumber > InTimeRange)
 

Friends

struct TMovieSceneEvaluationTreeFormatter< DataType >
 
FArchiveoperator<< (FArchive &Ar, TMovieSceneEvaluationTree< DataType > &In)
 
bool operator== (const TMovieSceneEvaluationTree< DataType > &A, const TMovieSceneEvaluationTree< DataType > &B)
 

Additional Inherited Members

- Protected Member Functions inherited from FMovieSceneEvaluationTree
FMovieSceneEvaluationTreeNodeGetNode (FEvaluationTreeEntryHandle ChildrenID, int32 Index)
 
const FMovieSceneEvaluationTreeNodeGetNode (FEvaluationTreeEntryHandle ChildrenID, int32 Index) const
 
MOVIESCENE_API void AddTimeRange (TRange< FFrameNumber > InTimeRange, const IMovieSceneEvaluationTreeNodeOperator &InOperator, FMovieSceneEvaluationTreeNodeHandle InParent, const TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)> *Predicate)
 
MOVIESCENE_API void InsertNewChild (TRange< FFrameNumber > InEffectiveRange, const IMovieSceneEvaluationTreeNodeOperator &InOperator, int32 InsertIndex, FMovieSceneEvaluationTreeNodeHandle InParent)
 
- Protected Attributes inherited from FMovieSceneEvaluationTree
FMovieSceneEvaluationTreeNode RootNode
 
TEvaluationTreeEntryContainer< FMovieSceneEvaluationTreeNodeChildNodes
 

Detailed Description

template<typename DataType>
struct TMovieSceneEvaluationTree< DataType >

Templated version of FMovieSceneEvaluationTree that is also able to associate arbitrary data with nodes

Member Function Documentation

◆ Add() [1/2]

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::Add ( TRange< FFrameNumber InTimeRange)
inline

Add a time range with no data associated

Parameters
InTimeRangeThe range with which this data should be associated

◆ Add() [2/2]

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::Add ( TRange< FFrameNumber InTimeRange,
DataType  InData 
)
inline

Add a new time range with the associated data to the tree.

Parameters
InTimeRangeThe range with which this data should be associated
InDataThe data to assoicate with this time range

◆ AddIfEmpty()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::AddIfEmpty ( TRange< FFrameNumber InTimeRange,
DataType  InData 
)
inline

Adds a new time range with the associated data to the tree, only for segments where there's no data yet.

Parameters
InTimeRangeThe range with which this data should be associated
InDataThe data to assoicate with this time range

◆ AddIfEmptySelective()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::AddIfEmptySelective ( TRange< FFrameNumber InTimeRange,
DataType  InData,
TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)>  Predicate 
)
inline

Adds a new time range with the associated data to the tree, only for segments where there's no data yet.

Parameters
InTimeRangeThe range with which this data should be associated
InDataThe data to assoicate with this time range

◆ AddSelective()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::AddSelective ( TRange< FFrameNumber InTimeRange,
DataType  InData,
TFunctionRef< bool(FMovieSceneEvaluationTreeNodeHandle)>  Predicate 
)
inline

Add a new time range with the associated data to the tree.

Parameters
InTimeRangeThe range with which this data should be associated
InDataThe data to assoicate with this time range

◆ AddUnique()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::AddUnique ( TRange< FFrameNumber InTimeRange,
DataType  InData 
)
inline

Add a new time range with the associated data to the tree. Ensures no duplicates.

Parameters
InTimeRangeThe range with which this data should be associated
InDataThe data to assoicate with this time range

◆ Compact()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::Compact ( )
inline

Compact the memory used by this tree so it's using as little as possible

◆ GetAllData()

template<typename DataType >
TMovieSceneEvaluationTreeDataIterator< DataType > TMovieSceneEvaluationTree< DataType >::GetAllData ( FMovieSceneEvaluationTreeNodeHandle  NodeHandle) const
inline

Create an iterator that will iterate all data associated with the specified node

Parameters
NodeHandleThe node to get all data for

◆ GetDataForSingleNode()

template<typename DataType >
TArrayView< const DataType > TMovieSceneEvaluationTree< DataType >::GetDataForSingleNode ( const FMovieSceneEvaluationTreeNode InNode) const
inline

Access the data associated with a single node in the tree.

◆ GetMutableDataForSingleNode()

template<typename DataType >
TArrayView< DataType > TMovieSceneEvaluationTree< DataType >::GetMutableDataForSingleNode ( const FMovieSceneEvaluationTreeNode InNode)
inline

Access the data associated with a single node in the tree.

◆ IsEmpty()

template<typename DataType >
bool TMovieSceneEvaluationTree< DataType >::IsEmpty ( ) const
inline

Check whether this tree is empty

◆ Reset()

template<typename DataType >
void TMovieSceneEvaluationTree< DataType >::Reset ( )
inline

Reset this tree

Friends And Related Symbol Documentation

◆ operator<<

template<typename DataType >
FArchive & operator<< ( FArchive Ar,
TMovieSceneEvaluationTree< DataType > &  In 
)
friend

Serialization operator

◆ operator==

template<typename DataType >
bool operator== ( const TMovieSceneEvaluationTree< DataType > &  A,
const TMovieSceneEvaluationTree< DataType > &  B 
)
friend

Equality operator

◆ TMovieSceneEvaluationTreeFormatter< DataType >

template<typename DataType >
friend struct TMovieSceneEvaluationTreeFormatter< DataType >
friend

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