1. Epic GamesDeveloper
  3. FAnimationViewportClient

FAnimationViewportClient

API > API/Editor > API/Editor/Persona

Inheritance Hierarchy

References

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

Syntax

class FAnimationViewportClient :  
    public FEditorViewportClient,  
    public TSharedFromThis< FAnimationViewportClient >

Variables

  Type Name Description
Public variable UPersonaOptions * ConfigOption Persona config options
Public variable FOnGetBoneSize OnGetBoneSize  
Public variable FOnBoneSizeSet OnSetBoneSize Allow client code to store/serialize bone size if desired

Constructors

  Type Name Description
Public function  

FAnimationViewportClient ( const TSharedRef< class IPersonaPreviewScene >& InPreviewScene,
const TSharedRef< class SAnimationEditorViewport >& InAnimationEditorViewport,
const TSharedRef< class FAssetEditorToolkit >& InAssetEditorToolkit,
int32 InViewportIndex,
bool bInShowStats
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool Check whether we can save this camera as default
Public function void Clear any default camera for mesh
Protected function void

DrawNodeDebugLines ( TArray< FText >& Lines,
FCanvas* Canvas,
FSceneView* View
)

 Function to display debug lines generated from skeletal controls in animBP mode
Public function Static void

DrawSockets ( const UDebugSkelMeshComponent* InPreviewMeshComponent,
TArray< USkeletalMeshSocket* >& InSockets,
FSelectedSocketInfo InSelectedSocket,
FPrimitiveDrawInterface* PDI,
bool bUseSkeletonSocketColor
)

 Draws Mesh Sockets in foreground - bUseSkeletonSocketColor = true for grey (skeleton), false for red (mesh)
Public function void

DrawUVsForMesh ( FViewport* InViewport,
FCanvas* InCanvas,
int32 InTextYPos,
UDebugSkelMeshComponent* MeshComponent
)

 Draw call to render UV overlay
Public function void

FocusViewportOnPreviewMesh ( bool bUseCustomCamera
)

 Places the viewport camera at a good location to view the preview target
Public function void

FocusViewportOnSphere ( FSphere& Sphere,
bool bInstant
)

 Places the viewport camera at a good location to view the supplied sphere
Public function Const TSharedRef< class FAssetEditorToolkit > Get the asset editor we are embedded in
Public function Const EBoneDrawMode::Type Get the Bone local axis mode
Public function Const float  
Public function Const float Function to get current brightness value
Public function Const FName Get the bone name to use when CameraFollowMode is EAnimationViewportCameraFollowMode::Bone
Public function Const EAnimationViewportCameraFollowMode Get the camera follow mode
Public function FSphere Returns the desired target of the camera
Public function Const float  
Public function Const FText

GetDisplayInfo ( bool bDisplayAllInfo
)

 Function to display warning and info text on the viewport when outside of animBP mode
Public function Const float Returns the floor height offset
Public function Const ELocalAxesMode::Type Get the Bone local axis mode
Public function Const EAnimationPlaybackSpeeds::Type Get the playback speed mode
Public function Const TSharedRef< class IPersonaPreviewScene > Get the preview scene we are viewing
Public function Const bool Whether or not to lock the camera's rotation to a specified bone's orientation
Public function Const int32  
Public function Const int32 Returns the UV Channel that will be drawn when Draw UV Overlay is turned on
Public function Const int32 Get the viewport index (0-3) for this client
Public function void Handle a change in the skeletal mesh mesh component being used for preview changing
Public function void Handle a change in the skeletal mesh phusics component being used for preview changing
Public function void

HandleSkeletalMeshChanged ( USkeletalMesh* OldSkeletalMesh,
USkeletalMesh* NewSkeletalMesh
)

 Handle the skeletal mesh mesh component being used for preview changing
Public function Const bool Returns whether we have a default camera set for this mesh
Public function void  
Public function Const bool Function to check whether audio is muted or not
Public function Const bool Function to check whether floor is auto align or not
Public function Const bool Bone Draw mode checking function for the EBoneDrawType
Public function Const bool Whether detailed mesh stats are being displayed or basic mesh stats
Public function Const bool Local axes mode checking function for the ELocalAxesType
Public function Const bool Callback for checking the normals show flag.
Public function Const bool Callback for checking whether the UV drawing is switched on.
Public function Const bool Callback for checking the binormals show flag.
Public function Const bool Callback for checking the normals show flag.
Public function Const bool Callback for checking the tangents show flag.
Public function Const bool Whether or not mesh stats are being displayed
Public function Const bool Whether or not selected node stats are being displayed
Public function Const bool Check whether we are using audio attenuation
Public function void Jump to the meshes default camera
Public function void Called when viewport focuses on a selection
Public function void

OnSetShowMeshStats ( int32 ShowMode
)

 Function to set mesh stat drawing state
Public function void Function to enable/disable floor auto align
Public function void Function to mute/unmute audio in the viewport
Public function void Set whether to use audio attenuation
Public function Static void

RenderGizmo ( const FTransform& Transform,
FPrimitiveDrawInterface* PDI
)

 Draws Gizmo for the Transform in foreground
Public function void Save current camera as default for mesh
Public function void Function to set background color
Public function void Function to set Bone Draw mode for the EBoneDrawType
Public function void

SetBoneDrawSize ( const float InBoneDrawSize
)

 Access Bone Draw size config option
Public function void

SetBrightnessValue ( float Value
)

 Function to set brightness value
Public function void

SetCameraFollowMode ( EAnimationViewportCameraFollowMode Mode,
FName InBoneName
)

 Set the camera follow mode
Public function void

SetCustomAnimationSpeed ( const float InCustomAnimationSpeed
)

 Access CustomAnimationSpeed config option
Public function void

SetDrawUVOverlay ( bool bInDrawUVs
)

 Callback for toggling UV drawing in the viewport
Public function void

SetFloorOffset ( float NewValue
)

 Sets the floor height offset, saves it to config and invalidates the viewport so it shows up immediately
Public function void Function to set Local axes mode for the ELocalAxesType
Public function void Set the playback speed mode
Public function void

SetUVChannelToDraw ( int32 UVChannel
)

 Sets the UV Channel that will be drawn when Draw UV Overlay is turned on
Public function Const bool Handle error checking for additive base pose
Protected function Const void

ShowAttributeNames ( FCanvas* Canvas,
FSceneView* View,
UDebugSkelMeshComponent* MeshComponent
)

 Function to display transform attribute names
Protected function void

ShowBoneNames ( FCanvas* Canvas,
FSceneView* View,
UDebugSkelMeshComponent* MeshComponent
)

 Function to display bone names
Public function void

ShowBoneNames ( FViewport* Viewport,
FCanvas* Canvas,
UDebugSkelMeshComponent* MeshComponent
)

 Function to display bone names
Public function void Callback for toggling the normals show flag.
Public function void Toggles whether to lock the camera's rotation to a specified bone's orientation
Public function void Callback for toggling the binormals show flag.
Public function void Callback for toggling the normals show flag.
Public function void Callback for toggling the tangents show flag.
Public function void Sets up the viewports camera (look-at etc) based on the current preview target

Overridden from FEditorViewportClient

  Type Name Description
Public function Virtual Const FMatrix

CalcViewRotationMatrix ( const FRotator& InViewRotation
)

 Computes a matrix to use for viewport location and rotation
Public function Virtual Const bool Whether or not the widget mode can be cycled
Public function Virtual void

DrawCanvas ( FViewport& InViewport,
FSceneView& View,
FCanvas& Canvas
)

 Called to draw onto the viewports 2D canvas
Public function Virtual Const FMatrix  
Public function Virtual Const ECoordSystem  
Public function Virtual Const FVector Virtual UE::Widget::EWidgetModeGetWidgetMode() const override; virtual void SetWidgetMode(UE::Widget::EWidgetMode InWidgetMode) override; virtual bool CanSetWidgetMode(UE::Widget::EWidgetMode NewMode) const override;
Public function Virtual void Delegate handler fired when a show flag is toggled
Public function Virtual void Rotate through viewport view options
Public function Virtual void Called to do any additional set up of the view for rendering
Public function Virtual void

SetViewMode ( EViewModeIndex InViewModeIndex
)

 Sets how the viewport is displayed (lit, wireframe, etc) for the current viewport type
Public function Virtual void

SetViewportType ( ELevelViewportType InViewportType
)

 Set the viewport type of the client
Public function Virtual void

SetWidgetCoordSystemSpace ( ECoordSystem NewCoordSystem
)

 Sets the coordinate system space to use
Public function Virtual void

Tick ( float DeltaSeconds
)

 Ticks this viewport client
Public function Virtual void

TrackingStarted ( const FInputEventState& InInputState,
bool bIsDragging,
bool bNudge
)

 Virtual void ProcessClick(class FSceneView& View, class HHitProxy HitProxy, FKey Key, EInputEvent Event, uint32 HitX, uint32 HitY)](API\Editor\UnrealEd\FEditorViewportClient\ProcessClick) override; virtual bool [InputWidgetDelta( FViewport Viewport, EAxisList::Type CurrentAxis, FVector& Drag, FRotator& Rot, FVector& Scale ) override;
Public function Virtual void Called when mouse movement tracking stops

Overridden from FViewportClient

  Type Name Description
Public function Virtual bool

InputAxis ( FViewport* Viewport,
FInputDeviceId InputDevice,
FKey Key,
float Delta,
float DeltaTime,
int32 NumSamples,
bool bGamepad
)

 Check an axis movement received by the viewport.
Public function Virtual bool

InputKey ( const FInputKeyEventArgs& EventArgs
)

 Check a key event received by the viewport.

Overridden from FViewElementDrawer

  Type Name Description
Public function Virtual void

Draw ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 FViewElementDrawer interface

Enums

  Type Name Description
Private enum GridParam    

Deprecated Functions

  Type Name Description
Public function Const IPersonaEditorModeManager * Use the UPersonaEditorModeManagerContext object stored in the editor mode tools' context store instead.
Public function Virtual bool

InputAxis ( FViewport* InViewport,
int32 ControllerId,
FKey Key,
float Delta,
float DeltaTime,
int32 NumSamples,
bool bGamepad
)

 This version of InputAxis is deprecated. Please use the version that takes DeviceId instead.
Public function Virtual bool

InputKey ( FViewport* Viewport,
int32 ControllerId,
FKey Key,
EInputEvent Event,
float AmountDepressed,
bool bGamepad
)

 This version of InputKey is deprecated. Please use the version that takes EventArgs instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page