1. Epic GamesDeveloper
  3. FPersonaModule

FPersonaModule

Persona module manages the lifetime of all instances of Persona editors.

Unreal Engine C++ API Reference > Editor > Persona

Inheritance Hierarchy

References

   
Module Persona
Header /Engine/Source/Editor/Persona/Public/PersonaModule.h
Include #include "PersonaModule.h"

Syntax

class FPersonaModule :  
    public IModuleInterface,  
    public IHasMenuExtensibility

Remarks

Persona module manages the lifetime of all instances of Persona editors.

Functions

  Type Name Description
Public function Virtual void Add common menu extensions
Public function Virtual void

AddCommonToolbarExtensions ( FToolBarBuilder& InToolbarBuilder,
TSharedRef< IPersonaToolkit > PersonaToolkit,
const FCommonToolbarExtensionArgs& InArgs
)

 Add common toobar extensions (legacy support) - DEPRECATED
Public function Virtual void Add common toolbar extensions
Public function Virtual void Add looping interpolation to the list of animations
Public function Virtual void

ApplyCompression ( TArray< TWeakObjectPtr< class UAnimSequence >>& AnimSequences,
bool bPickBoneSettingsOverride
)

 Apply Compression to list of animations and optionally asks to pick an overrides to the bone compression settings
Public function Virtual Const void Broadcast event that all asset families need to change
Public function Virtual Const TSharedRef< FWorkflowTabFactory > Create a tab factory used to configure preview scene settings
Public function Virtual Const TSharedRef< FWorkflowTabFactory > Create a tab factory for finding and replacing in anim data
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAnimationAssetBrowserTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< IPersonaToolkit >& InPersonaToolkit,
FOnOpenNewAsset InOnOpenNewAsset,
FOnAnimationSequenceBrowserCreated InOnAnimationSequenceBrowserCreated,
bool bInShowHistory
)

 Create a tab factory for the animation asset browser
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAnimBlueprintAssetOverridesTabFactory ( const TSharedRef< class FBlueprintEditor >& InBlueprintEditor,
UAnimBlueprint* InAnimBlueprint,
FSimpleMulticastDelegate& InOnPostUndo
)

 Create a tab factory for editing anim blueprint parent overrides
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAnimBlueprintPreviewTabFactory ( const TSharedRef< class FBlueprintEditor >& InBlueprintEditor,
const TSharedRef< IPersonaPreviewScene >& InPreviewScene
)

 Create a tab factory for editing anim blueprint preview & defaults
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAnimMontageSectionsTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< IPersonaToolkit >& InPersonaToolkit,
FSimpleMulticastDelegate& InOnSectionsChanged
)

 Create a tab factory for editing montage sections
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAnimNotifiesTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IEditableSkeleton >& InEditableSkeleton,
FOnObjectsSelected InOnObjectsSelected
)

 Create an anim notifies tab factory
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateAssetDetailsTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
FOnGetAsset InOnGetAsset,
FOnDetailsCreated InOnDetailsCreated
)

 Create a tab factory for editing a single object (like an animation asset)
Public function Virtual Const TSharedRef< SWidget >

CreateAssetFamilyShortcutWidget ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IAssetFamily >& InAssetFamily
)

 Create a shortcut widget for an asset family
Public function Virtual Const TSharedRef< SWidget > Create a widget to edit a blendspace
Public function Virtual Const TSharedRef< SWidget > Create a widget to preview a blendspace
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateCurveMetadataEditorTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
UObject* InMetadataHost,
const TSharedRef< class IPersonaPreviewScene >& InPreviewScene,
FOnObjectsSelected InOnObjectsSelected
)

 Create a skeleton curve metadata editor tab factory
Public function Virtual TSharedRef< SWidget >

CreateCurvePicker ( const USkeleton* InSkeleton,
FOnCurvePicked InOnCurvePicked,
FIsCurveNameMarkedForExclusion InIsCurveNameMarkedForExclusion
)

 Create a widget that can choose a curve name.
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateCurveViewerTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedPtr< class IEditableSkeleton >& InEditableSkeleton,
const TSharedRef< class IPersonaPreviewScene >& InPreviewScene,
FOnObjectsSelected InOnObjectsSelected
)

 Create a skeleton curve viewer tab factory
Public function Virtual TSharedRef< IAnimSequenceCurveEditor >

CreateCurveWidgetForAnimDocument ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< IPersonaPreviewScene >& InPreviewScene,
UAnimSequenceBase* InAnimSequence,
const TSharedPtr< ITimeSliderController >& InExternalTimeSliderController,
const TSharedPtr< FTabManager >& InTabManager
)

 Create a widget that acts as a curve document for an animation asset
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateDetailsTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
FOnDetailsCreated InOnDetailsCreated
)

 Create a details panel tab factory
Public function Virtual TSharedRef< SWidget >

CreateEditorWidgetForAnimDocument ( const TSharedRef< IAnimationEditor >& InHostingApp,
UObject* InAnimAsset,
const FAnimDocumentArgs& InArgs,
FString& OutDocumentLink
)

 Create a widget that acts as a document for an animation asset
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateMorphTargetTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< IPersonaPreviewScene >& InPreviewScene,
FSimpleMulticastDelegate& OnPostUndo
)

 Create a tab factory for for previewing morph targets
Public function Virtual Const TSharedRef< IAssetFamily >

CreatePersonaAssetFamily ( const UObject* InAsset
)

 Create an asset family for the supplied persona asset
Public function Virtual IPersonaEditorModeManager * Create a Persona editor mode manager.
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( USkeletalMesh* InSkeletalMesh,
const FPersonaToolkitArgs& PersonaToolkitArgs
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( UAnimationAsset* InAnimationAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( USkeleton* InSkeleton,
const FPersonaToolkitArgs& PersonaToolkitArgs
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( UPhysicsAsset* InPhysicsAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( UObject* InAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs,
USkeleton* InSkeleton
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< IPersonaToolkit >

CreatePersonaToolkit ( UAnimBlueprint* InAnimBlueprint,
const FPersonaToolkitArgs& PersonaToolkitArgs
)

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
Public function Virtual Const TSharedRef< FWorkflowTabFactory > Create a persona viewport tab factory
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreatePoseWatchTabFactory ( const TSharedRef< class FBlueprintEditor >& InBlueprintEditor
)

 Create a tab factory for the pose watch manager
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateRetargetSourcesTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IEditableSkeleton >& InEditableSkeleton,
const TSharedRef< IPersonaPreviewScene >& InPreviewScene,
FSimpleMulticastDelegate& InOnPostUndo
)

 Create a retarget sources tab factory
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateSkeletonSlotNamesTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IEditableSkeleton >& InEditableSkeleton,
FOnObjectSelected InOnObjectSelected
)

 Create a tab factory for editing slot names and groups
Public function Virtual void

CustomizeBlueprintEditorDetails ( const TSharedRef< class IDetailsView >& InDetailsView,
FOnInvokeTab InOnInvokeTab
)

 Customize the details of a slot node for the specified details view
Public function Virtual void

CustomizeMeshDetails ( const TSharedRef< IDetailsView >& InDetailsView,
const TSharedRef< IPersonaToolkit >& InPersonaToolkit
)

 Customize a skeletal mesh details panel
Public function Virtual bool

ExportToFBX ( TArray< TWeakObjectPtr< class UAnimSequence >>& AnimSequences,
USkeletalMesh* SkeletalMesh
)

 Export to FBX files of the list of animations
Public function Virtual TSharedPtr< FExtensibilityManager >  
Public function Virtual void

ImportNewAsset ( USkeleton* InSkeleton,
EFBXImportType DefaultImportType
)

 Import a new asset using the supplied skeleton
Public function Virtual FGetCurrentRecording & Delegate used to get the currently recording animation
Public function Virtual FGetCurrentRecordingTime & Delegate used to get the currently recording animation time
Public function Virtual FIsRecordingActive & Delegate used to query whether recording is active
Public function Virtual FOnPreviewSceneCreated & Delegate broadcast when a preview scene is created
Public function Virtual FRecord & Delegate used to start recording animation
Public function Virtual FOnRegisterLayoutExtensions & Register common layout extensions
Public function Virtual FOnRegisterTabs & Register common tabs
Public function Virtual FStopRecording & Delegate used to stop recording animation
Public function Virtual Const void

RecordAssetOpened ( const FAssetData& InAssetData
)

 Record that an asset was opened (forward to relevant asset families)
Public function Virtual Const void Register 4 Persona viewport tab factories
Public function Virtual Const void Check all animations & skeletal meshes for curve metadata usage

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called before the module is unloaded, right before the module object is destroyed.
Public function Virtual void Called right after the module's DLL has been loaded and the module object has been created

Overridden from IHasMenuExtensibility

  Type Name Description
Public function Virtual TSharedPtr< FExtensibilityManager > Gets the extensibility managers for outside entities to extend persona editor's menus and toolbars

Classes

  Type Name Description
Public struct FCommonToolMenuExtensionArgs Settings for AddCommonToolbarExtensions  

Enums

  Type Name Description
Private enum EPoseSourceOption Options for asset creation  

Typedefs

Name Description
FCommonToolbarExtensionArgs  

Deprecated Functions

  Type Name Description
Public function Virtual Const TSharedRef< SWidget >

CreateBlendSpacePreviewWidget ( TAttribute< const UBlendSpace* > InBlendSpace,
TAttribute< FVector > InBlendPosition,
TAttribute< FVector > InFilteredBlendPosition
)

 Please use the overload that takes a FBlendSpacePreviewArgs struct
Public function Virtual TSharedRef< SWidget >

CreateCurvePicker ( TSharedRef< IEditableSkeleton > InEditableSkeleton,
FOnCurvePicked InOnCurvePicked,
FIsCurveNameMarkedForExclusion InIsCurveNameMarkedForExclusion
)

 Please use CreateCurvePicker that takes a const USkeleton*
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateCurveViewerTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedPtr< class IEditableSkeleton >& InEditableSkeleton,
const TSharedRef< class IPersonaPreviewScene >& InPreviewScene,
FSimpleMulticastDelegate& InOnPostUndo,
FOnObjectsSelected InOnObjectsSelected
)

 Please use the overload that does not take a post-undo delegate
Public function Virtual Const TSharedRef< FWorkflowTabFactory >

CreateSkeletonSlotNamesTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IEditableSkeleton >& InEditableSkeleton,
FSimpleMulticastDelegate& InOnPostUndo,
FOnObjectSelected InOnObjectSelected
)

 Please use the overload that does not take a post-undo delegate
Public function Virtual void

CustomizeSlotNodeDetails ( const TSharedRef< class IDetailsView >& InDetailsView,
FOnInvokeTab InOnInvokeTab
)

 Function renamed, please use CustomizeBlueprintEditorDetails
Public function Virtual Const void

TestSkeletonCurveNamesForUse ( const TSharedRef< IEditableSkeleton >& InEditableSkeleton
)

 Please use TestSkeletonCurveMetaDataForUse

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page