1. Epic GamesDeveloper
  3. IPersonaPreviewScene

IPersonaPreviewScene

API > API/Editor > API/Editor/Persona

Inheritance Hierarchy

References

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

Syntax

class IPersonaPreviewScene : public FAdvancedPreviewScene

Constructors

  Type Name Description
Public function  

IPersonaPreviewScene ( ConstructionValues CVS
)

 Constructor only here to pass ConstructionValues to base constructor

Functions

  Type Name Description
Public function Const bool Get whether or not to ignore mesh hit proxies
Public function 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
Public function bool

BroadcastMeshClick ( HActor* HitProxy,
const FViewportClick& Click
)

 Broadcasts that the preview mesh was clicked
Public function void Broadcasts that the preview mesh morph targets has changed
Public function void Broadcast select LOD changed
Public function void  
Public function void Clears the selected actor
Public function void Clears the selected bone on the preview component
Public function void Clears the selected socket on the preview component
Public function void Clears all selection on the preview component
Public function void

EnableWind ( bool bEnableWind
)

 Enable wind. Useful when simulating cloth.
Public function void Let the preview scene know that it should tick (because it is visible)
Public function void Request our views to focus on the current item
Public function void

ForEachPreviewMesh ( TFunction< void(UDebugSkelMeshComponent*)> PerMeshFunction
)

 Run a lambda function on each preview mesh in the scene
Public function Const AActor * Get the main actor
Public function Const TArray< UDebugSkelMeshComponent * > Get array of all skeletal mesh components in the preview scene.
Public function Const TSharedPtr< FEditorCameraController > Get the current camera override
Public function Const float Get the gravity scale
Public function Const TSharedRef< class IPersonaToolkit > Get the persona toolkit we are associated with
Public function Const UAnimationAsset * Get the animation asset we are previewing
Public function Const USkeletalMesh * Get the preview mesh for this scene (does go via skeleton/asset)
Public function Const UDebugSkelMeshComponent * Get the skeletal mesh component we are using for preview, if any.
Public function Const AActor * Get the currently selected actor
Public function Const int32 Get the currently selected bone index
Public function Const FSelectedSocketInfo Get the currently selected socket
Public function Const float Get the wind strength
Public function void

HandleSkeletonTreeSelectionChanged ( const TArrayView< TSharedPtr< ISkeletonTreeItem > >& InSelectedItems,
ESelectInfo::Type InSelectInfo
)

 Handle syncing selection with the skeleton tree
Public function void Flag that we want our views to be updated
Public function Const bool Are we currently displaying the ref pose
Public function Const bool Check whether wind is enabled
Public function void

RefreshAdditionalMeshes ( bool bAllowOverrideBaseMesh
)

 Refreshes the additional meshes displayed in this preview scene
Public function void Registers a delegate to be called after the preview animation has been changed
Public function void

RegisterOnCameraOverrideChanged ( const FSimpleDelegate& Delegate
)

 Register callback for when the camera override is changed
Public function FDelegateHandle

RegisterOnDeselectAll ( const FSimpleDelegate& Delegate
)

 Registers a delegate to be called when all sockets/bones are deselected
Public function void

RegisterOnFocusViews ( const FSimpleDelegate& Delegate
)

 Registers a delegate to be called when the view should be focused
Public function void

RegisterOnInvalidateViews ( const FSimpleDelegate& Delegate
)

 Registers a delegate to be called when the view is invalidated
Public function void

RegisterOnLODChanged ( const FSimpleDelegate& Delegate
)

 Registers a delegate to be called when the preview mesh's LOD has changed
Public function void

RegisterOnMeshClick ( const FOnMeshClick& Delegate
)

 Registers a delegate to be called when the preview mesh is clicked
Public function void

RegisterOnMorphTargetsChanged ( const FSimpleDelegate& Delegate
)

 Registers a delegate to be called when the preview mesh's morph targets has changed
Public function void

RegisterOnPostTick ( const FSimpleDelegate& Delegate
)

 Register a callback for just after the preview scene is ticked
Public function void

RegisterOnPreTick ( const FSimpleDelegate& Delegate
)

 Register a callback for just before the preview scene is ticked
Public function void Registers a delegate to be called when the preview mesh is changed
Public function FDelegateHandle Registers a delegate to be called when the currently selected bone has changed
Public function void Register callback to be able to be notify when the select LOD is change
Public function FDelegateHandle Registers a delegate to be called when the currently selected socket has changed
Public function void

RemoveAttachedObjectFromPreviewComponent ( UObject* Object,
FName AttachedTo
)

 Removes a currently attached object from the preview component
Public function void

SetActor ( AActor* InActor
)

 Set the main actor
Public function void

SetAdditionalMeshes ( UDataAsset* InAdditionalMeshes
)

 Set the additional meshes used by this preview scene (sets the additional meshes on the skeleton)
Public function void

SetAdditionalMeshesSelectable ( bool bSelectable
)

 Set whether additional meshes are selectable
Public function void

SetAllowMeshHitProxies ( bool bState
)

 Set whether or not to ignore mesh hit proxies
Public function void

SetCameraOverride ( TSharedPtr< FEditorCameraController > NewCamera
)

 Function to override the editor camera for this scene
Public function void Set the default mode this preview scene appears in. Optionally show the default mode.
Public function void

SetEditableSkeleton ( TSharedPtr< IEditableSkeleton > InEditableSkeleton
)

 Replaces the current editable skeleton.
Public function void

SetGravityScale ( float InGravityScale
)

 Set the gravity scale
Public function void

SetPreviewAnimationAsset ( UAnimationAsset* AnimAsset,
bool bEnablePreview
)

 Set the animation asset to preview
Public function void

SetPreviewAnimationBlueprint ( UAnimBlueprint* InAnimBlueprint,
UAnimBlueprint* InOverlayOrSubAnimBlueprint
)

 Set the preview animation blueprint and an optional overlay (for sub-layers)
Public function void

SetPreviewMesh ( USkeletalMesh* NewPreviewMesh,
bool bAllowOverrideBaseMesh
)

 Set the preview mesh for this scene (does not set the preview mesh on the skeleton/asset)
Public function void

SetPreviewMeshComponent ( UDebugSkelMeshComponent* InSkeletalMeshComponent
)

 Set the skeletal mesh component we are going to preview.
Public function void Setter/getter for can remove attach component
Public function void

SetSelectedActor ( AActor* InActor
)

 Sets the selected actor
Public function Virtual void

SetSelectedBone ( const FName& BoneName
)

 Sets the selected bone on the preview component
Public function void

SetSelectedBone ( const FName& BoneName,
ESelectInfo::Type InSelectInfo
)

 Sets the selected bone on the preview component
Public function void

SetSelectedSocket ( const FSelectedSocketInfo& SocketInfo
)

 Sets the selected socket on the preview component
Public function void

SetWindStrength ( float InWindStrength
)

 Set the wind strength
Public function void Show the mode specifed by SetDefaultAnimationMode()
Public function void

ShowReferencePose ( bool bShowRefPose,
bool bResetBoneTransforms
)

 Show the reference pose of the displayed skeletal mesh.
Public function void Toggle the playback of animation, if any
Public function void Unregister this scene from the Undo chain. Necessary for certain editor windows.
Public function void

UnregisterOnAnimChanged ( void* Thing
)

 Unregisters a delegate to be called after the preview animation has been changed
Public function void Unregister callback for when the camera override is changed
Public function void

UnregisterOnDeselectAll ( FDelegateHandle InHandle
)

 Unregisters a delegate called when all sockets/bones are deselected
Public function void

UnregisterOnFocusViews ( void* Thing
)

 Unregisters a delegate to be called when the view should be focused
Public function void

UnregisterOnInvalidateViews ( void* Thing
)

 Unregisters a delegate to be called when the view is invalidated
Public function void

UnregisterOnLODChanged ( void* Thing
)

 Unregisters a delegate to be called when the preview mesh's LOD has changed
Public function void

UnregisterOnMeshClick ( void* Thing
)

 Unregisters a delegate to be called when the preview mesh is clicked
Public function void Unregisters a delegate to be called when the preview mesh's morph targets has changed
Public function void

UnregisterOnPostTick ( void* Thing
)

 Unregister a callback for just after the preview scene is ticked
Public function void

UnregisterOnPreTick ( void* Thing
)

 Unregister a callback for just before the preview scene is ticked
Public function void Unregisters a delegate to be called when the preview mesh is changed
Public function void

UnregisterOnSelectedBoneChanged ( FDelegateHandle InHandle
)

 Unregisters a delegate called when the currently selected bone has changed
Public function void Unregister callback to free up the ressources
Public function void

UnregisterOnSelectedSocketChanged ( FDelegateHandle InHandle
)

 Unregisters a delegate called when the currently selected socket has changed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page