MovieSceneToolHelpers

Choose your operating system:

Windows

macOS

Linux

References

Module

MovieSceneTools

Header

/Engine/Source/Editor/MovieSceneTools/Public/MovieSceneToolHelpers.h

Include

#include "MovieSceneToolHelpers.h"

Syntax

class MovieSceneToolHelpers

Functions

Name Description

Public function Static

USkeletalMes...

 

AcquireSkeletalMeshFromObject

(
    UObject* BoundObject
)

Acquire first SkeletalMeshComponent from the Object

Public function Static

bool

 

BakeToSkelMeshToCallbacks

(
    UMovieScene* MovieScene,
    IMovieScenePlayer* Player,
    USkeletalMeshComponent* SkelMe...,
    FMovieSceneSequenceIDRef& Template,
    FMovieSceneSequenceTransform& Root...,
    UAnimSeqExportOption* ExportOp...,
    FInitAnimationCB InitCallback,
    FStartAnimationCB StartCallback,
    FTickAnimationCB TickCallback,
    FEndAnimationCB EndCallback
)

Bake the SkelMesh to a generic object wich implements a set of callbacks

Public function Static

FString

 

ComposeShotName

(
    const FString& ShotPrefix,
    uint32 ShotNumber,
    uint32 TakeNumber
)

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

 

CopyKeyDataToMoveAxis

(
    const TMovieSceneChannelData< FMovi...,
    UInterpTrackMoveAxis* MoveAxis,
    FFrameRate FrameRate
)

Copy key data to move axis

Public function Static

void

 

CreateCameraCutSectionForCamera

(
    UMovieScene* MovieScene,
    FGuid CameraGuid,
    FFrameNumber FrameNumber
)

Create a new camera cut section for the given camera

Public function Static

bool

 

ExportFBX

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

Export FBX

Public function Static

bool

 

ExportToAnimSequence

(
    UAnimSequence* AnimSequence,
    UAnimSeqExportOption* ExportOp...,
    UMovieScene* MovieScene,
    IMovieScenePlayer* Player,
    USkeletalMeshComponent* SkelMe...,
    FMovieSceneSequenceIDRef& Template,
    FMovieSceneSequenceTransform& Root...
)

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

Public function Static

UObject *...

 

ExportToCameraAnim

(
    UMovieScene* InMovieScene,
    FGuid& InObjectBinding
)

Export the object binding to a camera anim

Public function Static

int32

 

FindAvailableRowIndex

(
    UMovieSceneTrack* InTrack,
    UMovieSceneSection* InSection,
    const TArray< UMovieSceneSection&#...
)

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* Sect...,
    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&#...,
    FFrameNumber Time
)

Generate a new shot name

Public function Static

FString

 

GenerateNewShotPath

(
    UMovieScene* SequenceMovieScen...,
    FString& NewShotName
)

Generate a new shot package

Public function Static

void

 

GetActorWorldTransforms

(
    IMovieScenePlayer* Player,
    UMovieSceneSequence* InSequenc...,
    FMovieSceneSequenceIDRef Template,
    const FActorForWorldTransforms& Ac...,
    const TArray< FFrameNumber >& Fram...,
    TArray< FTransform >& OutWorldTran...
)

Get an actors world transforms at the specified times using a player

Public function Static

void

 

GetActorWorldTransforms

(
    ISequencer* Sequencer,
    const FActorForWorldTransforms& Ac...,
    const TArray< FFrameNumber >& Fram...,
    TArray< FTransform >& OutWorldTran...
)

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* >&...
)

Get the fbx cameras from the requested parent node

Public function Static

const FMovie...

 

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&#...,
    UObject* Object,
    FFrameTime KeyTime,
    FVector& KeyPos,
    FRotator& KeyRot,
    const TSharedPtr< ISequencer >& Se...
)

Get the location at time for the specified transform evaluation track

Public function Static

void

 

GetParents

(
    TArray< const UObject* >& Par...,
    const UObject* InObject
)

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

Public function Static

bool

 

GetParentTM

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

Return Return ParentTm for current Parent Object

Public function Static

FTransform

 

GetRefFrameFromParents

(
    const TSharedPtr< ISequencer >& Se...,
    const TArray< const UObject* >...,
    FFrameTime KeyTime
)

Return Reference Frame from the passed in paretns

Public function Static

bool

 

GetTakeNumber

(
    const UMovieSceneSection* Sect...,
    FAssetData AssetData,
    uint32& OutTakeNumber
)

Get the take number for the given asset

Public function Static

bool

 

HasHiddenMobility

(
    const UClass* ObjectClass
)

Public function Static

void

 

ImportFBXCameraToExisting

(
    UnFbx::FFbxImporter* FbxImport...,
    UMovieSceneSequence* InSequenc...,
    IMovieScenePlayer* Player,
    FMovieSceneSequenceIDRef TemplateID,
    TMap< FGuid, FString >& InObjectBi...,
    bool bMatchByNameOnly,
    bool bNotifySlate
)

Import FBX Camera to existing camera's

Public function Static

bool

 

ImportFBXIfReady

(
    UWorld* World,
    UMovieSceneSequence* InSequenc...,
    IMovieScenePlayer* Player,
    FMovieSceneSequenceIDRef TemplateID,
    TMap< FGuid, FString >& ObjectBind...,
    UMovieSceneUserImportFBXSettings&#...,
    const FFBXInOutParameters& InFBXPa...
)

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

Public function Static

bool

 

ImportFBXIntoChannelsWithDialog

(
    const TSharedRef< ISequencer >& In...,
    TArray< FFBXNodeAndChannels >*...
)

Import FBX into Channels With Dialog

Public function Static

bool

 

ImportFBXIntoControlRigChannels

(
    UMovieScene* MovieScene,
    const FString& ImportFilename,
    UMovieSceneUserImportFBXControlRigS...,
    TArray< FFBXNodeAndChannels >*...,
    const TArray< FName >& SelectedCon...,
    FFrameRate FrameRate
)

Import FBX into Channels

Public function Static

bool

 

ImportFBXNode

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

Import FBX Node to existing actor/node

Public function Static

bool

 

ImportFBXWithDialog

(
    UMovieSceneSequence* InSequenc...,
    ISequencer& InSequencer,
    const TMap< FGuid, FString >& InOb...,
    TOptional< bool > bCreateCameras
)

Import FBX with dialog

Public function Static

void

 

LockCameraActorToViewport

(
    const TSharedPtr< ISequencer >& Se...,
    ACameraActor* CameraActor
)

Lock the given camera actor to the viewport

Public function Static

TSharedRef< ...

 

MakeEnumComboBox

(
    const UEnum* Enum,
    TAttribute< int32 > CurrentValue,
    SEnumComboBox::FOnEnumSelectionChan...
)

Generate a combobox for editing enum values

Public function Static

bool

 

MovieSceneTranslatorExport

(
    FMovieSceneExporter* InExporte...,
    const UMovieScene* InMovieScen...,
    const FMovieSceneCaptureSettings& ...
)

Export movie scene formats

Public function Static

bool

 

MovieSceneTranslatorImport

(
    FMovieSceneImporter* InImporte...,
    UMovieScene* InMovieScene,
    FFrameRate InFrameRate,
    FString InOpenDirectory
)

Import movie scene formats

Public function Static

void

 

MovieSceneTranslatorLogMessages

(
    FMovieSceneTranslator* InTrans...,
    TSharedRef< FMovieSceneTranslatorCo...,
    bool bDisplayMessages
)

Log messages and display error message window for MovieScene translators

Public function Static

void

 

MovieSceneTranslatorLogOutput

(
    FMovieSceneTranslator* InTrans...,
    TSharedRef< FMovieSceneTranslatorCo...
)

Log error output for MovieScene translators

Public function Static

bool

 

OverlapsSection

(
    UMovieSceneTrack* InTrack,
    UMovieSceneSection* InSection,
    const TArray< UMovieSceneSection&#...
)

Does this section overlap any other track section?

Public function Static

bool

 

ParseShotName

(
    const FString& ShotName,
    FString& ShotPrefix,
    uint32& ShotNumber,
    uint32& TakeNumber
)

Parse a shot name into its components.

Public function Static

bool

 

ReadyFBXForImport

(
    const FString& ImportFilename,
    UMovieSceneUserImportFBXSettings&#...,
    FFBXInOutParameters& OutFBXParams
)

Get FBX Ready for Import.

Public function Static

EInterpCurve...

 

RichCurveInterpolationToMatineeInterpolation

(
    ERichCurveInterpMode InterpMode,
    ERichCurveTangentMode TangentMode
)

Rich curve interpolation to matinee interpolation

Public function Static

void

 

SetOrAddKey

(
    TMovieSceneChannelData< FMovieScene...,
    FFrameNumber Time,
    float Value
)

Set or add a key onto a float channel.

Public function Static

void

 

SetOrAddKey

(
    TMovieSceneChannelData< FMovieScene...,
    FFrameNumber Time,
    double Value
)

Set or add a key onto a double channel.

Public function Static

bool

 

SetTakeNumber

(
    const UMovieSceneSection* Sect...,
    uint32 InTakeNumber
)

Set the take number for the given asset

Public function Static

bool

 

ShowExportEDLDialog

(
    const UMovieScene* InMovieScen...,
    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< TWeakObjectPtr< UMovieS...,
    FQualifiedFrameTime Time,
    bool bDeleteKeys
)

Splits sections at the given time

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< TWeakObjectPtr< UMovieS...,
    FQualifiedFrameTime Time,
    bool bTrimLeft,
    bool bDeleteKeys
)

Trim section at the given time