1. Epic GamesDeveloper
  3. IPersonaToolkit

IPersonaToolkit

Reusable 'Persona' features for asset editors concerned with USkeleton-related assets

API > API/Editor > API/Editor/Persona

References

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

Syntax

class IPersonaToolkit

Remarks

Reusable 'Persona' features for asset editors concerned with USkeleton-related assets

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const bool Returns true if the preview mesh can use skeletal meshes that don't share the same skeleton as the one being edited.
Public function Virtual void Callback to customize the Preview Scene Settings details tab.
Public function Const UAnimationAsset * Get the animation asset that we are editing
Public function Const UAnimBlueprint * Get the anim blueprint that we are editing
Public function Const FName Get the context in which this toolkit is being used (usually the class name of the asset)
Public function Virtual Const int32

GetCustomData ( const int32 Key
)

 Retrieve editor custom data. Return INDEX_NONE if the key is invalid
Public function Const TSharedPtr< IEditableSkeleton > Get the editable skeleton that we are editing
Public function Const USkeletalMesh *

GetMesh ()

 Get the skeletal mesh that we are editing
Public function Const UAnimBlueprint * Get the preview anim blueprint, used to preview sub layers in context.
Public function Const USkeletalMesh * Get the preview mesh, according to context (mesh, skeleton or animation etc.).
Public function Const UDebugSkelMeshComponent * Get the preview component that we are using
Public function Const TSharedRef< IPersonaPreviewScene > Get the preview scene that we are using
Public function Const USkeleton * Get the skeleton that we are editing
Public function void

SetAnimationAsset ( UAnimationAsset* InAnimationAsset
)

 Set the animation asset we are editing
Public function Virtual void

SetCustomData ( const int32 Key,
const int32 CustomData
)

 Store the custom data using the key.
Public function void

SetMesh ( USkeletalMesh* InSkeletalMesh
)

 Set the skeletal mesh we are editing
Public function void Set the preview anim blueprint, used to preview sub layers in context.
Public function void

SetPreviewMesh ( USkeletalMesh* InSkeletalMesh,
bool bSetPreviewMeshInAsset
)

 Set the preview mesh, according to context (mesh, skeleton or animation etc.) Note that this sets the mesh in the asset and in the viewport (and may re-open the asset editor to apply this).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page