UMovieSceneSection

Base class for movie scene sections

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSignedObject

UMovieSceneSection

UMovieScene2DTransformSection

UMovieScene3DConstraintSection

UMovieScene3DAttachSection

UMovieScene3DPathSection

UMovieScene3DTransformSection

UMovieSceneActorReferenceSection

UMovieSceneAudioSection

UMovieSceneBoolSection

UMovieSceneSpawnSection

UMovieSceneByteSection

UMovieSceneCameraAnimSection

UMovieSceneCameraCutSection

UMovieSceneCameraShakeSection

UMovieSceneCameraShakeSourceShakeSection

UMovieSceneCameraShakeSourceTriggerSection

UMovieSceneColorSection

UMovieSceneComposureExportSection

UMovieSceneComposurePostMoveSettingsSection

UMovieSceneDMXLibrarySection

UMovieSceneEnumSection

UMovieSceneEventSection

UMovieSceneEventSectionBase

UMovieSceneEventRepeaterSection

UMovieSceneEventTriggerSection

UMovieSceneFadeSection

UMovieSceneFloatSection

UMovieSceneGeometryCacheSection

UMovieSceneGeometryCollectionSection

UMovieSceneGroomCacheSection

UMovieSceneHookSection

UMovieSceneGameplayCueSection

UMovieSceneGameplayCueTriggerSection

UMovieSceneImagePlateSection

UMovieSceneIntegerSection

UMovieSceneLevelVisibilitySection

UMovieSceneLiveLinkSection

UMovieSceneMarginSection

UMovieSceneMediaPlayerPropertySection

UMovieSceneMediaSection

UMovieSceneNiagaraSystemSpawnSection

UMovieSceneObjectPropertySection

UMovieSceneParameterSection

UMovieSceneControlRigParameterSection

UMovieSceneParticleSection

UMovieScenePrimitiveMaterialSection

UMovieSceneReplaySection

UMovieSceneSkeletalAnimationSection

UMovieSceneSlomoSection

UMovieSceneStringSection

UMovieSceneSubSection

UMovieSceneCinematicShotSection

UTemplateSequenceSection

UMovieSceneTakeSection

UMovieSceneVectorSection

USequencerSectionBP

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/MovieSceneSection.h

Include

#include "MovieSceneSection.h"

Syntax

class UMovieSceneSection : public UMovieSceneSignedObject

Remarks

Base class for movie scene sections

Variables

Name Description

Protected variable

FOptionalMovieS...

 

BlendType

Protected variable

bool

 

bSupportsInfiniteRange

Does this section support infinite ranges in the track editor?

Protected variable

TSharedPtr< FMo...

 

ChannelProxy

Channel proxy that contains all the channels in this section - must be populated and invalidated by derived types.

Protected variable

EMovieSceneChan...

 

ChannelProxyType

Defines whether the channel proxy can change over the lifetime of the section

Public variable

FMovieSceneEasi...

 

Easing

Public variable

FMovieSceneSect...

 

EvalOptions

Public variable

FMovieSceneFram...

 

SectionRange

The range in which this section is active

Public variable

FMovieSceneTime...

 

TimecodeSource

The timecode at which this movie scene section is based (ie. when it was recorded)

Constructors

Name Description

Public function

UMovieSceneSection

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

BuildDefaultComponents

Public function Const

TRange< FFra...

 

ComputeEffectiveRange()

Return the range within which this section is effective.

Public function Const

void

 

EvaluateEasing

(
    FFrameTime InTime,
    TOptional< float >& OutEaseInValue,
    TOptional< float >& OutEaseOutValu...,
    float* OutEaseInInterp,
    float* OutEaseOutInterp
)

Evaluate this sections's easing functions based on the specified time

Public function Const

float

 

EvaluateEasing

(
    FFrameTime InTime
)

Evaluate this sections's easing functions based on the specified time

Public function

void

 

ExpandToFrame

(
    FFrameNumber InFrame
)

Expands this section's range to include the specified time

Public function Virtual Const

TOptional< T...

 

GetAutoSizeRange()

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

Public function Const

FOptionalMov...

 

GetBlendType()

Gets this section's blend type

Public function Const

FMovieSceneC...

 

GetChannelProxy()

Access this section's channel proxy, containing pointers to all existing data channels in this section @note Proxy can be reallocated at any time; this accessor is only for immediate use.

Public function Const

EMovieSceneC...

 

GetCompletionMode()

Gets this section's completion mode

Public function Const

TRange< FFra...

 

GetEaseInRange()

Public function Const

TRange< FFra...

 

GetEaseOutRange()

Public function Const

FFrameNumber

 

GetExclusiveEndFrame()

Gets the first frame number after the end of this section

Public function Const

FFrameNumber

 

GetInclusiveStartFrame()

Gets the frame number at which this section starts

Public function Virtual

TSharedPtr< ...

 

GetKeyStruct

(
    TArrayView< const FKeyHandle > KeyH...
)

Get the data structure representing the specified keys.

Public function Virtual Const

TOptional< F...

 

GetOffsetTime()

The optional offset time of this section

Public function

void

 

GetOverlappingSections

(
    TArray< UMovieSceneSection* > ...,
    bool bSameRow,
    bool bIncludeThis
)

Gets a list of all overlapping sections

Public function Const

int32

 

GetOverlapPriority()

Gets this section's priority over overlapping sections (higher wins)

Public function Const

int32

 

GetPostRollFrames()

Public function Const

int32

 

GetPreRollFrames()

Public function Const

TRange< FFra...

 

GetRange()

Public function Virtual

void

 

GetReferencedBindings

(
    TArray< FGuid >& OutBindings
)

Get the referenced bindings for this section

Public function Const

int32

 

GetRowIndex()

Gets the row index for this section

Public function Virtual Const

void

 

GetSnapTimes

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

Gets all snap times for this section

Public function Const

FMovieSceneB...

 

GetSupportedBlendTypes()

Gets what kind of blending is supported by this section

Public function Const

bool

 

GetSupportsInfiniteRange()

Does this movie section support infinite ranges for evaluation

Public function Virtual Const

float

 

GetTotalWeightValue

(
    FFrameTime InTime
)

Get The Total Weight Value for this Section For Most Sections it's just the Ease Value, but for some Sections also have an extra Weight Curve

Public function Const

TRange< FFra...

 

GetTrueRange()

A true representation of this section's range with an inclusive start frame and an exclusive end frame.

Public function Const

bool

 

HasEndFrame()

Check whether this section has an end frame (else infinite)

Public function Const

bool

 

HasStartFrame()

Check whether this section has a start frame (else infinite)

Public function Virtual

void

 

InitialPlacement

(
    const TArray< UMovieSceneSection&#...,
    FFrameNumber InStartTime,
    int32 InDuration,
    bool bAllowMultipleRows
)

Places this section at the first valid row at the specified time. Good for placement upon creation.

Public function Virtual

void

 

InitialPlacementOnRow

(
    const TArray< UMovieSceneSection&#...,
    FFrameNumber InStartTime,
    int32 InDuration,
    int32 InRowIndex
)

Places this section at the specified row at the specified time.

Public function Const

bool

 

IsActive()

Public function Const

bool

 

IsLocked()

Public function Const

bool

 

IsReadOnly()

A section is read only if it or its outer movie are read only

Public function Const

bool

 

IsTimeWithinSection

(
    FFrameNumber Position
)

Returns whether or not a provided position in time is within the timespan of the section

Public function

void

 

MoveSection

(
    FFrameNumber DeltaTime
)

Moves the section by a specific amount of time

Public function Virtual

void

 

OnBindingsUpdated

(
    const TMap< FGuid, FGuid >& OldGui...
)

When guid bindings are updated to allow this section to fix-up any internal bindings

Protected function Virtual

void

 

OnDilated

(
    float DilationFactor,
    FFrameNumber Origin
)

Protected function Virtual

void

 

OnMoved

(
    int32 DeltaTime
)

Public function Virtual Const

const UMovie...

 

OverlapsWithSections

(
    const TArray< UMovieSceneSection&#...,
    int32 TrackDelta,
    int32 TimeDelta
)

Checks to see if this section overlaps with an array of other sections given an optional time and track delta.

Public function Virtual

void

 

SetBlendType

(
    EMovieSceneBlendType InBlendType
)

Sets this section's blend type

Public function

void

 

SetCompletionMode

(
    EMovieSceneCompletionMode InComplet...
)

Sets this section's completion mode

Public function Virtual

void

 

SetEndFrame

(
    TRangeBound< FFrameNumber > NewEndF...
)

Set this section's end frame in sequence resolution space @note Will be clamped to the current start frame if necessary

Public function

void

 

SetIsActive

(
    bool bInIsActive
)

Whether or not this section is active.

Public function

void

 

SetIsLocked

(
    bool bInIsLocked
)

Whether or not this section is locked.

Public function

void

 

SetOverlapPriority

(
    int32 NewPriority
)

Sets this section's priority over overlapping sections (higher wins)

Public function

void

 

SetPostRollFrames

(
    int32 InPostRollFrames
)

Gets/sets the number of frames to continue 'postrolling' this section for after evaluation has ended.

Public function

void

 

SetPreRollFrames

(
    int32 InPreRollFrames
)

Gets the number of frames to prepare this section for evaluation before it actually starts.

Public function Virtual

void

 

SetRange

(
    const TRange< FFrameNumber >& NewR...
)

Sets a new range of times for this section

Public function

void

 

SetRowIndex

(
    int32 NewRowIndex
)

Sets this section's new row index

Public function Virtual

void

 

SetStartFrame

(
    TRangeBound< FFrameNumber > NewStar...
)

Set this section's start frame in sequence resolution space.

Protected function Const

bool

 

ShouldUpgradeEntityData

Public function Virtual Const

bool

 

ShowCurveForChannel

(
    const void* Channel
)

Whether or not we draw a curve for a particular channel owned by this section. Defaults to true.

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

Public function

bool

 

TryModify

(
    bool bAlwaysMarkDirty
)

Calls Modify if this section can be modified, i.e. can't be modified if it's locked

Overridden from UObject

Name Description

Protected function Virtual Const

bool

 

IsPostLoadThreadSafe()

Called during async load to determine if PostLoad can be called on the loading thread.

Protected function Virtual

void

 

PostDuplicate

(
    bool bDuplicateForPIE
)

Called after duplication & serialization and before PostLoad.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Protected function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Protected function Virtual

void

 

PostRename

(
    UObject* OldOuter,
    const FName OldName
)

Called at the end of Rename(), but only if the rename was actually carried out

Protected function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

Name Description

Protected variable

uint32: 1

 

bIsInfinite_DEPRECATED

Toggle to set this section to be infinite

Protected variable

float

 

EndTime_DEPRECATED

The end time of the section

Protected variable

float

 

PostRollTime_DEPRECATED

The amount of time to continue 'postrolling' this section for after evaluation has ended.

Protected variable

float

 

PreRollTime_DEPRECATED

The amount of time to prepare this section for evaluation before it actually starts.

Protected variable

float

 

StartTime_DEPRECATED

The start time of the section

Deprecated Functions

Name Description

Public function Virtual

UMovieSceneS...

 

SplitSection

(
    FQualifiedFrameTime SplitTime
)

Please use SplitSection(SplitTime, bDeleteKeys) instead.

Public function Virtual

void

 

TrimSection

(
    FQualifiedFrameTime SplitTime,
    bool bTrimLeft
)

Please use TrimSection(SplitTime, bTrimLeft, bDeleteKeys) instead.

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