1. Epic GamesDeveloper
  3. UMovieSceneSection

UMovieSceneSection

Base class for movie scene sections

API > API/Runtime > API/Runtime/MovieScene

Base class for movie scene sections

   
Name UMovieSceneSection
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/MovieSceneSection.h
Include Path #include "MovieSceneSection.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

UMovieSceneSection derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneSection ( const FObjectInitializer& ObjectInitializer
)

   MovieSceneSection.h  

Constants

Name Type Remarks Include Path
OnAddedToTrackEvent FOnMovieSceneSectionAddedToTrack   MovieSceneSection.h
OnRemovedFromTrackEvent FOnMovieSceneSectionChanged   MovieSceneSection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConditionContainer FMovieSceneConditionContainer Optional dynamic condition for whether this section evaluates at runtime. MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
Easing FMovieSceneEasingSettings   MovieSceneSection.h
  • EditAnywhere
  • Category="Easing"
  • Meta=(ShowOnlyInnerProperties)
EvalOptions FMovieSceneSectionEvalOptions   MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
  • Meta=(ShowOnlyInnerProperties)
EventHandlers UE::MovieScene::TDataEventContainer< UE::MovieScene::ISectionEventHandler >   MovieSceneSection.h  
SectionRange FMovieSceneFrameRange The range in which this section is active MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
TimecodeSource FMovieSceneTimecodeSource The timecode at which this movie scene section is based (ie. when it was recorded) MovieSceneSection.h
  • EditAnywhere
  • Category="Section"

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsActive uint32 Toggle whether this section is active/inactive MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
bIsLocked uint32 Toggle whether this section is locked/unlocked MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
ColorTint FColor The color tint for this section MovieSceneSection.h
  • EditAnywhere
  • Category="Section"
OverlapPriority int32 This section's priority over overlapping sections MovieSceneSection.h  
PostRollFrames FFrameNumber The amount of time to continue 'postrolling' this section for after evaluation has ended. MovieSceneSection.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Section"
  • Meta=(UIMin=0, UIFrameDisplayAs="NonMusical|Duration")
PreRollFrames FFrameNumber The amount of time to prepare this section for evaluation before it actually starts. MovieSceneSection.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Section"
  • Meta=(UIMin=0, UIFrameDisplayAs="NonMusical|Duration")
RowIndex int32 The row index that this section sits on MovieSceneSection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildDefaultComponents ( UMovieSceneEntitySystemLinker* EntityLinker,
const UE::MovieScene::FEntityImportParams& Params,
UE::MovieScene::FImportedEntity* OutLedgerEntry
)

   MovieSceneSection.h  
Returns whether this section can have an open lower bound. MovieSceneSection.h  
Returns whether this section can have an open upper bound. MovieSceneSection.h  
Return the range within which this section is effective. MovieSceneSection.h  

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

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

float EvaluateEasing ( FFrameTime InTime
) const

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

void ExpandToFrame ( FFrameNumber InFrame
)

 Expands this section's range to include the specified time MovieSceneSection.h  
Returns the range to auto size this section to, if there is one. MovieSceneSection.h  

int32 GetBlendingOrder()

 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 MovieSceneSection.h  
Gets this section's blend type MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"
Access this section's channel proxy, containing pointers to all existing data channels in this section MovieSceneSection.h  

FColor GetColorTint()

 Get this section's color tint. MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

EMovieSceneCompletionMode GetCompletionMode()

 Gets this section's completion mode MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

virtual ECookOptimizationFlags GetCookOptimizationFlags()

 Called when this section's movie scene is being cooked to determine if/how this section should be cooked. MovieSceneSection.h  

TRange< FFrameNumber > GetEaseInRange()

   MovieSceneSection.h  

TRange< FFrameNumber > GetEaseOutRange()

   MovieSceneSection.h  
Gets the first frame number after the end of this section MovieSceneSection.h  

virtual UObject * GetImplicitObjectOwner()

 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. MovieSceneSection.h  
Gets the frame number at which this section starts MovieSceneSection.h  

virtual TSharedPtr< FStructOnScope > GetKeyStruct ( TArrayView< const FKeyHandle > KeyHandles
)

 Get the data structure representing the specified keys. MovieSceneSection.h  

virtual TOptional< FFrameTime > GetOffsetTime()

 The optional offset time of this section MovieSceneSection.h  

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

 Gets a list of all overlapping sections MovieSceneSection.h  

int32 GetOverlapPriority()

 Gets this section's priority over overlapping sections (higher wins) MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

int32 GetPostRollFrames()

   MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

int32 GetPreRollFrames()

   MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

TRange< FFrameNumber > GetRange()

   MovieSceneSection.h  

virtual void GetReferencedBindings ( TArray< FGuid >& OutBindings
)

 Get the referenced bindings for this section MovieSceneSection.h  

int32 GetRowIndex()

 Gets the row index for this section MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

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

 Gets all snap times for this section MovieSceneSection.h  

virtual UObject * GetSourceObject()

 Get the object associated with this section MovieSceneSection.h  

FMovieSceneBlendTypeField GetSupportedBlendTypes()

 Gets what kind of blending is supported by this section MovieSceneSection.h  

bool GetSupportsInfiniteRange()

 Does this movie section support infinite ranges for evaluation MovieSceneSection.h  

virtual FMovieSceneTimeWarpVariant * GetTimeWarp()

 Retrieve the time warp variant for this section, if it has one MovieSceneSection.h  

virtual float GetTotalWeightValue ( FFrameTime InTime
) const

 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 MovieSceneSection.h  
A true representation of this section's range with an inclusive start frame and an exclusive end frame. MovieSceneSection.h  

bool HasEndFrame()

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

bool HasStartFrame()

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

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. MovieSceneSection.h  

virtual void InitialPlacementOnRow ( const TArray< UMovieSceneSection* >& Sections,
FFrameNumber InStartTime,
int32 InDuration,
int32 InRowIndex
)

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

void InvalidateChannelProxy()

 Invalidate this section's channel proxy, causing it to be re-constructed when it is next used MovieSceneSection.h  

bool IsActive()

   MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

bool IsLocked()

   MovieSceneSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

bool IsReadOnly()

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

bool IsTimeWithinSection ( FFrameNumber Position
) const

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

virtual void MigrateFrameTimes ( const UE::MovieScene::IRetimingInterface& Retimer
)

   MovieSceneSection.h  

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 MovieSceneSection.h  

virtual void MoveSection ( FFrameNumber DeltaTime
)

 Moves the section by a specific amount of time MovieSceneSection.h  

void OnAddedToTrack ( UMovieSceneTrack* Track
)

   MovieSceneSection.h  

virtual void OnBindingIDsUpdated ( const TMap< UE::MovieScene::FFixedObjectBindingID, UE::MovieScene::FFixedObjectBindingID >& OldFixe...,
FMovieSceneSequenceID LocalSequenceID,
TSharedRef< UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

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

void OnRemovedFromTrack()

   MovieSceneSection.h  

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

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

virtual void PostPaste()

   MovieSceneSection.h  

virtual void RemoveForCook()

 Called when this section should be removed for cooking MovieSceneSection.h  

virtual void SetBlendType ( EMovieSceneBlendType InBlendType
)

 Sets this section's blend type MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetColorTint ( const FColor& InColorTint
)

 Set this section's color tint. MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetCompletionMode ( EMovieSceneCompletionMode InCompletionMode
)

 Sets this section's completion mode MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

virtual void SetEndFrame ( TRangeBound< FFrameNumber > NewEndFrame
)

 Set this section's end frame in sequence resolution space MovieSceneSection.h  

void SetIsActive ( bool bInIsActive
)

 Whether or not this section is active. MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetIsLocked ( bool bInIsLocked
)

 Whether or not this section is locked. MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetOverlapPriority ( int32 NewPriority
)

 Sets this section's priority over overlapping sections (higher wins) MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetPostRollFrames ( int32 InPostRollFrames
)

 Gets/sets the number of frames to continue 'postrolling' this section for after evaluation has ended. MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

void SetPreRollFrames ( int32 InPreRollFrames
)

 Gets the number of frames to prepare this section for evaluation before it actually starts. MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

virtual void SetRange ( const TRange< FFrameNumber >& NewRange
)

 Sets a new range of times for this section MovieSceneSection.h  

void SetRowIndex ( int32 NewRowIndex
)

 Sets this section's new row index MovieSceneSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

virtual void SetStartFrame ( TRangeBound< FFrameNumber > NewStartFrame
)

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

virtual bool ShowCurveForChannel ( const void* Channel
) const

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

virtual UMovieSceneSection * SplitSection ( FQualifiedFrameTime SplitTime,
bool bDeleteKeys
)

 Split a section in two at the split time MovieSceneSection.h  

virtual void TrimSection ( FQualifiedFrameTime TrimTime,
bool bTrimLeft,
bool bDeleteKeys
)

 Trim a section at the trim time MovieSceneSection.h  

bool TryModify ( bool bAlwaysMarkDirty
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   MovieSceneSection.h  

Protected

Name Remarks Include Path Unreal Specifiers

void FixupRelativeKeyframes ( FFrameNumber Offset
)

   MovieSceneSection.h  

virtual void OnAddedToTrackImpl ( UMovieSceneTrack* Track
)

   MovieSceneSection.h  

virtual void OnDilated ( float DilationFactor,
FFrameNumber Origin
)

   MovieSceneSection.h  

virtual void OnMoved ( int32 DeltaTime
)

   MovieSceneSection.h  

virtual void OnRemovedFromTrackImpl()

   MovieSceneSection.h  

bool ShouldUpgradeEntityData ( FArchive& Ar,
FMovieSceneEvaluationCustomVersion::Type UpgradeVersion
) const

   MovieSceneSection.h  

Overridden from UMovieSceneDecorationContainerObject

Name Remarks Include Path Unreal Specifiers

virtual void OnDecorationAdded ( UObject* NewDecoration
)

   MovieSceneSection.h  

virtual void OnDecorationRemoved ( UObject* NewDecoration
)

   MovieSceneSection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   MovieSceneSection.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   MovieSceneSection.h  

virtual void PostEditImport()

   MovieSceneSection.h  

virtual void PostInitProperties()

   MovieSceneSection.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   MovieSceneSection.h  

virtual void Serialize ( FArchive& Ar
)

   MovieSceneSection.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   MovieSceneSection.h  

static FOnMovieSceneSectionAddedToTrack & GetOnSectionAddedToTrack()

 A delegate for when a section is added to a track. MovieSceneSection.h  

static FOnMovieSceneSectionChanged & GetOnSectionRemovedFromTrack()

 A delegate for when a section is removed from a track. MovieSceneSection.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bIsInfinite_DEPRECATED uint32 Toggle to set this section to be infinite MovieSceneSection.h  
EndTime_DEPRECATED float The end time of the section MovieSceneSection.h  
PostRollTime_DEPRECATED float The amount of time to continue 'postrolling' this section for after evaluation has ended. MovieSceneSection.h  
PreRollTime_DEPRECATED float The amount of time to prepare this section for evaluation before it actually starts. MovieSceneSection.h  
StartTime_DEPRECATED float The start time of the section MovieSceneSection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page