Navigation
| Name | Persona |
| Type | Editor |
| Location | /Engine/Source/Editor/Persona/ |
| Module Build Rules | Persona.Build.cs |
Classes
Structs
| Name | Remarks |
|---|---|
| FAnimAssetFindReplaceConfig | Configuration for the find/replace tab |
| FAnimationScrubPanelDelegates | Struct to provide delegates to change the timeline behavior for certain clients |
| FAnimDocumentArgs | |
| FBlendSpaceEditorArgs | |
| FBlendSpacePreviewArgs | |
| FCopyOptions | Copy options structure for CopyPropertiesToCDO |
| FPersonaAdvancedPreviewSceneTabSettings | Some settings for the detail customization inside the advanced preview scene settings tab. |
| FPersonaEditModes | Editor mode constants. |
| FPersonaTabs | Tab constants. |
| FPersonaToolkitArgs | Initialization parameters for persona toolkits |
| FPersonaViewportArgs | Arguments used to create a persona viewport tab |
| FPersonaViewportNotificationOptions | |
| FPhysicsAssetRenderSettings | Per Physics Asset parameters that determine how debug draw functions should render that asset in an editor viewport. |
| FSkinWeightProfileHelpers | Set of editor-only helper functions used by various bits of UI related to Skin Weight profiles |
| FToolBoxSummoner | |
| HPersonaBoneHitProxy | |
| HPersonaSocketHitProxy | |
| IAnimationEditorsAssetFamilyInterface | |
| IPersonaViewportState | Opaque state interface for saving and restoring viewport state |
Interfaces
| Name | Remarks |
|---|---|
| IAnimAssetFindReplace | Public interface to the find/replace widget |
| IAnimationSequenceBrowser | |
| IAnimSequenceCurveEditor | Interface to the curve editor tab in the anim sequence editor |
| IAssetFamily | Represents a group of related assets, e.g. a skeleton, its animations and skeletal meshes |
| IBlendProfilePickerExtender | |
| IBlendSpaceAnalysisFeature | Users wishing to add their own analysis functions and structures should inherit from this, implement the virtual functions, and register an instance with IModularFeatures. |
| IHasPersonaToolkit | Interface implemented by objects that hold a persona toolkit |
| IMorphTargetViewer | Interface to the morph target viewer in the skeletal mesh editor |
| IPersonaEditMode | |
| IPersonaEditorModeManager | |
| IPersonaManagerContext | Persona-specific extensions to the asset editor mode manager |
| IPersonaPreviewScene | |
| IPersonaToolkit | Reusable 'Persona' features for asset editors concerned with USkeleton-related assets |
| IPersonaViewport | Abstract viewport that can save and restore state |
| IPhysicsAssetRenderInterface |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| COMAccessorFunctionFn | TFunctionRef< TPair< bool, FVector >(const int32) > | PhysicsAssetRenderUtils.h | |
| CreateBodyHitProxyFn | TFunctionRef< HHitProxy *(const int32 BodyIndex, const EAggCollisionShape::Type PrimitiveType, const int32 PrimitiveIndex) > | PhysicsAssetRenderUtils.h | |
| CreateCoMHitProxyFn | TFunctionRef< HHitProxy *(const int32 InBodyIndex) > | PhysicsAssetRenderUtils.h | |
| CreateConstraintHitProxyFn | TFunctionRef< HHitProxy *(const int32 InConstraintIndex) > | PhysicsAssetRenderUtils.h | |
| FAnimationScrubPanel_GetIsLooping | TBaseDelegate_NoParams< TOptional< bool > > | PersonaModule.h | |
| FAnimationScrubPanel_GetNumberOfKeys | TBaseDelegate_NoParams< TOptional< uint32 > > | PersonaModule.h | |
| FAnimationScrubPanel_GetPlaybackMode | TBaseDelegate_NoParams< TOptional< int32 > > | PersonaModule.h | |
| FAnimationScrubPanel_GetPlaybackTime | TBaseDelegate_NoParams< TOptional< float > > | PersonaModule.h | |
| FAnimationScrubPanel_GetPlaybackTimeRange | TBaseDelegate_NoParams< TOptional< FVector2f > > | PersonaModule.h | |
| FAnimationScrubPanel_GetRecordingVisibility | TBaseDelegate_NoParams< TOptional< EVisibility > > | PersonaModule.h | |
| FAnimationScrubPanel_IsRecordingActive | TBaseDelegate_NoParams< TOptional< bool > > | PersonaModule.h | |
| FAnimationScrubPanel_SetIsLooping | TBaseDelegate_OneParam< bool, bool > | PersonaModule.h | |
| FAnimationScrubPanel_SetPlaybackMode | TBaseDelegate_OneParam< bool, int32 > | PersonaModule.h | |
| FAnimationScrubPanel_SetPlaybackTime | TBaseDelegate_TwoParams< bool, float, bool > | PersonaModule.h | |
| FAnimationScrubPanel_StartRecording | TBaseDelegate_NoParams< bool > | PersonaModule.h | |
| FAnimationScrubPanel_StepBackward | TBaseDelegate_NoParams< bool > | PersonaModule.h | |
| FAnimationScrubPanel_StepForward | TBaseDelegate_NoParams< bool > | PersonaModule.h | |
| FAnimationScrubPanel_StopRecording | TBaseDelegate_NoParams< bool > | PersonaModule.h | |
| FDisplayedBoneMappingInfoPtr | TSharedPtr< FDisplayedBoneMappingInfo > | SBoneMappingBase.h | |
| FGetCurrentRecording | TBaseDelegate_TwoParams< void, USkeletalMeshComponent *, class UAnimSequence *& > | PersonaModule.h | |
| FGetCurrentRecordingTime | TBaseDelegate_TwoParams< void, USkeletalMeshComponent *, float & > | PersonaModule.h | |
| FGetLodModel | TBaseDelegate_NoParams< const FSkeletalMeshLODModel & > | ReferenceSectionSelectionWidget.h | |
| FGetReferenceSkeleton | TBaseDelegate_NoParams< const struct FReferenceSkeleton & > | BoneSelectionWidget.h | |
| FGetSelectedBone | TBaseDelegate_OneParam< FName, bool & > | BoneSelectionWidget.h | |
| FGetSelectedSection | TBaseDelegate_OneParam< int32, bool & > | ReferenceSectionSelectionWidget.h | |
| FGetSocketList | TBaseDelegate_NoParams< const TArray< class USkeletalMeshSocket * > & > | BoneSelectionWidget.h | |
| FIsCurveNameMarkedForExclusion | TBaseDelegate_OneParam< bool, const FName & > | Called by the curve picker to filter out curve names that are displayed to the user. | PersonaDelegates.h |
| FIsRecordingActive | TBaseDelegate_TwoParams< void, USkeletalMeshComponent *, bool & > | PersonaModule.h | |
| FOnAnimationSequenceBrowserCreated | TBaseDelegate_OneParam< void, const TSharedRef< IAnimationSequenceBrowser > & > | Called back when an anim sequence browser is created | PersonaModule.h |
| FOnAnimChanged | FOnAnimChangedMulticaster::FDelegate | Anim changed | IPersonaPreviewScene.h |
| FOnAnimChangedMulticaster | TMulticastDelegate_OneParam< void, UAnimationAsset * > | Called when animation asset has been changed | IPersonaPreviewScene.h |
| FOnAttachToolkit | TMulticastDelegate_OneParam< void, const TSharedRef< IToolkit > & > | PersonaAssetEditorToolkit.h | |
| FOnAttributesPicked | TBaseDelegate_OneParam< void, const TConstArrayView< FAnimationAttributeIdentifier > > | Called by the attribute picker to indicate the attributes chosen by the user. | PersonaDelegates.h |
| FOnBlendSpaceCanvasDoubleClicked | TBaseDelegate_NoParams< void > | Called when the blendspace canvas is double clicked. | PersonaDelegates.h |
| FOnBlendSpaceNavigateDown | TBaseDelegate_NoParams< void > | Called when the user navigates with pagedown. | PersonaDelegates.h |
| FOnBlendSpaceNavigateUp | TBaseDelegate_NoParams< void > | Called when the user navigates with pageup. | PersonaDelegates.h |
| FOnBlendSpaceSampleAdded | TBaseDelegate_ThreeParams< int32, UAnimSequence *, const FVector &, bool > | Called when a blendspace sample point is added. Returns the new SampleIndex. | PersonaDelegates.h |
| FOnBlendSpaceSampleDoubleClicked | TBaseDelegate_OneParam< void, int32 > | Called when a blendspace sample point is double clicked. | PersonaDelegates.h |
| FOnBlendSpaceSampleDuplicated | TBaseDelegate_ThreeParams< void, int32, const FVector &, bool > | Called when a blendspace sample point is added. | PersonaDelegates.h |
| FOnBlendSpaceSampleRemoved | TBaseDelegate_OneParam< void, const int32 > | Called when a blendspace sample point is removed. | PersonaDelegates.h |
| FOnBlendSpaceSampleReplaced | TBaseDelegate_TwoParams< void, const int32, UAnimSequence * > | Called when a blendspace sample point is replaced. | PersonaDelegates.h |
| FOnBoneMappingChanged | TBaseDelegate_TwoParams< void, FName, FName > | SBoneMappingBase.h | |
| FOnBoneSelectionChanged | TBaseDelegate_OneParam< void, FName > | BoneSelectionWidget.h | |
| FOnBoneSizeSet | TBaseDelegate_OneParam< void, float > | AnimationEditorViewportClient.h | |
| FOnCreateBoneMapping | TBaseDelegate_TwoParams< void, const FString &, TArray< TSharedPtr< FDisplayedBoneMappingInfo > > & > | SBoneMappingBase.h | |
| FOnCreateClothingRequested | TBaseDelegate_OneParam< void, FSkeletalMeshClothBuildParams & > | SCreateClothingSettingsPanel.h | |
| FOnCreateViewport | TMulticastDelegate_OneParam< void, TWeakPtr< class SAnimationEditorViewportTabBody > > | Called when the preview viewport is created. | PersonaDelegates.h |
| FOnCurvePicked | TBaseDelegate_OneParam< void, const FName & > | Called by the curve picker to indicate that a curve was chosen by the user. | PersonaDelegates.h |
| FOnCurvesPicked | TBaseDelegate_OneParam< void, const TConstArrayView< FName > > | Called by the curve picker to indicate the curves chosen by the user. | PersonaDelegates.h |
| FOnDetachToolkit | TMulticastDelegate_OneParam< void, const TSharedRef< IToolkit > & > | PersonaAssetEditorToolkit.h | |
| FOnDetailsCreated | TBaseDelegate_OneParam< void, const TSharedRef< IDetailsView > & > | Called back when a details panel is created | PersonaModule.h |
| FOnEditCurves | TBaseDelegate_ThreeParams< void, UAnimSequenceBase *, const TArray< IAnimationEditor::FCurveEditInfo > &, const TSharedPtr< ITimeSliderController > & > | Called to invoke the curve editor. | PersonaDelegates.h |
| FOnExtendBlendSpaceSampleTooltip | TBaseDelegate_OneParam< TSharedRef< SWidget >, int32 > | Called to extend a sample's tooltip. | PersonaDelegates.h |
| FOnGetAsset | TBaseDelegate_NoParams< UObject * > | Called to get an object (used by the asset details panel) | PersonaDelegates.h |
| FOnGetBlendSpaceSampleName | TBaseDelegate_OneParam< FName, int32 > | Called to get the overridden name of a blend sample. | PersonaDelegates.h |
| FOnGetBoneMapping | TBaseDelegate_OneParam< FName, FName > | SBoneMappingBase.h | |
| FOnGetBoneSize | TBaseDelegate_NoParams< float > | AnimationEditorViewportClient.h | |
| FOnGetFilteredText | TBaseDelegate_NoParams< FText & > | SBoneMappingBase.h | |
| FOnGetViewportText | TBaseDelegate_OneParam< FText, EViewportCorner > | Delegate used to provide custom text for the viewport corners | PersonaModule.h |
| FOnInvokeTab | TBaseDelegate_OneParam< void, const FTabId & > | Called to invoke a specified tab. | PersonaDelegates.h |
| FOnMeshClick | FOnMeshClickMulticaster::FDelegate | IPersonaPreviewScene.h | |
| FOnMeshClickMulticaster | TMulticastDelegate_TwoParams< void, HActor *, const FViewportClick & > | IPersonaPreviewScene.h | |
| FOnNotifyPicked | TBaseDelegate_OneParam< void, const FName & > | Called by the notify picker to indicate that a notify was chosen by the user. | PersonaDelegates.h |
| FOnObjectSelected | TBaseDelegate_OneParam< void, UObject * > | Called to display a selected object in a details panel. | PersonaDelegates.h |
| FOnObjectsSelected | TBaseDelegate_OneParam< void, const TArray< UObject * > & > | Called to display a selected object in a details panel. | PersonaDelegates.h |
| FOnOpenNewAsset | TBaseDelegate_OneParam< void, UObject * > | Called to replace the currently edited asset or open it (depending on context) | PersonaDelegates.h |
| FOnPreviewMeshChanged | FOnPreviewMeshChangedMulticaster::FDelegate | Preview mesh changed | IPersonaPreviewScene.h |
| FOnPreviewMeshChangedMulticaster | TMulticastDelegate_TwoParams< void, USkeletalMesh *, USkeletalMesh * > | Called when the preview mesh has been changed;. | IPersonaPreviewScene.h |
| FOnPreviewSceneCreated | TMulticastDelegate_OneParam< void, const TSharedRef< IPersonaPreviewScene > & > | Called back when a Persona preview scene is created | PersonaModule.h |
| FOnPreviewSceneSettingsCustomized | TMulticastDelegate_OneParam< void, IDetailLayoutBuilder &DetailBuilder > | Called back when a Persona preview scene settings are customized | PersonaModule.h |
| FOnRegisterLayoutExtensions | TMulticastDelegate_OneParam< void, FLayoutExtender & > | Called back to register common layout extensions | PersonaModule.h |
| FOnRegisterTabs | TMulticastDelegate_TwoParams< void, FWorkflowAllowedTabSet &, TSharedPtr< FAssetEditorToolkit > > | Called back to register tabs | PersonaModule.h |
| FOnRemoveAttachedComponentFilter | TBaseDelegate_OneParam< bool, const USceneComponent * > | The delegate to check if the attach component can be removed. | IPersonaPreviewScene.h |
| FOnSectionSelectionChanged | TBaseDelegate_OneParam< void, int32 > | ReferenceSectionSelectionWidget.h | |
| FOnSelectBlendProfile | TMulticastDelegate_OneParam< void, class UBlendProfile * > | Called when a blend profile is selected in the blend profile tab. | PersonaDelegates.h |
| FOnSelectedBoneChanged | FOnSelectedBoneChangedMulticaster::FDelegate | IPersonaPreviewScene.h | |
| FOnSelectedBoneChangedMulticaster | TMulticastDelegate_TwoParams< void, const FName &, ESelectInfo::Type > | The selected bone changed. | IPersonaPreviewScene.h |
| FOnSelectedBonesChanged | FOnSelectedBonesChangedMulticaster::FDelegate | IPersonaPreviewScene.h | |
| FOnSelectedBonesChangedMulticaster | TMulticastDelegate_TwoParams< void, const TArray< FName > &, ESelectInfo::Type > | The bones selection changed. | IPersonaPreviewScene.h |
| FOnSelectedLODChanged | FOnSelectedLODChangedMulticaster::FDelegate | IPersonaPreviewScene.h | |
| FOnSelectedLODChangedMulticaster | TMulticastDelegate_NoParams< void > | The selected LOD changed. | IPersonaPreviewScene.h |
| FOnSelectedSocketChanged | FOnSelectedSocketChangedMulticaster::FDelegate | IPersonaPreviewScene.h | |
| FOnSelectedSocketChangedMulticaster | TMulticastDelegate_OneParam< void, const FSelectedSocketInfo & > | The selected socket changed. | IPersonaPreviewScene.h |
| FOnSetBlendSpacePreviewPosition | TBaseDelegate_OneParam< void, FVector > | Called to let the blendspace editor UI set the preview position of an external blendspace node. | PersonaDelegates.h |
| FOnStopEditingCurves | TBaseDelegate_OneParam< void, const TArray< IAnimationEditor::FCurveEditInfo > & > | Called to stop editing curves in the curve editor | PersonaDelegates.h |
| FOnViewportCreated | TBaseDelegate_OneParam< void, const TSharedRef< class IPersonaViewport > & > | Called back when a viewport is created | PersonaModule.h |
| FPersonaViewportKeyDownDelegate | TBaseDelegate_TwoParams< FReply, const FGeometry &, const FKeyEvent & > | IPersonaViewport.h | |
| FRecord | TBaseDelegate_OneParam< void, USkeletalMeshComponent * > | PersonaModule.h | |
| FStopRecording | TBaseDelegate_OneParam< void, USkeletalMeshComponent * > | PersonaModule.h | |
| FTickRecording | TBaseDelegate_TwoParams< void, USkeletalMeshComponent *, float > | PersonaModule.h | |
| GetPrimitiveRef | TFunctionRef< TReturnType(const int32 BodyIndex, const EAggCollisionShape::Type PrimitiveType, const int32 PrimitiveIndex, const FPhysicsAssetRenderSettings &Settings) > | PhysicsAssetRenderUtils.h | |
| GetPrimitiveTransformRef | TFunctionRef< FTransform(const UPhysicsAsset *PhysicsAsset, const FTransform &BoneTM, const int32 BodyIndex, const EAggCollisionShape::Type PrimType, const int32 PrimIndex, const float Scale) > | PhysicsAssetRenderUtils.h | |
| IsSelectedFn | TFunction< bool(const uint32) > | PhysicsAssetRenderUtils.h | |
| SBoneMappingListType | SListView< TSharedPtr< FDisplayedBoneMappingInfo > > | SBoneMappingBase.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAnalysisEulerAxis | |
| EAnalysisLinearAxis | |
| EAnalysisSpace | |
| EAnimAssetFindReplaceMode | The mode configuration that the dialog can take |
| EAnimAssetFindReplaceType | DEPRECATED - use UAnimAssetFindReplaceProcessor. |
| EAnimationPlaybackSpeeds::Type | |
| EDisplayInfoMode::Type | |
| EEulerCalculationMethod | |
| ELocalAxesMode::Type | |
| EPreviewSceneDefaultAnimationMode | Modes that the preview scene defaults to (usually depending on asset editor context) |
| EViewportCorner | Places that viewport text can be placed |
| PersonaUtils::ECopyOptions | Options for CopyPropertiesToCDO |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PersonaAppName | const FName | PersonaModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BlendSpaceAnalysis::CalculateAngularVelocity
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
void BlendSpaceAnalysis::CalculateBoneOrientation
(
FVector& RollPitchYaw, |
BlendSpaceAnalysis.h | ||
void BlendSpaceAnalysis::CalculateBoneOrientation
(
FVector& RollPitchYaw, |
BlendSpaceAnalysis.h | ||
bool BlendSpaceAnalysis::CalculateDeltaOrientation
(
FVector& Result, |
Note that if a looping animation has 56 keys, then its first key is 0 and last is 55, but these will be identical poses. | BlendSpaceAnalysis.h | |
bool BlendSpaceAnalysis::CalculateDeltaPosition
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
void BlendSpaceAnalysis::CalculateFrameTM
(
bool& bNeedToUpdateFrameTM, |
BlendSpaceAnalysis.h | ||
bool BlendSpaceAnalysis::CalculateOrientation
(
FVector& Result, |
Note that if a looping animation has 56 keys, then its first key is 0 and last is 55, but these will be identical poses. | BlendSpaceAnalysis.h | |
bool BlendSpaceAnalysis::CalculateOrientationRate
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
bool BlendSpaceAnalysis::CalculatePosition
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
bool BlendSpaceAnalysis::CalculateVelocity
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
FVector BlendSpaceAnalysis::GetAxisFromTM
(
const FTransform& TM, |
BlendSpaceAnalysis.h | ||
bool BlendSpaceAnalysis::GetBoneInfo
(
const UAnimSequence& Animation, |
Retrieves the bone index and transform offset given the BoneSocketTarget. Returns true if found. | BlendSpaceAnalysis.h | |
FTransform BlendSpaceAnalysis::GetBoneTransform
(
const UAnimSequence& Animation, |
BlendSpaceAnalysis.h | ||
void BlendSpaceAnalysis::GetFrameDirs
(
FVector& FrameFacingDir, |
BlendSpaceAnalysis.h | ||
bool IsBodyKinematic
(
const UPhysicsAsset*const PhysicsAsset, |
PhysicsAssetRenderUtils.h | ||
void PhysicsAssetRender::DebugDrawBodies
(
USkeletalMeshComponent*const SkeletalMeshComponent, |
Debug draw Physics Asset bodies using the supplied custom callbacks | PhysicsAssetRenderUtils.h | |
void PhysicsAssetRender::DebugDrawConstraints
(
USkeletalMeshComponent*const SkeletalMeshComponent, |
Debug draw Physics Asset constraints using the supplied custom callbacks | PhysicsAssetRenderUtils.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool BlendSpaceAnalysis::CalculateAngularVelocity
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
double& Result, |
Helper to extract the component from the FVector functions | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
double& Result, |
Helper to extract the component from the FVector functions | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
float& Result, |
Helper to extract the component from the FVector functions as a float (pass through to double version) | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
float& Result, |
Helper to extract the component from the FVector functions as a float (pass through to double version) | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
double& Result, |
Helper to extract the component from the FVector functions | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateComponentSampleValue
(
float& Result, |
Helper to extract the component from the FVector functions as a float (pass through to double version) | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateDeltaOrientation
(
FVector& Result, |
Note that if a looping animation has 56 keys, then its first key is 0 and last is 55, but these will be identical poses. | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateDeltaPosition
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
static bool BlendSpaceAnalysis::CalculateOrientation
(
FVector& Result, |
Note that if a looping animation has 56 keys, then its first key is 0 and last is 55, but these will be identical poses. | BlendSpaceAnalysis.h | |
static bool BlendSpaceAnalysis::CalculateOrientationRate
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
static bool BlendSpaceAnalysis::CalculatePosition
(
FVector& Result, |
BlendSpaceAnalysis.h | ||
static bool BlendSpaceAnalysis::CalculateVelocity
(
FVector& Result, |
BlendSpaceAnalysis.h |