UMovieSceneSubSection

Implements a section in sub-sequence tracks.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Sections/MovieSceneSubSection.h

Include

#include "Sections/MovieSceneSubSection.h"

Syntax

class UMovieSceneSubSection : public UMovieSceneSection

Remarks

Implements a section in sub-sequence tracks.

Variables

Name Description

Protected variable

TLazyObjectPtr<...

 

ActorToRecord

Target actor to record

Protected variable

FOnSequenceChan...

 

OnSequenceChangedDelegate

Delegate to fire when our sequence is changed in the property editor

Public variable

FMovieSceneSect...

 

Parameters

Protected variable

UMovieSceneSequ...

 

PreviousSubSequence

Previous sub sequence, restored if changed sub sequence is invalid

Protected variable

UMovieSceneSequ...

 

SubSequence

Movie scene being played by this section.

Protected variable

FDirectoryPath

 

TargetPathToRecordTo

Target path of sequence to record to

Protected variable

FString

 

TargetSequenceName

Target name of sequence to try to record to (will record automatically to another if this already exists)

Constructors

Name Description

Public function

UMovieSceneSubSection

(
    const FObjectInitializer& ObjIniti...
)

Object constructor.

Functions

Name Description

Protected function Const

void

 

BuildDefaultSubSectionComponents

Public function Virtual Const

FMovieSceneS...

 

GenerateSubSequenceData

(
    const FSubSequenceInstanceDataParam...
)

Generate subsequence data

Public function Static

AActor *

 

GetActorToRecord()

Get the actor we are targeting for recording

Public function Const

EMovieSceneS...

 

GetNetworkMask()

Public function Const

FString

 

GetPathNameInMovieScene()

Get the path name to this sub section from the outer moviescene

Public function Static

UMovieSceneS...

 

GetRecordingSection()

Get the section we are recording to

Public function Const

UMovieSceneS...

 

GetSequence()

Get the sequence that is assigned to this section.

Public function Const

FMovieSceneS...

 

GetSequenceID()

Get this sub section's sequence ID

Public function Const

const FStrin...

 

GetTargetPathToRecordTo()

Get the path of the sequence we are going to try to record to

Public function Const

const FStrin...

 

GetTargetSequenceName()

Get the name of the sequence we are going to try to record to

Public function Const

bool

 

GetValidatedInnerPlaybackRange

(
    TRange< FFrameNumber >& OutInnerPl...
)

Gets the playrange of the inner sequence, in the inner sequence's time space, trimmed with any start/end offsets, and validated to make sure we get at least a 1-frame long playback range (e.g. in the case where excessive trimming results in an invalid range).

Public function Static

TRange< FFra...

 

GetValidatedInnerPlaybackRange

(
    const FMovieSceneSectionParameters ...,
    const UMovieScene& InnerMovieScene
)

Helper function used by the above method, but accessible for other uses like track editors.

Public function Static

bool

 

IsSetAsRecording()

Check if we are primed for recording

Public function Const

FFrameNumber

 

MapTimeToSectionFrame

(
    FFrameTime InPosition
)

Public function

FOnSequenceC...

 

OnSequenceChanged()

Delegate to fire when our sequence is changed in the property editor

Public function Const

FMovieSceneS...

 

OuterToInnerTransform()

Gets the transform that converts time from this section's time-base to its inner sequence's

Public function

void

 

SetActorToRecord

(
    AActor* InActorToRecord
)

Set the target actor to record

Public function

void

 

SetAsRecording

(
    bool bRecord
)

Prime this section as the one and only recording section

Public function

void

 

SetNetworkMask

(
    EMovieSceneServerClientMask InNetwo...
)

Public function

void

 

SetSequence

(
    UMovieSceneSequence* Sequence
)

Sets the sequence played by this section.

Public function

void

 

SetTargetPathToRecordTo

(
    const FString& Path
)

Set the path of the sequence we are going to try to record to

Public function

void

 

SetTargetSequenceName

(
    const FString& Name
)

Set the name of the sequence we are going to try to record to

Overridden from UMovieSceneSection

Name Description

Public function Virtual Const

TOptional< T...

 

GetAutoSizeRange()

Returns the range to auto size this section to, if there is one.

Public function Virtual Const

TOptional< F...

 

GetOffsetTime()

The optional offset time of this section

Public function Virtual Const

void

 

GetSnapTimes

(
    TArray< FFrameNumber >& OutSnapTim...,
    bool bGetSectionBorders
)

Gets all snap times for this section

Public function Virtual

UMovieSceneS...

 

SplitSection

(
    FQualifiedFrameTime SplitTime,
    bool bDeleteKeys
)

Split a section in two at the split time

Public function Virtual

void

 

TrimSection

(
    FQualifiedFrameTime TrimTime,
    bool bTrimLeft,
    bool bDeleteKeys
)

Trim a section at the trim time

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Constants

Name

Description

TheRecordingSection

Keep track of our constructed recordings

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