Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > UMovieSceneSection

Light Theme

Dark Theme

UMovieSceneSection

Base class for movie scene sections

Choose your operating system:

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

UMovieSceneDataLayerSection

UMovieSceneDMXLibrarySection

UMovieSceneDoubleSection

UMovieSceneDoubleVectorSection

UMovieSceneEnumSection

UMovieSceneEventSection

UMovieSceneEventSectionBase

	UMovieSceneEventRepeaterSection
	UMovieSceneEventTriggerSection

UMovieSceneFadeSection

UMovieSceneFloatSection

UMovieSceneFloatVectorSection

UMovieSceneGeometryCacheSection

UMovieSceneGeometryCollectionSection

UMovieSceneGroomCacheSection

UMovieSceneHookSection

	UMovieSceneGameplayCueSection
	UMovieSceneGameplayCueTriggerSection

UMovieSceneIntegerSection

UMovieSceneLevelVisibilitySection

UMovieSceneLiveLinkSection

UMovieSceneMarginSection

UMovieSceneMediaPlayerPropertySection

UMovieSceneMediaSection

UMovieSceneNiagaraSystemSpawnSection

UMovieSceneObjectPropertySection

UMovieSceneParameterSection

UMovieSceneControlRigParameterSection

UMovieSceneParticleSection

UMovieScenePrimitiveMaterialSection

UMovieSceneReplaySection

UMovieSceneSkeletalAnimationSection

UMovieSceneSlomoSection

UMovieSceneStringSection

UMovieSceneSubSection

	UMovieSceneCinematicShotSection
	UTemplateSequenceSection

UMovieSceneTakeSection

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
FOptionalMovieS...	BlendType
bool	bSupportsInfiniteRange	Does this section support infinite ranges in the track editor?
TSharedPtr< FMo...	ChannelProxy	Channel proxy that contains all the channels in this section - must be populated and invalidated by derived types.
EMovieSceneChan...	ChannelProxyType	Defines whether the channel proxy can change over the lifetime of the section
FMovieSceneEasi...	Easing
FMovieSceneSect...	EvalOptions
FMovieSceneFram...	SectionRange	The range in which this section is active
FMovieSceneTime...	TimecodeSource	The timecode at which this movie scene section is based (ie. when it was recorded)

Constructors

	Name	Description
	UMovieSceneSection ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UMovieSceneSection()

Functions

	Name	Description
void	BuildDefaultComponents ( UMovieSceneEntitySystemLinker*..., const UE::MovieScene::FEntityImport..., UE::MovieScene::FImportedEntity... )
TRange< FFra...	ComputeEffectiveRange()	Return the range within which this section is effective.
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
float	EvaluateEasing ( FFrameTime InTime )	Evaluate this sections's easing functions based on the specified time
void	ExpandToFrame ( FFrameNumber InFrame )	Expands this section's range to include the specified time
TOptional< T...	GetAutoSizeRange()	Returns the range to auto size this section to, if there is one.
FOptionalMov...	GetBlendType()	Gets this section's blend type
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.
EMovieSceneC...	GetCompletionMode()	Gets this section's completion mode
ECookOptimiz...	GetCookOptimizationFlags()	Called when this section's movie scene is being cooked to determine if/how this section should be cooked.
TRange< FFra...	GetEaseInRange()
TRange< FFra...	GetEaseOutRange()
FFrameNumber	GetExclusiveEndFrame()	Gets the first frame number after the end of this section
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.
FFrameNumber	GetInclusiveStartFrame()	Gets the frame number at which this section starts
TSharedPtr< ...	GetKeyStruct ( TArrayView< const FKeyHandle > KeyH... )	Get the data structure representing the specified keys.
TOptional< F...	GetOffsetTime()	The optional offset time of this section
void	GetOverlappingSections ( TArray< UMovieSceneSection* > ..., bool bSameRow, bool bIncludeThis )	Gets a list of all overlapping sections
int32	GetOverlapPriority()	Gets this section's priority over overlapping sections (higher wins)
int32	GetPostRollFrames()
int32	GetPreRollFrames()
TRange< FFra...	GetRange()
void	GetReferencedBindings ( TArray< FGuid >& OutBindings )	Get the referenced bindings for this section
int32	GetRowIndex()	Gets the row index for this section
void	GetSnapTimes ( TArray< FFrameNumber >& OutSnapTim..., bool bGetSectionBorders )	Gets all snap times for this section
FMovieSceneB...	GetSupportedBlendTypes()	Gets what kind of blending is supported by this section
bool	GetSupportsInfiniteRange()	Does this movie section support infinite ranges for evaluation
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
TRange< FFra...	GetTrueRange()	A true representation of this section's range with an inclusive start frame and an exclusive end frame.
bool	HasEndFrame()	Check whether this section has an end frame (else infinite)
bool	HasStartFrame()	Check whether this section has a start frame (else infinite)
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.
void	InitialPlacementOnRow ( const TArray< UMovieSceneSection&#..., FFrameNumber InStartTime, int32 InDuration, int32 InRowIndex )	Places this section at the specified row at the specified time.
bool	IsActive()
bool	IsLocked()
bool	IsReadOnly()	A section is read only if it or its outer movie are read only
bool	IsTimeWithinSection ( FFrameNumber Position )	Returns whether or not a provided position in time is within the timespan of the section
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
void	MoveSection ( FFrameNumber DeltaTime )	Moves the section by a specific amount of time
void	OnBindingIDsUpdated ( const TMap< UE::MovieScene::FFixedO..., FMovieSceneSequenceID LocalSequence..., const FMovieSceneSequenceHierarchy ..., IMovieScenePlayer& Player )	When guid bindings are updated to allow this section to fix-up any internal bindings
void	OnDilated ( float DilationFactor, FFrameNumber Origin )
void	OnMoved ( int32 DeltaTime )
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.
void	RemoveForCook()	Called when this section should be removed for cooking
void	SetBlendType ( EMovieSceneBlendType InBlendType )	Sets this section's blend type
void	SetCompletionMode ( EMovieSceneCompletionMode InComplet... )	Sets this section's completion mode
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
void	SetIsActive ( bool bInIsActive )	Whether or not this section is active.
void	SetIsLocked ( bool bInIsLocked )	Whether or not this section is locked.
void	SetOverlapPriority ( int32 NewPriority )	Sets this section's priority over overlapping sections (higher wins)
void	SetPostRollFrames ( int32 InPostRollFrames )	Gets/sets the number of frames to continue 'postrolling' this section for after evaluation has ended.
void	SetPreRollFrames ( int32 InPreRollFrames )	Gets the number of frames to prepare this section for evaluation before it actually starts.
void	SetRange ( const TRange< FFrameNumber >& NewR... )	Sets a new range of times for this section
void	SetRowIndex ( int32 NewRowIndex )	Sets this section's new row index
void	SetStartFrame ( TRangeBound< FFrameNumber > NewStar... )	Set this section's start frame in sequence resolution space.
bool	ShouldUpgradeEntityData ( FArchive& Ar, FMovieSceneEvaluationCustomVersion:... )
bool	ShowCurveForChannel ( const void* Channel )	Whether or not we draw a curve for a particular channel owned by this section. Defaults to true.
UMovieSceneS...	SplitSection ( FQualifiedFrameTime SplitTime, bool bDeleteKeys )	Split a section in two at the split time
void	TrimSection ( FQualifiedFrameTime TrimTime, bool bTrimLeft, bool bDeleteKeys )	Trim a section at the trim time
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
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostRename ( UObject* OldOuter, const FName OldName )	Called at the end of Rename(), but only if the rename was actually carried out
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

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

Deprecated Functions

	Name	Description
void	OnBindingsUpdated ( const TMap< FGuid, FGuid >& OldGui... )	OnBindingsUpdated has been deprecated. Use OnBindingIDsUpdated instead
UMovieSceneS...	SplitSection ( FQualifiedFrameTime SplitTime )	Please use SplitSection(SplitTime, bDeleteKeys) instead.
void	TrimSection ( FQualifiedFrameTime SplitTime, bool bTrimLeft )	Please use TrimSection(SplitTime, bTrimLeft, bDeleteKeys) instead.