1. Epic GamesDeveloper
  3. UMovieSceneSection

UMovieSceneSection

Base class for movie scene sections

Unreal Engine C++ API Reference > Runtime > MovieScene

Inheritance Hierarchy

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/MovieSceneSection.h
Include #include "MovieSceneSection.h"

Syntax

UCLASS (Abstract, DefaultToInstanced, MinimalAPI, BlueprintType)  
class UMovieSceneSection : public UMovieSceneSignedObject

Remarks

Base class for movie scene sections

Variables

  Type Name Description
Protected variable UProperty FOptionalMovieSceneBlendType BlendType  
Protected variable UProperty bool bSupportsInfiniteRange Does this section support infinite ranges in the track editor?
Protected variable TSharedPtr< FMovieSceneChannelProxy > ChannelProxy Channel proxy that contains all the channels in this section - must be populated and invalidated by derived types.
Protected variable EMovieSceneChannelProxyType ChannelProxyType Defines whether the channel proxy can change over the lifetime of the section
Public variable UProperty Category, EditAnywhere FMovieSceneConditionContainer ConditionContainer Optional dynamic condition for whether this section evaluates at runtime.
Public variable UProperty Category, EditAnywhere, Meta FMovieSceneEasingSettings Easing  
Public variable UProperty Category, EditAnywhere, Meta FMovieSceneSectionEvalOptions EvalOptions  
Public variable UE::MovieScene::TDataEventContainer< UE::MovieScene::ISectionEventHandler > EventHandlers  
Public variable UProperty Category, EditAnywhere FMovieSceneFrameRange SectionRange The range in which this section is active
Public variable UProperty Category, EditAnywhere FMovieSceneTimecodeSource TimecodeSource The timecode at which this movie scene section is based (ie. when it was recorded)

Constructors

  Type Name Description
Public function  

UMovieSceneSection ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function Const bool Returns whether this section can have an open lower bound.
Public function Const bool Returns whether this section can have an open upper bound.
Public function Const TRange< FFrameNumber > Return the range within which this section is effective.
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function Const float

EvaluateEasing ( FFrameTime InTime
)

 Evaluate this sections's easing functions based on the specified time
Public function Const void

EvaluateEasing ( FFrameTime InTime,
TOptional< float >& OutEaseInValue,
TOptional< float >& OutEaseOutValue,
float* OutEaseInInterp,
float* OutEaseOutInterp
)

 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
Protected function void

FixupRelativeKeyframes ( FFrameNumber Offset
)

  
Public function Virtual Const TOptional< TRange< FFrameNumber > > Returns the range to auto size this section to, if there is one.
Public function Const int32 Get the optional order for the blending of this section that may or may not be used by the blending system Lower values blend first, value of INDEX_NONE means no order is set
Public function Const UFunction BlueprintPure, Category FOptionalMovieSceneBlendType Gets this section's blend type
Public function Const FMovieSceneChannelProxy & Access this section's channel proxy, containing pointers to all existing data channels in this section
Public function Const UFunction BlueprintPure, Category FColor Get this section's color tint.
Public function Const UFunction BlueprintPure, Category EMovieSceneCompletionMode Gets this section's completion mode
Public function Virtual Const ECookOptimizationFlags Called when this section's movie scene is being cooked to determine if/how this section should be cooked.
Public function Const TRange< FFrameNumber >  
Public function Const TRange< FFrameNumber >  
Public function Const FFrameNumber Gets the first frame number after the end of this section
Public function Virtual UObject * Get the implicit owner of this section, usually this will be the section's outer possessable or spawnable, but some sections, like Control Rig, this will be the Control Rig object instead.
Public function Const FFrameNumber Gets the frame number at which this section starts
Public function Virtual TSharedPtr< FStructOnScope >

GetKeyStruct ( TArrayView< const FKeyHandle > KeyHandles
)

 Get the data structure representing the specified keys.
Public function Virtual Const TOptional< FFrameTime > The optional offset time of this section
Public function void

GetOverlappingSections ( TArray< UMovieSceneSection* >& OutSections,
bool bSameRow,
bool bIncludeThis
)

 Gets a list of all overlapping sections
Public function Const UFunction BlueprintPure, Category int32 Gets this section's priority over overlapping sections (higher wins)
Public function Const UFunction BlueprintPure, Category int32  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const TRange< FFrameNumber >  
Public function Virtual void

GetReferencedBindings ( TArray< FGuid >& OutBindings
)

 Get the referenced bindings for this section
Public function Const UFunction BlueprintPure, Category int32 Gets the row index for this section
Public function Virtual Const void

GetSnapTimes ( TArray< FFrameNumber >& OutSnapTimes,
bool bGetSectionBorders
)

 Gets all snap times for this section
Public function Const FMovieSceneBlendTypeField Gets what kind of blending is supported by this section
Public function Const bool Does this movie section support infinite ranges for evaluation
Public function Virtual FMovieSceneTimeWarpVariant * Retrieve the time warp variant for this section, if it has one
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< FFrameNumber > A true representation of this section's range with an inclusive start frame and an exclusive end frame.
Public function Const bool Check whether this section has an end frame (else infinite)
Public function Const bool Check whether this section has a start frame (else infinite)
Public function Virtual void

InitialPlacement ( const TArray< UMovieSceneSection* >& Sections,
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* >& Sections,
FFrameNumber InStartTime,
int32 InDuration,
int32 InRowIndex
)

 Places this section at the specified row at the specified time.
Public function void Invalidate this section's channel proxy, causing it to be re-constructed when it is next used
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool  
Protected function Virtual Const bool  
Public function Const bool 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 Virtual void

MigrateFrameTimes ( FFrameRate SourceRate,
FFrameRate DestinationRate
)

 Migrate the frame times of the movie scene section from the source frame rate to the destination frame rate
Public function Virtual void

MoveSection ( FFrameNumber DeltaTime
)

 Moves the section by a specific amount of time
Public function Virtual void 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 UMovieSceneSection *

OverlapsWithSections ( const TArray< UMovieSceneSection* >& Sections,
int32 TrackDelta,
int32 TimeDelta
)

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

PostDuplicate ( bool bDuplicateForPIE
)

  
Protected function Virtual void  
Public function Virtual void  
Protected function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

  
Public function Virtual void Called when this section should be removed for cooking
Protected function Virtual void

Serialize ( FArchive& Ar
)

  
Public function Virtual UFunction BlueprintCallable, Category void Sets this section's blend type
Public function UFunction BlueprintCallable, Category void

SetColorTint ( const FColor& InColorTint
)

 Set this section's color tint.
Public function UFunction BlueprintCallable, Category void Sets this section's completion mode
Public function Virtual void

SetEndFrame ( TRangeBound< FFrameNumber > NewEndFrame
)

 Set this section's end frame in sequence resolution space
Public function UFunction BlueprintCallable, Category void

SetIsActive ( bool bInIsActive
)

 Whether or not this section is active.
Public function UFunction BlueprintCallable, Category void

SetIsLocked ( bool bInIsLocked
)

 Whether or not this section is locked.
Public function UFunction BlueprintCallable, Category void

SetOverlapPriority ( int32 NewPriority
)

 Sets this section's priority over overlapping sections (higher wins)
Public function UFunction BlueprintCallable, Category void

SetPostRollFrames ( int32 InPostRollFrames
)

 Gets/sets the number of frames to continue 'postrolling' this section for after evaluation has ended.
Public function UFunction BlueprintCallable, Category 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 >& NewRange
)

 Sets a new range of times for this section
Public function UFunction BlueprintCallable, Category void

SetRowIndex ( int32 NewRowIndex
)

 Sets this section's new row index
Public function Virtual void

SetStartFrame ( TRangeBound< FFrameNumber > NewStartFrame
)

 Set this section's start frame in sequence resolution space.
Protected function Const bool  
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 UMovieSceneSection *

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 UMovieSceneSignedObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual void  

Deprecated Variables

  Type Name Description
Protected variable UProperty uint32: 1 bIsInfinite_DEPRECATED Toggle to set this section to be infinite
Protected variable UProperty float EndTime_DEPRECATED The end time of the section
Protected variable UProperty float PostRollTime_DEPRECATED The amount of time to continue 'postrolling' this section for after evaluation has ended.
Protected variable UProperty float PreRollTime_DEPRECATED The amount of time to prepare this section for evaluation before it actually starts.
Protected variable UProperty float StartTime_DEPRECATED The start time of the section

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page