FViewportClient | Unreal Engine 5.8 Documentation

Simple Viewport Client that can be used in the editor mode to get the preview scene and the editor toolkit


Name	FViewportClient
Type	class
Header File	/Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabaseEditor/Public/AnimDatabaseEditorViewportClient.h
Include Path	#include "AnimDatabaseEditorViewportClient.h"

Syntax

class FViewportClient : public FEditorViewportClient

Name	Remarks	Include Path	Unreal Specifiers
FViewportClient ( const TWeakPtr< FPreviewScene > InPreviewScene, const TSharedRef< SEditorViewport >& InViewport, const TWeakPtr< FAssetEditorToolkit > InAssetEditorToolkit, const FEditorModeID ModeID )		AnimDatabaseEditorViewportClient.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FViewportClient()		AnimDatabaseEditorViewportClient.h

Name	Type	Remarks	Include Path
AssetEditorToolkitPtr	TWeakPtr< FAssetEditorToolkit >	Asset editor toolkit we are embedded in	AnimDatabaseEditorViewportClient.h
DebugDrawBuffer	TSharedPtr< FDebugDrawerCanvasBuffer >	Buffer for debug draw commands	AnimDatabaseEditorViewportClient.h
PreviewScenePtr	TWeakPtr< FPreviewScene >	Preview scene we are viewing	AnimDatabaseEditorViewportClient.h
WarningMessage	FText	Optional warning message to display in viewport	AnimDatabaseEditorViewportClient.h

Name	Remarks	Include Path
void ClearWarningMessage()	Clears the current warning message	AnimDatabaseEditorViewportClient.h
TWeakPtr< FAssetEditorToolkit > GetAssetEditorToolkit()	Gets the Asset Editor Toolkit we are using	AnimDatabaseEditorViewportClient.h
const TSharedPtr< FDebugDrawerCanvasBuffer > & GetOrMakeDebugDrawBuffer()	Gets or makes a new DebugDrawCanvasBuffer for this viewport and returns a shared pointer to it	AnimDatabaseEditorViewportClient.h
TWeakPtr< FPreviewScene > GetPreviewScene()	Get the preview scene we are viewing	AnimDatabaseEditorViewportClient.h
void SetWarningMessage ( const FText& InWarningMessage )	Sets the current warning message	AnimDatabaseEditorViewportClient.h

Name	Remarks	Include Path
virtual void Draw ( FViewport* Viewport, FCanvas* Canvas )	Custom Draw Function	AnimDatabaseEditorViewportClient.h
virtual void TrackingStarted ( const FInputEventState& InInputState, bool bIsDragging, bool bNudge )		AnimDatabaseEditorViewportClient.h
virtual void TrackingStopped()		AnimDatabaseEditorViewportClient.h