Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Persona > IPersonaToolkit

Light Theme

Dark Theme

IPersonaToolkit

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

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

	Name	Description
	~IPersonaToolkit()	Virtual destructor

Functions

	Name	Description
bool	CanPreviewMeshUseDifferentSkeleton()	Returns true if the preview mesh can use skeletal meshes that don't share the same skeleton as the one being edited.
void	CustomizeSceneSettings ( IDetailLayoutBuilder& DetailBuilde... )	Callback to customize the Preview Scene Settings details tab.
UAnimationAs...	GetAnimationAsset()	Get the animation asset that we are editing
UAnimBluepri...	GetAnimBlueprint()	Get the anim blueprint that we are editing
FName	GetContext()	Get the context in which this toolkit is being used (usually the class name of the asset)
int32	GetCustomData ( const int32 Key )	Retrieve editor custom data. Return INDEX_NONE if the key is invalid
TSharedPtr< ...	GetEditableSkeleton()	Get the editable skeleton that we are editing
USkeletalMes...	GetMesh()	Get the skeletal mesh that we are editing
UAnimBluepri...	GetPreviewAnimationBlueprint()	Get the preview anim blueprint, used to preview sub layers in context.
USkeletalMes...	GetPreviewMesh()	Get the preview mesh, according to context (mesh, skeleton or animation etc.).
UDebugSkelMe...	GetPreviewMeshComponent()	Get the preview component that we are using
TSharedRef< ...	GetPreviewScene()	Get the preview scene that we are using
USkeleton &#...	GetSkeleton()	Get the skeleton that we are editing
void	SetAnimationAsset ( UAnimationAsset* InAnimationAs... )	Set the animation asset we are editing
void	SetCustomData ( const int32 Key, const int32 CustomData )	Store the custom data using the key.
void	SetMesh ( USkeletalMesh* InSkeletalMesh )	Set the skeletal mesh we are editing
void	SetPreviewAnimationBlueprint ( UAnimBlueprint* InAnimBlueprin... )	Set the preview anim blueprint, used to preview sub layers in context.
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).

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel