1. Epic GamesDeveloper
  3. FPersonaModule

FPersonaModule

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

API > API/Editor > API/Editor/Persona

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

   
Name FPersonaModule
Type class
Header File /Engine/Source/Editor/Persona/Public/PersonaModule.h
Include Path #include "PersonaModule.h"

Syntax

class FPersonaModule :  
    public IModuleInterface,  
    public IHasMenuExtensibility

Implements Interfaces

Structs

Name Remarks
FCommonToolMenuExtensionArgs Settings for AddCommonToolbarExtensions
FNotifyHostAssetParameters Struct allowing the anim notify system to interact with an asset type.

Typedefs

Name Type Remarks Include Path
FCommonToolbarExtensionArgs FCommonToolMenuExtensionArgs   PersonaModule.h
FOnCustomizeMeshDetails TBaseDelegate_TwoParams< void, IDetailLayoutBuilder &DetailLayout, TWeakObjectPtr< USkeletalMesh > SkeletalMesh > Delegates that allow customizing the mesh details layout and are called from within PersonaMeshDetails' CustomizeDetails(). PersonaModule.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CustomBlendProfiles TArray< TSharedPtr< IBlendProfilePickerExtender > >   PersonaModule.h  
CustomizeMeshDetailLayoutDelegates TArray< FOnCustomizeMeshDetails >   PersonaModule.h  
GetCurrentRecordingDelegate FGetCurrentRecording Delegate used to get the currently recording animation PersonaModule.h  
GetCurrentRecordingTimeDelegate FGetCurrentRecordingTime Delegate used to get the currently recording animation time PersonaModule.h  
IsRecordingActiveDelegate FIsRecordingActive Delegate used to query whether recording is active PersonaModule.h  
MenuExtensibilityManager TSharedPtr< FExtensibilityManager >   PersonaModule.h  
NotifyHostAssetVersion uint32 Version counter for NotifyHostParameters PersonaModule.h  
NotifyHostParameters TMap< FTopLevelAssetPath, FNotifyHostAssetParameters > Parameters for notify hosts PersonaModule.h  
OnPreviewSceneCreatedDelegate FOnPreviewSceneCreated Delegate broadcast when a preview scene is created PersonaModule.h  
OnRegisterLayoutExtensionsDelegate FOnRegisterLayoutExtensions Delegate broadcast to register common layout extensions PersonaModule.h  
OnRegisterTabsDelegate FOnRegisterTabs Delegate broadcast to register common tabs PersonaModule.h  
RecordDelegate FRecord Delegate used to start recording animation PersonaModule.h  
StopRecordingDelegate FStopRecording Delegate used to stop recording animation PersonaModule.h  
TickRecordingDelegate FTickRecording Delegate used to tick the skelmesh component recording PersonaModule.h  
ToolBarExtensibilityManager TSharedPtr< FExtensibilityManager >   PersonaModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddCommonMenuExtensions ( UToolMenu* InToolMenu,
const FCommonToolMenuExtensionArgs& InArgs
)

 Add common menu extensions PersonaModule.h  

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

 Add common toobar extensions (legacy support) - DEPRECATED PersonaModule.h  

virtual void AddCommonToolbarExtensions ( UToolMenu* InToolMenu,
const FCommonToolMenuExtensionArgs& InArgs
)

 Add common toolbar extensions PersonaModule.h  

virtual void AddLoopingInterpolation ( TArray< TWeakObjectPtr< class UAnimSequence > >& AnimSequences
)

 Add looping interpolation to the list of animations PersonaModule.h  

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

virtual void BroadcastAssetFamilyChange()

 Broadcast event that all asset families need to change PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreateAdvancedPreviewSceneTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< IPersonaPreviewScene >& InPreviewScene
) const

 Create a tab factory used to configure preview scene settings PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreateAnimAssetFindReplaceTabFactory ( const TSharedRef< FWorkflowCentricApplication >& InHostingApp,
const FAnimAssetFindReplaceConfig& InConfig
) const

 Create a tab factory for finding and replacing in anim data PersonaModule.h  

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

 Create a tab factory for the animation asset browser PersonaModule.h  

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

 Create a tab factory for editing anim blueprint parent overrides PersonaModule.h  

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

 Create a tab factory for editing anim blueprint preview & defaults PersonaModule.h  

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

 Create a tab factory for editing montage sections PersonaModule.h  

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

 Create an anim notifies tab factory PersonaModule.h  

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

 Create a tab factory for editing a single object (like an animation asset) PersonaModule.h  

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

 Create a shortcut widget for an asset family PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreateAttributeViewerTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const TSharedRef< class IPersonaPreviewScene >& InPreviewScene
) const

 Create a attributes viewer tab factory PersonaModule.h  

virtual TSharedRef< SWidget > CreateBlendSpaceEditWidget ( UBlendSpace* InBlendSpace,
const FBlendSpaceEditorArgs& InArgs
) const

 Create a widget to edit a blendspace PersonaModule.h  

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

 Deprecated PersonaModule.h  

virtual TSharedRef< SWidget > CreateBlendSpacePreviewWidget ( const FBlendSpacePreviewArgs& InArgs
) const

 Create a widget to preview a blendspace PersonaModule.h  

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

 Create a skeleton curve metadata editor tab factory PersonaModule.h  

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

   PersonaModule.h  

virtual TSharedRef< SWidget > CreateCurvePicker ( const USkeleton* InSkeleton,
FOnCurvePicked InOnCurvePicked,
FIsCurveNameMarkedForExclusion InIsCurveNameMarkedForExclusion
)

 Create a widget that can choose a curve name. PersonaModule.h  

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

   PersonaModule.h  

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

 Create a skeleton curve viewer tab factory PersonaModule.h  

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

virtual TSharedRef< IMorphTargetViewer > CreateDefaultMorphTargetViewerWidget ( const TSharedRef< IPersonaPreviewScene >& InPreviewScene,
FSimpleMulticastDelegate& OnPostUndo
) const

 Create the default morph target viewer widget PersonaModule.h  

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

 Create a details panel tab factory PersonaModule.h  

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

virtual TSharedRef< SWidget > CreateFindReplaceWidget ( const FAnimAssetFindReplaceConfig& InConfig
) const

 Create a widget for finding and replacing in anim data PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreateMorphTargetTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
TSharedRef< IMorphTargetViewer > InViewerWidget
) const

 Create a tab factory for for previewing morph targets PersonaModule.h  

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

 Create a tab factory for for previewing morph targets PersonaModule.h  

virtual TSharedRef< SWidget > CreateMultiCurvePicker ( const USkeleton* InSkeleton,
FOnCurvesPicked InOnCurvesPicked,
FIsCurveNameMarkedForExclusion InIsCurveNameMarkedForExclusion
)

 Create a widget that can choose multiple curve names. PersonaModule.h  

virtual TSharedRef< IAssetFamily > CreatePersonaAssetFamily ( const UObject* InAsset
) const

 Create an asset family for the supplied persona asset PersonaModule.h  
Create a Persona editor mode manager. PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreatePersonaToolboxTabFactory ( const TSharedRef< class FPersonaAssetEditorToolkit >& InHostingApp
) const

 Create a toolbox tab factory PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( USkeletalMesh* InSkeletalMesh,
const FPersonaToolkitArgs& PersonaToolkitArgs
) const

   PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( UAnimationAsset* InAnimationAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs
) const

   PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( USkeleton* InSkeleton,
const FPersonaToolkitArgs& PersonaToolkitArgs
) const

   PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( UPhysicsAsset* InPhysicsAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs
) const

   PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( UObject* InAsset,
const FPersonaToolkitArgs& PersonaToolkitArgs,
USkeleton* InSkeleton
) const

 Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use PersonaModule.h  

virtual TSharedRef< IPersonaToolkit > CreatePersonaToolkit ( UAnimBlueprint* InAnimBlueprint,
const FPersonaToolkitArgs& PersonaToolkitArgs
) const

   PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreatePersonaViewportTabFactory ( const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const FPersonaViewportArgs& InArgs
) const

 Create a persona viewport tab factory PersonaModule.h  

virtual TSharedRef< FWorkflowTabFactory > CreatePoseWatchTabFactory ( const TSharedRef< class FBlueprintEditor >& InBlueprintEditor
) const

 Create a tab factory for the pose watch manager PersonaModule.h  

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

 Create a retarget sources tab factory PersonaModule.h  

virtual TSharedRef< SWidget > CreateSkeletonNotifyPicker ( FOnNotifyPicked InOnNotifyPicked,
TSharedPtr< IEditableSkeleton > InEditableSkeleton,
TSharedPtr< FAssetEditorToolkit > InHostingApp,
bool bInShowSyncMarkers,
bool bInShowNotifies,
bool bInShowCompatibleSkeletonAssets,
bool bInShowOtherAssets
)

 Create a widget that can choose a notify name. PersonaModule.h  

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

   PersonaModule.h  

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

 Create a tab factory for editing slot names and groups PersonaModule.h  

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

 Customize the details of a slot node for the specified details view PersonaModule.h  

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

 Customize a skeletal mesh details panel PersonaModule.h  

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

   PersonaModule.h  

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

 Export to FBX files of the list of animations PersonaModule.h  

virtual const FNotifyHostAssetParameters * FindNotifyHostAsset ( UObject* InAsset
)

 Find registered notify host parameters by asset class. PersonaModule.h  

virtual TArray< FTopLevelAssetPath > GetAllNotifyHostAssetClassPaths()

 Get all the registered notify host class paths. PersonaModule.h  

const TArray< TSharedPtr< IBlendProfilePickerExtender > > & GetCustomBlendProfiles()

   PersonaModule.h  

virtual TArray< FOnCustomizeMeshDetails > & GetCustomizeMeshDetailsDelegates()

   PersonaModule.h  

virtual TSharedPtr< FExtensibilityManager > GetMenuExtensibilityManager()

 Gets the extensibility managers for outside entities to extend persona editor's menus and toolbars PersonaModule.h  

virtual uint32 GetNotifyHostAssetVersion()

 Get the version information for the notify host asset registry. PersonaModule.h  

virtual TSharedPtr< FExtensibilityManager > GetToolBarExtensibilityManager()

   PersonaModule.h  

virtual void ImportNewAsset ( USkeleton* InSkeleton,
EFBXImportType DefaultImportType
)

 Import a new asset using the supplied skeleton PersonaModule.h  

virtual FGetCurrentRecording & OnGetCurrentRecording()

 Delegate used to get the currently recording animation PersonaModule.h  

virtual FGetCurrentRecordingTime & OnGetCurrentRecordingTime()

 Delegate used to get the currently recording animation time PersonaModule.h  

virtual FIsRecordingActive & OnIsRecordingActive()

 Delegate used to query whether recording is active PersonaModule.h  

virtual FOnPreviewSceneCreated & OnPreviewSceneCreated()

 Delegate broadcast when a preview scene is created PersonaModule.h  

virtual FRecord & OnRecord()

 Delegate used to start recording animation PersonaModule.h  

virtual FOnRegisterLayoutExtensions & OnRegisterLayoutExtensions()

 Register common layout extensions PersonaModule.h  

virtual FOnRegisterTabs & OnRegisterTabs()

 Register common tabs PersonaModule.h  

virtual FStopRecording & OnStopRecording()

 Delegate used to stop recording animation PersonaModule.h  

virtual void RecordAssetOpened ( const FAssetData& InAssetData
) const

 Record that an asset was opened (forward to relevant asset families) PersonaModule.h  

void RegisterBlendProfilePickerExtender ( TSharedPtr< IBlendProfilePickerExtender > Extender
)

 Register a new blend provider provider in the editor picker for FBlendProfileInterfaceWrapper. PersonaModule.h  

virtual void RegisterNotifyHostAsset ( const FTopLevelAssetPath& InAssetClassPath,
const FNotifyHostAssetParameters& InParameters
)

 Register an asset type that can contain named anim notifies. PersonaModule.h  

virtual void RegisterPersonaViewportTabFactories ( FWorkflowAllowedTabSet& TabSet,
const TSharedRef< class FWorkflowCentricApplication >& InHostingApp,
const FPersonaViewportArgs& InArgs
) const

 Register 4 Persona viewport tab factories PersonaModule.h  

virtual void ShutdownModule()

 Called before the module is unloaded, right before the module object is destroyed. PersonaModule.h  

virtual void StartupModule()

 Called right after the module's DLL has been loaded and the module object has been created PersonaModule.h  

virtual void TestSkeletonCurveMetaDataForUse ( const TSharedRef< IEditableSkeleton >& InEditableSkeleton
) const

 Check all animations & skeletal meshes for curve metadata usage PersonaModule.h  

virtual void TestSkeletonCurveNamesForUse ( const TSharedRef< IEditableSkeleton >& InEditableSkeleton
) const

   PersonaModule.h  

void UnregisterBlendProfilePickerExtender ( const FName ExtenderId
)

   PersonaModule.h  

virtual void UnregisterNotifyHostAsset ( const FTopLevelAssetPath& InAssetClassPath
)

 Unregister an asset type that can contain named anim notifies. PersonaModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CreateAnimation ( const TArray< UObject* > NewAssets,
const EPoseSourceOption Option,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static bool CreatePoseAsset ( const TArray< UObject* > NewAssets,
const EPoseSourceOption Option,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static void FillCreateAnimationFromCurrentAnimationMenu ( FMenuBuilder& MenuBuilder,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static void FillCreateAnimationMenu ( FMenuBuilder& MenuBuilder,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static void FillCreatePoseAssetMenu ( FMenuBuilder& MenuBuilder,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static void FillInsertPoseMenu ( FMenuBuilder& MenuBuilder,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static TSharedRef< SWidget > GenerateCreateAssetMenu ( TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

static bool HandleAssetCreated ( const TArray< UObject* > NewAssets
)

   PersonaModule.h  

static void InsertCurrentPoseToAsset ( const FAssetData& NewPoseAssetData,
TWeakPtr< IPersonaToolkit > InWeakPersonaToolkit
)

   PersonaModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page