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 > IPersonaPreviewScene

Light Theme

Dark Theme

IPersonaPreviewScene

Inheritance Hierarchy

FPreviewScene

FTickableEditorObject

FAdvancedPreviewScene

References

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

Syntax

class IPersonaPreviewScene : public FAdvancedPreviewScene

Constructors

	Name	Description
	IPersonaPreviewScene ( ConstructionValues CVS )	Constructor only here to pass ConstructionValues to base constructor

Functions

	Name	Description
bool	AllowMeshHitProxies()	Get whether or not to ignore mesh hit proxies
bool	AttachObjectToPreviewComponent ( UObject* Object, FName AttachTo )	Attaches an object to the preview component using the supplied attach name, returning whether it was successfully attached or not
bool	BroadcastMeshClick ( HActor* HitProxy, const FViewportClick& Click )	Broadcasts that the preview mesh was clicked
void	BroadcastOnMorphTargetsChanged()	Broadcasts that the preview mesh morph targets has changed
void	BroadcastOnSelectedLODChanged()	Broadcast select LOD changed
void	ClearRemoveAttachedComponentFilter()
void	ClearSelectedActor()	Clears the selected actor
void	ClearSelectedBone()	Clears the selected bone on the preview component
void	ClearSelectedSocket()	Clears the selected socket on the preview component
void	DeselectAll()	Clears all selection on the preview component
void	EnableWind ( bool bEnableWind )	Enable wind. Useful when simulating cloth.
void	FlagTickable()	Let the preview scene know that it should tick (because it is visible)
void	FocusViews()	Request our views to focus on the current item
void	ForEachPreviewMesh ( TFunction< void(UDebugSkelMeshCompo... )	Run a lambda function on each preview mesh in the scene
AActor *	GetActor()	Get the main actor
TArray< UDeb...	GetAllPreviewMeshComponents()	Get array of all skeletal mesh components in the preview scene.
TSharedPtr< ...	GetCurrentCameraOverride()	Get the current camera override
float	GetGravityScale()	Get the gravity scale
TSharedRef< ...	GetPersonaToolkit()	Get the persona toolkit we are associated with
UAnimationAs...	GetPreviewAnimationAsset()	Get the animation asset we are previewing
USkeletalMes...	GetPreviewMesh()	Get the preview mesh for this scene (does go via skeleton/asset)
UDebugSkelMe...	GetPreviewMeshComponent()	Get the skeletal mesh component we are using for preview, if any.
AActor *	GetSelectedActor()	Get the currently selected actor
int32	GetSelectedBoneIndex()	Get the currently selected bone index
FSelectedSoc...	GetSelectedSocket()	Get the currently selected socket
float	GetWindStrength()	Get the wind strength
void	HandleSkeletonTreeSelectionChanged ( const TArrayView< TSharedPtr< ISkel..., ESelectInfo::Type InSelectInfo )	Handle syncing selection with the skeleton tree
void	InvalidateViews()	Flag that we want our views to be updated
bool	IsShowReferencePoseEnabled()	Are we currently displaying the ref pose
bool	IsWindEnabled()	Check whether wind is enabled
void	RefreshAdditionalMeshes ( bool bAllowOverrideBaseMesh )	Refreshes the additional meshes displayed in this preview scene
void	RegisterOnAnimChanged ( const FOnAnimChanged& Delegate )	Registers a delegate to be called after the preview animation has been changed
void	RegisterOnCameraOverrideChanged ( const FSimpleDelegate& Delegate )	Register callback for when the camera override is changed
FDelegateHan...	RegisterOnDeselectAll ( const FSimpleDelegate& Delegate )	Registers a delegate to be called when all sockets/bones are deselected
void	RegisterOnFocusViews ( const FSimpleDelegate& Delegate )	Registers a delegate to be called when the view should be focused
void	RegisterOnInvalidateViews ( const FSimpleDelegate& Delegate )	Registers a delegate to be called when the view is invalidated
void	RegisterOnLODChanged ( const FSimpleDelegate& Delegate )	Registers a delegate to be called when the preview mesh's LOD has changed
void	RegisterOnMeshClick ( const FOnMeshClick& Delegate )	Registers a delegate to be called when the preview mesh is clicked
void	RegisterOnMorphTargetsChanged ( const FSimpleDelegate& Delegate )	Registers a delegate to be called when the preview mesh's morph targets has changed
void	RegisterOnPostTick ( const FSimpleDelegate& Delegate )	Register a callback for just after the preview scene is ticked
void	RegisterOnPreTick ( const FSimpleDelegate& Delegate )	Register a callback for just before the preview scene is ticked
void	RegisterOnPreviewMeshChanged ( const FOnPreviewMeshChanged& Deleg... )	Registers a delegate to be called when the preview mesh is changed
FDelegateHan...	RegisterOnSelectedBoneChanged ( const FOnSelectedBoneChanged& Dele... )	Registers a delegate to be called when the currently selected bone has changed
void	RegisterOnSelectedLODChanged ( const FOnSelectedLODChanged& Deleg... )	Register callback to be able to be notify when the select LOD is change
FDelegateHan...	RegisterOnSelectedSocketChanged ( const FOnSelectedSocketChanged& De... )	Registers a delegate to be called when the currently selected socket has changed
void	RemoveAttachedObjectFromPreviewComponent ( UObject* Object, FName AttachedTo )	Removes a currently attached object from the preview component
void	SetActor ( AActor* InActor )	Set the main actor
void	SetAdditionalMeshes ( UDataAsset* InAdditionalMeshes )	Set the additional meshes used by this preview scene (sets the additional meshes on the skeleton)
void	SetAdditionalMeshesSelectable ( bool bSelectable )	Set whether additional meshes are selectable
void	SetAllowMeshHitProxies ( bool bState )	Set whether or not to ignore mesh hit proxies
void	SetCameraOverride ( TSharedPtr< FEditorCameraController... )	Function to override the editor camera for this scene
void	SetDefaultAnimationMode ( EPreviewSceneDefaultAnimationMode M..., bool bShowNow )	Set the default mode this preview scene appears in. Optionally show the default mode.
void	SetEditableSkeleton ( TSharedPtr< IEditableSkeleton > InE... )	Replaces the current editable skeleton.
void	SetGravityScale ( float InGravityScale )	Set the gravity scale
void	SetPreviewAnimationAsset ( UAnimationAsset* AnimAsset, bool bEnablePreview )	Set the animation asset to preview
void	SetPreviewAnimationBlueprint ( UAnimBlueprint* InAnimBlueprin..., UAnimBlueprint* InOverlayOrSub... )	Set the preview animation blueprint and an optional overlay (for sub-layers)
void	SetPreviewMesh ( USkeletalMesh* NewPreviewMesh, bool bAllowOverrideBaseMesh )	Set the preview mesh for this scene (does not set the preview mesh on the skeleton/asset)
void	SetPreviewMeshComponent ( UDebugSkelMeshComponent* InSke... )	Set the skeletal mesh component we are going to preview.
void	SetRemoveAttachedComponentFilter ( const FOnRemoveAttachedComponentFil... )	Setter/getter for can remove attach component
void	SetSelectedActor ( AActor* InActor )	Sets the selected actor
void	SetSelectedBone ( const FName& BoneName, ESelectInfo::Type InSelectInfo )	Sets the selected bone on the preview component
void	SetSelectedSocket ( const FSelectedSocketInfo& SocketI... )	Sets the selected socket on the preview component
void	SetWindStrength ( float InWindStrength )	Set the wind strength
void	ShowDefaultMode()	Show the mode specifed by SetDefaultAnimationMode()
void	ShowReferencePose ( bool bShowRefPose, bool bResetBoneTransforms )	Show the reference pose of the displayed skeletal mesh.
void	TogglePlayback()	Toggle the playback of animation, if any
void	UnregisterOnAnimChanged ( void* Thing )	Unregisters a delegate to be called after the preview animation has been changed
void	UnregisterOnCameraOverrideChanged ( void* Thing )	Unregister callback for when the camera override is changed
void	UnregisterOnDeselectAll ( FDelegateHandle InHandle )	Unregisters a delegate called when all sockets/bones are deselected
void	UnregisterOnFocusViews ( void* Thing )	Unregisters a delegate to be called when the view should be focused
void	UnregisterOnInvalidateViews ( void* Thing )	Unregisters a delegate to be called when the view is invalidated
void	UnregisterOnLODChanged ( void* Thing )	Unregisters a delegate to be called when the preview mesh's LOD has changed
void	UnregisterOnMeshClick ( void* Thing )	Unregisters a delegate to be called when the preview mesh is clicked
void	UnregisterOnMorphTargetsChanged ( void* Thing )	Unregisters a delegate to be called when the preview mesh's morph targets has changed
void	UnregisterOnPostTick ( void* Thing )	Unregister a callback for just after the preview scene is ticked
void	UnregisterOnPreTick ( void* Thing )	Unregister a callback for just before the preview scene is ticked
void	UnregisterOnPreviewMeshChanged ( void* Thing )	Unregisters a delegate to be called when the preview mesh is changed
void	UnregisterOnSelectedBoneChanged ( FDelegateHandle InHandle )	Unregisters a delegate called when the currently selected bone has changed
void	UnRegisterOnSelectedLODChanged ( void* Thing )	Unregister callback to free up the ressources
void	UnregisterOnSelectedSocketChanged ( FDelegateHandle InHandle )	Unregisters a delegate called when the currently selected socket has changed

Deprecated Functions

		Name	Description
	void	SetSelectedBone ( const FName& BoneName )	Please call/implement SetSelectedBone with ESelectInfo

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

Take our survey

Cancel