1. Epic GamesDeveloper
  3. MovieSceneToolHelpers

MovieSceneToolHelpers

API > API/Editor > API/Editor/MovieSceneTools

   
Name MovieSceneToolHelpers
Type class
Header File /Engine/Source/Editor/MovieSceneTools/Public/MovieSceneToolHelpers.h
Include Path #include "MovieSceneToolHelpers.h"

Syntax

class MovieSceneToolHelpers

Structs

Name Remarks
FBaseTopSections  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static USkeletalMeshComponent * AcquireSkeletalMeshFromObject ( UObject* BoundObject
)

 Acquire first SkeletalMeshComponent from the Object MovieSceneToolHelpers.h  

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

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

   MovieSceneToolHelpers.h  

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

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

 Returns the frame numbers between start and end. MovieSceneToolHelpers.h  

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

   MovieSceneToolHelpers.h  

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

   MovieSceneToolHelpers.h  

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

   MovieSceneToolHelpers.h  

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

 Collapse all of the sections specified onto the first one MovieSceneToolHelpers.h  

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

 Compose a shot name given its components. MovieSceneToolHelpers.h  

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

 Import FBX Camera to existing camera's MovieSceneToolHelpers.h  

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

 Create a new camera cut section for the given camera MovieSceneToolHelpers.h  

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

 Create sequence MovieSceneToolHelpers.h  

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

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
)

   MovieSceneToolHelpers.h  

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

 Export FBX from Control Rig Channels MovieSceneToolHelpers.h  

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

 Export FBX from Control Rig Channels With Dialog MovieSceneToolHelpers.h  

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

   MovieSceneToolHelpers.h  

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

 Export the SkelMesh to an Anim Sequence for specified MovieScene and Player MovieSceneToolHelpers.h  

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

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) MovieSceneToolHelpers.h  

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

   MovieSceneToolHelpers.h  

static FString GenerateNewShotPath ( UMovieScene* SequenceMovieScene,
FString& NewShotName
)

   MovieSceneToolHelpers.h  

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

 Generate a new shot name MovieSceneToolHelpers.h  

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

 Generate a new subsequence package MovieSceneToolHelpers.h  

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

 Get an actors and possible component parents. MovieSceneToolHelpers.h  

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

 Get an actors and possible component parents using sequencer to test for attachments. MovieSceneToolHelpers.h  

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

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

 Get an actors word transforms at the specified times MovieSceneToolHelpers.h  

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

static FString GetCameraName ( fbxsdk::FbxCamera* InCamera
)

 Get the fbx camera name MovieSceneToolHelpers.h  

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

 Get the fbx cameras from the requested parent node MovieSceneToolHelpers.h  

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

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

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

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

 Get the Parents (Scene/Actors) of this object. MovieSceneToolHelpers.h  

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

 Return Return ParentTm for current Parent Object MovieSceneToolHelpers.h  

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

 Return Reference Frame from the passed in paretns MovieSceneToolHelpers.h  

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

 Get the take number for the given asset MovieSceneToolHelpers.h  

static FTransform GetTransformOriginForFocusedSequence ( TSharedPtr< ISequencer > InSequencer
)

   MovieSceneToolHelpers.h  

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

 Returns the transform section for that guid. MovieSceneToolHelpers.h  

static bool HasHiddenMobility ( const UClass* ObjectClass
)

   MovieSceneToolHelpers.h  

static void ImportAnimSequenceTransforms ( const TSharedRef< ISequencer >& Sequencer,
const FAssetData& Asset,
UMovieScene3DTransformTrack* TransformTrack
)

 Import an animation sequence's root transforms into a transform section MovieSceneToolHelpers.h  

static void ImportAnimSequenceTransformsEnterPressed ( const TSharedRef< ISequencer >& Sequencer,
const TArray< FAssetData >& Asset,
UMovieScene3DTransformTrack* TransformTrack
)

 Import an animation sequence's root transforms into a transform section MovieSceneToolHelpers.h  

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

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

 Import into an FBX scene that has been readied already, via the ReadyFBXForImport call. MovieSceneToolHelpers.h  

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

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

 Import FBX into Control Rig Channels With Dialog MovieSceneToolHelpers.h  

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

 Import FBX Node to existing actor/node MovieSceneToolHelpers.h  

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

 Import FBX with dialog MovieSceneToolHelpers.h  

static bool IsValidAsset ( UMovieSceneSequence* Sequence,
const FAssetData& InAssetData
)

 Return whether this asset is valid for the given sequence MovieSceneToolHelpers.h  

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

 Lock the given camera actor to the viewport MovieSceneToolHelpers.h  

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

 Generate a combobox for editing enum values MovieSceneToolHelpers.h  

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

 Merge the set of passed in channels from each section at the specified section channel index. MovieSceneToolHelpers.h  

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

 Merge the following set of sections. MovieSceneToolHelpers.h  

static bool MergeSections ( UMovieSceneSection* BaseSection,
UMovieSceneSection* TopSection,
int32 StartIndex,
int32 EndIndex,
const TRange< FFrameNumber >& Range,
const TArray< UMovieSceneSection* >& TrackSections,
const int32* Increment
)

   MovieSceneToolHelpers.h  

static bool MergeTwoSections ( const FBaseTopSections& BT,
const TRange< FFrameNumber >& Range,
const TArray< UMovieSceneSection* >& TrackSections,
const int32* Increment
)

 Merge the TopSection onto the BaseSection. MovieSceneToolHelpers.h  

static bool MergeValue ( CurveValueType& InOutValue,
TArray< ChannelType* >& Channels,
const FFrameNumber& Frame,
int32 SectionChannelIndex,
const TArray< UMovieSceneSection* >& Sections,
const TArray< UMovieSceneSection* >& AbsoluteSections,
const TArray< UMovieSceneSection* >& OtherSections,
int32 OverrideChannelIndex,
FChannelMergeAlgorithm MergeAlgorithm
)

 Merge the value based upon the specified merge algorithm using cached parameters For the algorithm to be relaible it should be done per section blending type. MovieSceneToolHelpers.h  

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

 Export movie scene formats MovieSceneToolHelpers.h  

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

 Import movie scene formats MovieSceneToolHelpers.h  

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

 Log messages and display error message window for MovieScene translators MovieSceneToolHelpers.h  

static void MovieSceneTranslatorLogOutput ( FMovieSceneTranslator* InTranslator,
TSharedRef< FMovieSceneTranslatorContext > InContext
)

 Log error output for MovieScene translators MovieSceneToolHelpers.h  

static bool OptimizeSection ( const FKeyDataOptimizationParams& InParams,
UMovieSceneSection* InSection
)

   MovieSceneToolHelpers.h  

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

 Does this section overlap any other track section? MovieSceneToolHelpers.h  

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

 Parse a shot name into its components. MovieSceneToolHelpers.h  

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

 Get FBX Ready for Import. MovieSceneToolHelpers.h  

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

 Set or add a key onto a double channel. MovieSceneToolHelpers.h  

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

 Set or add a key onto a float channel. MovieSceneToolHelpers.h  
Set or add a key onto a double channel based on key value. MovieSceneToolHelpers.h  
Set or add a key onto a float channel based on key value. MovieSceneToolHelpers.h  

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

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

static bool SetTakeNumber ( const UMovieSceneSection* Section,
uint32 InTakeNumber
)

 Set the take number for the given asset MovieSceneToolHelpers.h  

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

 Show Export EDL Dialog MovieSceneToolHelpers.h  

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

 Show Import EDL Dialog MovieSceneToolHelpers.h  

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

 Splits sections at the given time MovieSceneToolHelpers.h  

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

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

 Trim or extend section at the given time MovieSceneToolHelpers.h  

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

 Trim section at the given time MovieSceneToolHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page