1. Epic GamesDeveloper
  3. MovieSceneToolHelpers

MovieSceneToolHelpers

API > API/Editor > API/Editor/MovieSceneTools

References

   
Module MovieSceneTools
Header /Engine/Source/Editor/MovieSceneTools/Public/MovieSceneToolHelpers.h
Include #include "MovieSceneToolHelpers.h"

Syntax

class MovieSceneToolHelpers

Functions

  Type Name Description
Public function Static USkeletalMeshComponent *

AcquireSkeletalMeshFromObject ( UObject* BoundObject
)

 Acquire first SkeletalMeshComponent from the Object
Public function Static bool

AddTransformKeys ( const UMovieScene3DTransformSection* InTransformSection,
const TArray< FFrameNumber >& Frames,
const TArray< FTransform >& InLocalTransforms,
const EMovieSceneTransformChannel& InChannels
)

 Adds transform keys to the section based on the channels filters.
Public function Static bool

BakeToSkelMeshToCallbacks ( UMovieScene* MovieScene,
IMovieScenePlayer* Player,
USkeletalMeshComponent* SkelMesh,
FMovieSceneSequenceIDRef& Template,
FMovieSceneSequenceTransform& RootToLocalTransform,
UAnimSeqExportOption* ExportOptions,
FInitAnimationCB InitCallback,
FStartAnimationCB StartCallback,
FTickAnimationCB TickCallback,
FEndAnimationCB EndCallback
)

  
Public function Static bool

BakeToSkelMeshToCallbacks ( const FAnimExportSequenceParameters& AnimExportSequenceParameters,
USkeletalMeshComponent* SkelMesh,
UAnimSeqExportOption* ExportOptions,
FInitAnimationCB InitCallback,
FStartAnimationCB StartCallback,
FTickAnimationCB TickCallback,
FEndAnimationCB EndCallback
)

 Bake the SkelMesh to a generic object wich implements a set of callbacks
Public function Static void

CalculateFramesBetween ( const UMovieScene* MovieScene,
FFrameNumber StartFrame,
FFrameNumber EndFrame,
int FrameIncrement,
TArray< FFrameNumber >& OutFrames
)

 Returns the frame numbers between start and end.
Public function Static bool

CanSplitSection ( const TSet< UMovieSceneSection* >& Sections,
FQualifiedFrameTime Time
)

  
Public function Static bool

CanTrimSectionLeft ( const TSet< UMovieSceneSection* >& Sections,
FQualifiedFrameTime Time
)

  
Public function Static bool

CanTrimSectionRight ( const TSet< UMovieSceneSection* >& Sections,
FQualifiedFrameTime Time
)

  
Public function Static bool

CollapseSection ( TSharedPtr< ISequencer >& InSequencer,
UMovieSceneTrack* InOwnerTrack,
TArray< UMovieSceneSection* > InSections,
const FBakingAnimationKeySettings& InSettings
)

 Collapse all of the sections specified onto the first one
Public function Static FString

ComposeShotName ( const FString& ShotPrefix,
uint32 ShotNumber,
uint32 TakeNumber,
uint32 ShotNumberDigits,
uint32 TakeNumberDigits
)

 Compose a shot name given its components.
Public function Static void

CopyCameraProperties ( fbxsdk::FbxCamera* CameraNode,
AActor* InCameraActor
)

 Import FBX Camera to existing camera's
Public function Static void

CreateCameraCutSectionForCamera ( UMovieScene* MovieScene,
FGuid CameraGuid,
FFrameNumber FrameNumber
)

 Create a new camera cut section for the given camera
Public function Static UMovieSceneSequence *

CreateSequence ( FString& NewSequenceName,
FString& NewSequencePath,
UMovieSceneSubSection* SectionToDuplicate
)

 Create sequence
Public function Static bool

ExportFBX ( UWorld* World,
UMovieScene* MovieScene,
IMovieScenePlayer* Player,
const TArray< FGuid >& Bindings,
const TArray< UMovieSceneTrack* >& Tracks,
INodeNameAdapter& NodeNameAdapter,
FMovieSceneSequenceIDRef& Template,
const FString& InFBXFileName,
FMovieSceneSequenceTransform& RootToLocalTransform
)

  
Public function Static bool

ExportFBX ( UWorld* World,
const FAnimExportSequenceParameters& AnimExportSequenceParameters,
const TArray< FGuid >& Bindings,
const TArray< UMovieSceneTrack* >& Tracks,
INodeNameAdapter& NodeNameAdapter,
FMovieSceneSequenceIDRef& Template,
const FString& InFBXFileName
)

 Export FBX
Public function Static bool

ExportFBXFromControlRigChannels ( const UMovieSceneSection* Section,
const UMovieSceneUserExportFBXControlRigSettings* ExportFBXControlRigSettings,
const TArray< FName >& SelectedControlNames,
const FMovieSceneSequenceTransform& RootToLocalTransform
)

 Export FBX from Control Rig Channels
Public function Static bool

ExportFBXFromControlRigChannelsWithDialog ( const TSharedRef< ISequencer >& InSequencer,
UMovieSceneTrack* Track
)

 Export FBX from Control Rig Channels With Dialog
Public function Static bool

ExportToAnimSequence ( UAnimSequence* AnimSequence,
UAnimSeqExportOption* ExportOptions,
UMovieScene* MovieScene,
IMovieScenePlayer* Player,
USkeletalMeshComponent* SkelMesh,
FMovieSceneSequenceIDRef& Template,
FMovieSceneSequenceTransform& RootToLocalTransform
)

  
Public function Static bool

ExportToAnimSequence ( UAnimSequence* AnimSequence,
UAnimSeqExportOption* ExportOptions,
const FAnimExportSequenceParameters& AnimExportSequenceParameters,
USkeletalMeshComponent* SkelMesh
)

 Export the SkelMesh to an Anim Sequence for specified MovieScene and Player
Public function Static int32

FindAvailableRowIndex ( UMovieSceneTrack* InTrack,
UMovieSceneSection* InSection,
const TArray< UMovieSceneSection* >& SectionsToDisregard
)

 Get the next available row index for the section so that it doesn't overlap any other sections in time.
Public function Static void

GatherTakes ( const UMovieSceneSection* Section,
TArray< FAssetData >& AssetData,
uint32& OutCurrentTakeNumber
)

 Gather takes - level sequence assets that have the same shot prefix and shot number in the same asset path (directory)
Public function Static FString

GenerateNewShotName ( const TArray< UMovieSceneSection* >& AllSections,
FFrameNumber Time
)

  
Public function Static FString

GenerateNewShotPath ( UMovieScene* SequenceMovieScene,
FString& NewShotName
)

  
Public function Static FString

GenerateNewSubsequenceName ( const TArray< UMovieSceneSection* >& AllSections,
const FString& SubsequencePrefix,
FFrameNumber Time
)

 Generate a new shot name
Public function Static FString

GenerateNewSubsequencePath ( UMovieScene* SequenceMovieScene,
const FString& SubsequenceDirectory,
FString& NewShotName
)

 Generate a new subsequence package
Public function Static void

GetActorParents ( const FActorForWorldTransforms& Actor,
TArray< FActorForWorldTransforms >& OutParentActors
)

 Get an actors and possible component parents.
Public function Static void

GetActorParentsWithAttachments ( ISequencer* Sequencer,
const FActorForWorldTransforms& Actor,
TArray< FActorForWorldTransforms >& OutParentActors
)

 Get an actors and possible component parents using sequencer to test for attachments.
Public function Static void

GetActorsAndParentsKeyFrames ( ISequencer* Sequencer,
const FActorForWorldTransforms& Actor,
const FFrameNumber& StartFrame,
const FFrameNumber& EndFrame,
TSortedMap< FFrameNumber, FFrameNumber >& OutFrameMap
)

 Get an actors and it's parent key frames
Public function Static void

GetActorWorldTransforms ( IMovieScenePlayer* Player,
UMovieSceneSequence* InSequence,
FMovieSceneSequenceIDRef Template,
const FActorForWorldTransforms& Actors,
const TArray< FFrameNumber >& Frames,
TArray< FTransform >& OutWorldTransforms
)

 Get an actors world transforms at the specified times using a player
Public function Static void

GetActorWorldTransforms ( ISequencer* Sequencer,
const FActorForWorldTransforms& Actors,
const TArray< FFrameNumber >& Frames,
TArray< FTransform >& OutWorldTransforms
)

 Get an actors word transforms at the specified times
Public function Static FString

GetCameraName ( fbxsdk::FbxCamera* InCamera
)

 Get the fbx camera name
Public function Static void

GetCameras ( fbxsdk::FbxNode* Parent,
TArray< fbxsdk::FbxCamera* >& Cameras
)

 Get the fbx cameras from the requested parent node
Public function Static TArray< CurveValueType >

GetChannelValues ( const int32 StartIndex,
const int32 EndIndex,
const TArray< UMovieSceneSection* >& Sections,
const TArray< UMovieSceneSection* >& AbsoluteSections,
const FFrameNumber& FrameTime
)

 Get the channel values at the specified time with the specified sections, will get the channels from within the specified start and end indices
Public function Static const FMovieSceneEvaluationTrack *

GetEvaluationTrack ( ISequencer* Sequencer,
const FGuid& TrackSignature
)

 Get the Active EvaluationTrack for a given track. Will do a recompile if the track isn't valid
Public function Static void

GetLocationAtTime ( const FMovieSceneEvaluationTrack* Track,
UObject* Object,
FFrameTime KeyTime,
FVector& KeyPos,
FRotator& KeyRot,
const TSharedPtr< ISequencer >& Sequencer
)

 Get the location at time for the specified transform evaluation track
Public function Static void

GetParents ( TArray< const UObject* >& Parents,
const UObject* InObject
)

 Get the Parents (Scene/Actors) of this object.
Public function Static bool

GetParentTM ( FTransform& CurrentRefTM,
const TSharedPtr< ISequencer >& Sequencer,
UObject* ParentObject,
FFrameTime KeyTime
)

 Return Return ParentTm for current Parent Object
Public function Static FTransform

GetRefFrameFromParents ( const TSharedPtr< ISequencer >& Sequencer,
const TArray< const UObject* >& Parents,
FFrameTime KeyTime
)

 Return Reference Frame from the passed in paretns
Public function Static bool

GetTakeNumber ( const UMovieSceneSection* Section,
FAssetData AssetData,
uint32& OutTakeNumber
)

 Get the take number for the given asset
Public function Static UMovieScene3DTransformSection *

GetTransformSection ( const ISequencer* InSequencer,
const FGuid& InGuid,
const FTransform& InDefaultTransform
)

 Returns the transform section for that guid.
Public function Static bool

HasHiddenMobility ( const UClass* ObjectClass
)

  
Public function Static void

ImportFBXCameraToExisting ( UnFbx::FFbxImporter* FbxImporter,
UMovieSceneSequence* InSequence,
IMovieScenePlayer* Player,
FMovieSceneSequenceIDRef TemplateID,
TMap< FGuid, FString >& InObjectBindingMap,
bool bMatchByNameOnly,
bool bNotifySlate
)

 Import FBX Camera to existing camera's
Public function Static bool

ImportFBXIfReady ( UWorld* World,
UMovieSceneSequence* InSequence,
IMovieScenePlayer* Player,
FMovieSceneSequenceIDRef TemplateID,
TMap< FGuid, FString >& ObjectBindingMap,
UMovieSceneUserImportFBXSettings* ImportFBXSettings,
const FFBXInOutParameters& InFBXParams
)

 Import into an FBX scene that has been readied already, via the ReadyFBXForImport call.
Public function Static bool

ImportFBXIntoControlRigChannels ( UMovieScene* MovieScene,
const FString& ImportFilename,
UMovieSceneUserImportFBXControlRigSettings* ControlRigSettings,
TArray< FRigControlFBXNodeAndChannels >* NodeAndChannels,
const TArray< FName >& SelectedControlNames,
FFrameRate FrameRate
)

 Import FBX into Control Rig Channels
Public function Static bool

ImportFBXIntoControlRigChannelsWithDialog ( const TSharedRef< ISequencer >& InSequencer,
TArray< FRigControlFBXNodeAndChannels >* NodeAndChannels
)

 Import FBX into Control Rig Channels With Dialog
Public function Static bool

ImportFBXNode ( FString NodeName,
UnFbx::FFbxCurvesAPI& CurveAPI,
UMovieSceneSequence* InSequence,
IMovieScenePlayer* Player,
FMovieSceneSequenceIDRef TemplateID,
FGuid ObjectBinding
)

 Import FBX Node to existing actor/node
Public function Static bool

ImportFBXWithDialog ( UMovieSceneSequence* InSequence,
ISequencer& InSequencer,
const TMap< FGuid, FString >& InObjectBindingNameMap,
TOptional< bool > bCreateCameras
)

 Import FBX with dialog
Public function Static bool

IsValidAsset ( UMovieSceneSequence* Sequence,
const FAssetData& InAssetData
)

 Return whether this asset is valid for the given sequence
Public function Static void

LockCameraActorToViewport ( const TSharedPtr< ISequencer >& Sequencer,
ACameraActor* CameraActor
)

 Lock the given camera actor to the viewport
Public function Static TSharedRef< SWidget >

MakeEnumComboBox ( const UEnum* Enum,
TAttribute< int32 > CurrentValue,
SEnumComboBox::FOnEnumSelectionChanged OnSelectionChanged
)

 Generate a combobox for editing enum values
Public function Static bool

MergeChannels ( int32 SectionChannelIndex,
TArray< ChannelType* >& Channels,
const TArray< UMovieSceneSection* >& Sections,
const TRange< FFrameNumber >& Range,
FChannelMergeAlgorithm MergeAlgorithm
)

 Merge the set of passed in channels from each section at the specified section channel index.
Public function Static bool

MergeSections ( UMovieSceneSection* BaseSection,
TArray< UMovieSceneSection* >& AbsoluteSections,
TArray< UMovieSceneSection* >& AdditiveSections,
int32 StartIndex,
int32 EndIndex,
const TRange< FFrameNumber >& Range
)

 Merge the following set of sections.
Public function Static bool

MergeSections ( UMovieSceneSection* BaseSection,
UMovieSceneSection* TopSection,
int32 StartIndex,
int32 EndIndex,
const TRange< FFrameNumber >& Range
)

 Merge the TopSection onto the BaseSection.
Public function Static bool

MovieSceneTranslatorExport ( FMovieSceneExporter* InExporter,
const UMovieScene* InMovieScene,
const FMovieSceneCaptureSettings& Settings
)

 Export movie scene formats
Public function Static bool

MovieSceneTranslatorImport ( FMovieSceneImporter* InImporter,
UMovieScene* InMovieScene,
FFrameRate InFrameRate,
FString InOpenDirectory
)

 Import movie scene formats
Public function Static void

MovieSceneTranslatorLogMessages ( FMovieSceneTranslator* InTranslator,
TSharedRef< FMovieSceneTranslatorContext > InContext,
bool bDisplayMessages
)

 Log messages and display error message window for MovieScene translators
Public function Static void Log error output for MovieScene translators
Public function Static bool

OptimizeSection ( const FKeyDataOptimizationParams& InParams,
UMovieSceneSection* InSection
)

  
Public function Static bool

OverlapsSection ( UMovieSceneTrack* InTrack,
UMovieSceneSection* InSection,
const TArray< UMovieSceneSection* >& SectionsToDisregard
)

 Does this section overlap any other track section?
Public function Static bool

ParseShotName ( const FString& ShotName,
FString& ShotPrefix,
uint32& ShotNumber,
uint32& TakeNumber,
uint32& ShotNumberDigits,
uint32& TakeNumberDigits
)

 Parse a shot name into its components.
Public function Static bool

ReadyFBXForImport ( const FString& ImportFilename,
UMovieSceneUserImportFBXSettings* ImportFBXSettings,
FFBXInOutParameters& OutFBXParams
)

 Get FBX Ready for Import.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneDoubleValue >& ChannelData,
FFrameNumber Time,
double Value,
const EMovieSceneKeyInterpolation Interpolation
)

 Set or add a key onto a double channel.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneFloatValue >& ChannelData,
FFrameNumber Time,
float Value,
const EMovieSceneKeyInterpolation Interpolation
)

 Set or add a key onto a float channel.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneDoubleValue >& ChannelData,
FFrameNumber Time,
FMovieSceneDoubleValue Value
)

 Set or add a key onto a double channel based on key value.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneFloatValue >& Curve,
FFrameNumber Time,
const FMovieSceneFloatValue& Value
)

 Set or add a key onto a float channel based on key value.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneDoubleValue >& Curve,
FFrameNumber Time,
double Value,
float ArriveTangent,
float LeaveTangent,
ERichCurveInterpMode InterpMode,
ERichCurveTangentMode TangentMode,
FFrameRate FrameRate,
ERichCurveTangentWeightMode WeightedMode,
float ArriveTangentWeight,
float LeaveTangentWeight
)

 Set or add a key onto a double channel based on rich curve data.
Public function Static void

SetOrAddKey ( TMovieSceneChannelData< FMovieSceneFloatValue >& Curve,
FFrameNumber Time,
float Value,
float ArriveTangent,
float LeaveTangent,
ERichCurveInterpMode InterpMode,
ERichCurveTangentMode TangentMode,
FFrameRate FrameRate,
ERichCurveTangentWeightMode WeightedMode,
float ArriveTangentWeight,
float LeaveTangentWeight
)

 Set or add a key onto a float channel based on rich curve data.
Public function Static bool

SetTakeNumber ( const UMovieSceneSection* Section,
uint32 InTakeNumber
)

 Set the take number for the given asset
Public function Static bool

ShowExportEDLDialog ( const UMovieScene* InMovieScene,
FFrameRate InFrameRate,
FString InSaveDirectory,
int32 InHandleFrames,
FString InMovieExtension
)

 Show Export EDL Dialog
Public function Static bool

ShowImportEDLDialog ( UMovieScene* InMovieScene,
FFrameRate InFrameRate,
FString InOpenDirectory
)

 Show Import EDL Dialog
Public function Static void

SplitSection ( const TSet< UMovieSceneSection* >& Sections,
FQualifiedFrameTime Time,
bool bDeleteKeys
)

 Splits sections at the given time
Public function Static void

SplitSectionsByBlendType ( EMovieSceneBlendType BlendType,
const TArray< UMovieSceneSection* >& InSections,
TArray< UMovieSceneSection* >& OutSections,
TArray< UMovieSceneSection* >& OutBlendTypeSections
)

 Split set of sections to one containing the BlendType the other not
Public function Static void

TrimOrExtendSection ( UMovieSceneTrack* Track,
TOptional< int32 > RowIndex,
FQualifiedFrameTime Time,
bool bTrimOrExtendLeft,
bool bDeleteKeys
)

 Trim or extend section at the given time
Public function Static void

TrimSection ( const TSet< UMovieSceneSection* >& Sections,
FQualifiedFrameTime Time,
bool bTrimLeft,
bool bDeleteKeys
)

 Trim section at the given time

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page