UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneSequenceHierarchy Struct Reference

#include <MovieSceneSequenceHierarchy.h>

Public Member Functions

 FMovieSceneSequenceHierarchy ()
 
const FMovieSceneSequenceHierarchyNodeFindNode (FMovieSceneSequenceIDRef SequenceID) const
 
FMovieSceneSequenceHierarchyNodeFindNode (FMovieSceneSequenceIDRef SequenceID)
 
const FMovieSceneSubSequenceDataFindSubData (FMovieSceneSequenceIDRef SequenceID) const
 
FMovieSceneSubSequenceDataFindSubData (FMovieSceneSequenceIDRef SequenceID)
 
UMovieSceneSequenceFindSubSequence (FMovieSceneSequenceIDRef SequenceID) const
 
void Add (const FMovieSceneSubSequenceData &Data, FMovieSceneSequenceIDRef ThisSequenceID, FMovieSceneSequenceIDRef ParentID)
 
void Remove (TArrayView< const FMovieSceneSequenceID > SequenceIDs)
 
void AddRange (const TRange< FFrameNumber > &RootSpaceRange, FMovieSceneSequenceIDRef InSequenceID, ESectionEvaluationFlags InFlags)
 
void AddRange (const TRange< FFrameNumber > &RootSpaceRange, FMovieSceneSequenceIDRef InSequenceID, ESectionEvaluationFlags InFlags, FMovieSceneWarpCounter RootToSequenceWarpCounter)
 
FMovieSceneSubSequenceDataMutateSubData (FMovieSceneSequenceIDRef SequenceID)
 
void SetRootTransform (FMovieSceneSequenceTransform &&InTransform)
 
void AllSubSequenceIDs (TArray< FMovieSceneSequenceID > &OutSequenceIDs) const
 
const TMap< FMovieSceneSequenceID, FMovieSceneSubSequenceData > & AllSubSequenceData () const
 
const TMap< FMovieSceneSequenceID, FMovieSceneSequenceHierarchyNode > & AllSubSequenceNodes () const
 
const TMovieSceneEvaluationTree< FMovieSceneSubSequenceTreeEntry > & GetTree () const
 
EMovieSceneServerClientMask GetAccumulatedNetworkMask () const
 
void AccumulateNetworkMask (EMovieSceneServerClientMask Mask)
 
const FMovieSceneSequenceTransformGetRootTransform () const
 
void LogHierarchy () const
 
void LogSubSequenceTree () const
 

Detailed Description

Structure that stores hierarchical information pertaining to all sequences contained within a root sequence

Constructor & Destructor Documentation

◆ FMovieSceneSequenceHierarchy()

FMovieSceneSequenceHierarchy::FMovieSceneSequenceHierarchy ( )
inline

Member Function Documentation

◆ AccumulateNetworkMask()

void FMovieSceneSequenceHierarchy::AccumulateNetworkMask ( EMovieSceneServerClientMask  Mask)
inline

◆ Add()

void FMovieSceneSequenceHierarchy::Add ( const FMovieSceneSubSequenceData Data,
FMovieSceneSequenceIDRef  ThisSequenceID,
FMovieSceneSequenceIDRef  ParentID 
)

Add the specified sub sequence data to the hierarchy

Parameters
DataThe data to add
ThisSequenceIDThe sequence ID of the sequence the data relates to
ParentIDThe parent ID of this sequence data

◆ AddRange() [1/2]

void FMovieSceneSequenceHierarchy::AddRange ( const TRange< FFrameNumber > &  RootSpaceRange,
FMovieSceneSequenceIDRef  InSequenceID,
ESectionEvaluationFlags  InFlags 
)

Add an entry for the given sub sequence with the given root time range

◆ AddRange() [2/2]

void FMovieSceneSequenceHierarchy::AddRange ( const TRange< FFrameNumber > &  RootSpaceRange,
FMovieSceneSequenceIDRef  InSequenceID,
ESectionEvaluationFlags  InFlags,
FMovieSceneWarpCounter  RootToSequenceWarpCounter 
)

◆ AllSubSequenceData()

const TMap< FMovieSceneSequenceID, FMovieSceneSubSequenceData > & FMovieSceneSequenceHierarchy::AllSubSequenceData ( ) const
inline

Access to all the subsequence data

◆ AllSubSequenceIDs()

void FMovieSceneSequenceHierarchy::AllSubSequenceIDs ( TArray< FMovieSceneSequenceID > &  OutSequenceIDs) const
inline

Get all sub-sequence IDs

◆ AllSubSequenceNodes()

const TMap< FMovieSceneSequenceID, FMovieSceneSequenceHierarchyNode > & FMovieSceneSequenceHierarchy::AllSubSequenceNodes ( ) const
inline

Access to all the sub sequence nodes

◆ FindNode() [1/2]

FMovieSceneSequenceHierarchyNode * FMovieSceneSequenceHierarchy::FindNode ( FMovieSceneSequenceIDRef  SequenceID)
inline

Find the structural information for the specified sequence ID

Parameters
SequenceIDThe ID of the sequence to lookup
Returns
pointer to the structural information, or nullptr if the sequence ID does not exist in this hierarchy

◆ FindNode() [2/2]

const FMovieSceneSequenceHierarchyNode * FMovieSceneSequenceHierarchy::FindNode ( FMovieSceneSequenceIDRef  SequenceID) const
inline

Find the structural information for the specified sequence ID

Parameters
SequenceIDThe ID of the sequence to lookup
Returns
pointer to the structural information, or nullptr if the sequence ID does not exist in this hierarchy

◆ FindSubData() [1/2]

FMovieSceneSubSequenceData * FMovieSceneSequenceHierarchy::FindSubData ( FMovieSceneSequenceIDRef  SequenceID)
inline

Find the sub sequence and section information for the specified sequence ID

Parameters
SequenceIDThe ID of the sequence to lookup
Returns
pointer to the sequence/section information, or nullptr if the sequence ID does not exist in this hierarchy

◆ FindSubData() [2/2]

const FMovieSceneSubSequenceData * FMovieSceneSequenceHierarchy::FindSubData ( FMovieSceneSequenceIDRef  SequenceID) const
inline

Find the sub sequence and section information for the specified sequence ID

Parameters
SequenceIDThe ID of the sequence to lookup
Returns
pointer to the sequence/section information, or nullptr if the sequence ID does not exist in this hierarchy

◆ FindSubSequence()

UMovieSceneSequence * FMovieSceneSequenceHierarchy::FindSubSequence ( FMovieSceneSequenceIDRef  SequenceID) const
inline

Find the sub sequence for a given sequence ID, or nullptr if it was not found

Returns
pointer to the sequence, or nullptr if the sequence ID does not exist in this hierarchy

◆ GetAccumulatedNetworkMask()

EMovieSceneServerClientMask FMovieSceneSequenceHierarchy::GetAccumulatedNetworkMask ( ) const
inline

◆ GetRootTransform()

const FMovieSceneSequenceTransform & FMovieSceneSequenceHierarchy::GetRootTransform ( ) const
inline

◆ GetTree()

const TMovieSceneEvaluationTree< FMovieSceneSubSequenceTreeEntry > & FMovieSceneSequenceHierarchy::GetTree ( ) const
inline

◆ LogHierarchy()

void FMovieSceneSequenceHierarchy::LogHierarchy ( ) const

◆ LogSubSequenceTree()

void FMovieSceneSequenceHierarchy::LogSubSequenceTree ( ) const

◆ MutateSubData()

FMovieSceneSubSequenceData * FMovieSceneSequenceHierarchy::MutateSubData ( FMovieSceneSequenceIDRef  SequenceID)
inline

Mutate the sub-data for the specified sequence ID - only to be used during compilation

◆ Remove()

void FMovieSceneSequenceHierarchy::Remove ( TArrayView< const FMovieSceneSequenceID SequenceIDs)

Remove the specified sub sequence datas from the hierarchy.

◆ SetRootTransform()

void FMovieSceneSequenceHierarchy::SetRootTransform ( FMovieSceneSequenceTransform &&  InTransform)
inline

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