1. Epic GamesDeveloper
  3. UMovieSceneSubSection

UMovieSceneSubSection

Implements a section in sub-sequence tracks.

API > API/Runtime > API/Runtime/MovieScene

Implements a section in sub-sequence tracks.

   
Name UMovieSceneSubSection
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/Sections/MovieSceneSubSection.h
Include Path #include "Sections/MovieSceneSubSection.h"

Syntax

UCLASS (BlueprintType, Config=EditorPerProjectUserSettings, MinimalAPI)  
class UMovieSceneSubSection :  
    public UMovieSceneSection ,  
    public IMovieSceneEntityProvider

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneSubSection ( const FObjectInitializer& ObjInitializer
)

 Object constructor. Sections/MovieSceneSubSection.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Parameters FMovieSceneSectionParameters   Sections/MovieSceneSubSection.h
  • Config
  • BlueprintReadWrite
  • EditAnywhere
  • Category="General"
  • Meta=(ShowOnlyInnerProperties)

Protected

Name Type Remarks Include Path Unreal Specifiers
KeyPreviewPosition TOptional< FVector > Preview value of position used for keying. Sections/MovieSceneSubSection.h
  • Transient
KeyPreviewRotation TOptional< FRotator > Preview value of rotation used for keying. Sections/MovieSceneSubSection.h
  • Transient
NetworkMask uint8   Sections/MovieSceneSubSection.h
  • EditAnywhere
  • Category="Networking"
  • Meta=(Bitmask, BitmaskEnum="/Script/MovieScene.EMovieSceneServerClientMask")
OriginOverrideMask FMovieSceneSubSectionOriginOverrideMask   Sections/MovieSceneSubSection.h  
Rotation FMovieSceneDoubleChannel   Sections/MovieSceneSubSection.h  
Translation FMovieSceneDoubleChannel   Sections/MovieSceneSubSection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendInnerTimeWarpTransform ( FMovieSceneSequenceTransform& OutTransform
) const

 Gets the transform that converts time from this section's time-base to its inner sequence's Sections/MovieSceneSubSection.h  

void DeleteChannels ( TArrayView< const FName > ChannelNames
)

   Sections/MovieSceneSubSection.h  

virtual FMovieSceneSubSequenceData GenerateSubSequenceData ( const FSubSequenceInstanceDataParams& Params
) const

 Generate subsequence data Sections/MovieSceneSubSection.h  

TOptional< FVector > GetKeyPreviewPosition()

 Gets the optional value of the external position of the editor mode's gizmo Sections/MovieSceneSubSection.h  

TOptional< FRotator > GetKeyPreviewRotation()

 Gets the optional value of the external Rotation of the editor mode's gizmo Sections/MovieSceneSubSection.h  
Gets the channel mask for the subsection origin overrides. Sections/MovieSceneSubSection.h  

EMovieSceneServerClientMask GetNetworkMask()

   Sections/MovieSceneSubSection.h  

FString GetPathNameInMovieScene()

 Get the path name to this sub section from the outer moviescene Sections/MovieSceneSubSection.h  
Get the sequence that is assigned to this section. Sections/MovieSceneSubSection.h
  • BlueprintPure
  • Category="Sequencer|Section"

FMovieSceneSequenceID GetSequenceID()

 Get this sub section's sequence ID Sections/MovieSceneSubSection.h  

bool GetValidatedInnerPlaybackRange ( TRange< FFrameNumber >& OutInnerPlaybackRange
) const

 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). Sections/MovieSceneSubSection.h  

bool HasAnyChannelData()

   Sections/MovieSceneSubSection.h  

bool IsTransformOriginEditable()

   Sections/MovieSceneSubSection.h  

FFrameNumber MapTimeToSectionFrame ( FFrameTime InPosition
) const

   Sections/MovieSceneSubSection.h  

FOnSequenceChanged & OnSequenceChanged()

 Delegate to fire when our sequence is changed in the property editor Sections/MovieSceneSubSection.h  

FMovieSceneSequenceTransform OuterToInnerTransform()

 Gets the transform that converts time from this section's time-base to its inner sequence's Sections/MovieSceneSubSection.h  

FMovieSceneSequenceTransform OuterToInnerTransform_NoInnerTimeWarp()

 Gets the transform that converts time from this section's time-base to its inner sequence's Sections/MovieSceneSubSection.h  

void ResetKeyPreviewRotationAndLocation()

 Resets the optional values for the gizmo's position and rotation Sections/MovieSceneSubSection.h  

void SetKeyPreviewPosition ( TOptional< FVector > InPosition
)

 Sets the external Position for controlling the transform origin in the level editor through the edtior mode's gizmo Sections/MovieSceneSubSection.h  

void SetKeyPreviewRotation ( TOptional< FRotator > InRotation
)

 Sets the external rotation for controlling the transform origin in the level editor through the edtior mode's gizmo Sections/MovieSceneSubSection.h  

void SetMask ( EMovieSceneTransformChannel MovieSceneTransformChannel
)

 Sets the channel mask for the subsection origin overrides. Sections/MovieSceneSubSection.h  

void SetNetworkMask ( EMovieSceneServerClientMask InNetworkMask
)

   Sections/MovieSceneSubSection.h  

void SetSequence ( UMovieSceneSequence* Sequence
)

 Sets the sequence played by this section. Sections/MovieSceneSubSection.h
  • BlueprintCallable
  • Category="Sequencer|Section"

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers
Returns the range to auto size this section to, if there is one. Sections/MovieSceneSubSection.h  

virtual TOptional< FFrameTime > GetOffsetTime()

 The optional offset time of this section Sections/MovieSceneSubSection.h  

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

 Gets all snap times for this section Sections/MovieSceneSubSection.h  

virtual UObject * GetSourceObject()

 Get the object associated with this section Sections/MovieSceneSubSection.h  

virtual FMovieSceneTimeWarpVariant * GetTimeWarp()

 Retrieve the time warp variant for this section, if it has one Sections/MovieSceneSubSection.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 Sections/MovieSceneSubSection.h  

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

   Sections/MovieSceneSubSection.h  

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

 Trim a section at the trim time Sections/MovieSceneSubSection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Sections/MovieSceneSubSection.h  

virtual void PostLoad()

   Sections/MovieSceneSubSection.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Sections/MovieSceneSubSection.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BuildDefaultSubSectionComponents ( UMovieSceneEntitySystemLinker* EntityLinker,
const UE::MovieScene::FEntityImportParams& Params,
UE::MovieScene::FImportedEntity* OutImportedEntity
) const

   Sections/MovieSceneSubSection.h  

Overridden from UMovieSceneSection

Name Remarks Include Path Unreal Specifiers

virtual EMovieSceneChannelProxyType CacheChannelProxy()

 Cache this section's channel proxy Sections/MovieSceneSubSection.h  

Overridden from IMovieSceneEntityProvider

Name Remarks Include Path Unreal Specifiers

virtual void ImportEntityImpl ( UMovieSceneEntitySystemLinker* EntityLinker,
const FEntityImportParams& Params,
FImportedEntity* OutImportedEntity
)

   Sections/MovieSceneSubSection.h  

virtual bool PopulateEvaluationFieldImpl ( const TRange< FFrameNumber >& EffectiveRange,
const FMovieSceneEvaluationFieldEntityMetaData& InMetaData,
FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder
)

 Optional user-implementation function for populating an evaluation entity field Sections/MovieSceneSubSection.h  

Static

Name Remarks Include Path Unreal Specifiers

static TRange< FFrameNumber > GetValidatedInnerPlaybackRange ( const FMovieSceneSectionParameters& SubSectionParameters,
const UMovieScene& InnerMovieScene
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page