MovieSceneToolHelpers

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

void

 

CameraAdded

(
    UMovieScene* MovieScene,
    FGuid CameraGuid,
    FFrameNumber FrameNumber
)

Camera track was added, we usually do extra things, like add a Camera Cut tracks

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

bool

 

ExportFBX

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

Export FBX

Public function Static

bool

 

ExportToAnimSequence

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

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
)

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

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

FMovieSceneE...

 

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

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...,
    UMovieScene* InMovieScene,
    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,
    UMovieScene* InMovieScene,
    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

 

ImportFBXNode

(
    FString NodeName,
    UnFbx::FFbxCurvesAPI& CurveAPI,
    UMovieScene* InMovieScene,
    IMovieScenePlayer* Player,
    FMovieSceneSequenceIDRef TemplateID,
    FGuid ObjectBinding
)

Import FBX Node to existing actor/node

Public function Static

bool

 

ImportFBXWithDialog

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

Import FBX with dialog

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

 

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

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

 

TrimSection

(
    const TSet< TWeakObjectPtr< UMovieS...,
    FQualifiedFrameTime Time,
    bool bTrimLeft,
    bool bDeleteKeys
)

Trim section at the given time
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss