FSubSequencePath

A path of unaccumulated sequence IDs ordered from child->parent->grandparent that is used to generate unique sequenceIDs for inner sequences Optimized for Remap rather than Push/Pop by keeping sequence IDs child-parent order (the order they are required for remapping)

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneRootOverridePath.h

Include

#include "Evaluation/MovieSceneRootOverridePath.h"

Syntax

struct FSubSequencePath

Remarks

A path of unaccumulated sequence IDs ordered from child->parent->grandparent that is used to generate unique sequenceIDs for inner sequences Optimized for Remap rather than Push/Pop by keeping sequence IDs child-parent order (the order they are required for remapping)

Constructors

Name Description

Public function

FSubSequencePath()

Default construction to a root path

Public function

FSubSequencePath

(
    FMovieSceneSequenceID LeafID,
    IMovieScenePlayer& Player
)

Set up this path from a specific sequence ID that points to a particular sequence in the specified hierarchy

Public function

FSubSequencePath

(
    FMovieSceneSequenceID LeafID,
    const FMovieSceneSequenceHierarchy ...
)

Set up this path from a specific sequence ID that points to a particular sequence in the specified hierarchy

Functions

Name Description

Public function Const

bool

 

Contains

(
    FMovieSceneSequenceID SequenceID
)

Check whether this path contains the specified sequence ID

Public function Static

FMovieSceneS...

 

FindCommonParent

(
    const FSubSequencePath& A,
    const FSubSequencePath& B
)

Find the first parent sequence ID that is common to both A and B

Public function Const

FMovieSceneS...

 

MakeLocalSequenceID

(
    FMovieSceneSequenceID ParentSequenc...
)

Public function Const

FMovieSceneS...

 

MakeLocalSequenceID

(
    FMovieSceneSequenceID ParentSequenc...,
    FMovieSceneSequenceID TargetSequenc...
)

Public function Const

int32

 

NumGenerationsFromLeaf

(
    FMovieSceneSequenceID SequenceID
)

Return the number of generations between this path's leaf node, and the specified sequence ID

Public function Const

int32

 

NumGenerationsFromRoot

(
    FMovieSceneSequenceID SequenceID
)

Return the number of generations between the root and the specified sequence ID

Public function

void

 

PopGenerations

(
    int32 NumGenerations
)

Public function

void

 

PopTo

(
    FMovieSceneSequenceID ParentSequenc...
)

Public function

void

 

PushGeneration

(
    FMovieSceneSequenceID AccumulatedSe...,
    FMovieSceneSequenceID Unaccumulated...
)

Public function

void

 

Reset()

Reset this path to its default state (pointing to the root sequence)

Public function

void

 

Reset

(
    FMovieSceneSequenceID LeafID,
    const FMovieSceneSequenceHierarchy ...
)

Set up this path from a specific sequence ID that points to a particular sequence in the specified hierarchy

Public function Const

FMovieSceneS...

 

ResolveChildSequenceID

(
    FMovieSceneSequenceID SequenceID
)

Remap the specified sequence ID based on the currently evaluating sequence path, to the Root

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss