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

Light Theme

Dark Theme

FUMGViewportClient

Windows

MacOS

Linux

Inheritance Hierarchy

FCommonViewportClient

FViewElementDrawer

FUMGViewportClient

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/Viewport.h
Include	#include "Components/Viewport.h"

Syntax

class FUMGViewportClient :
public FCommonViewportClient,
public FViewElementDrawer

Variables

	Name	Description
FLinearColor	BackgroundColor
FEngineShowFlag...	EngineShowFlags	A set of flags that determines visibility for various scene elements.
FPreviewScene &...	PreviewScene	The scene used for the viewport. Owned externally
FMinimalViewInf...	ViewInfo
FViewport *	Viewport
FSceneViewState...	ViewState	The viewport's scene view state.
FUMGViewportCam...	ViewTransform	Viewport camera transform data

Constructors

	Name	Description
	FUMGViewportClient ( FPreviewScene* InPreviewScene )

Destructors

	Name	Description
	~FUMGViewportClient()

Functions

	Name	Description
FSceneView &...	CalcSceneView ( FSceneViewFamily* ViewFamily )
FLinearColor	GetBackgroundColor()
const FVecto...	GetLookAtLocation()
float	GetOrthoUnitsPerPixel ( const FViewport* Viewport )
float	GetOrthoZoom()
FSceneInterf...	GetScene()
const FVecto...	GetViewLocation()
const FRotat...	GetViewRotation()
bool	IsAspectRatioConstrained()
void	SetBackgroundColor ( FLinearColor InBackgroundColor )
void	SetEngineShowFlags ( FEngineShowFlags InEngineShowFlags )
void	SetLookAtLocation ( const FVector& LookAt, bool bRecalculateView )	Sets the look at location of the viewports camera for orbit *
void	SetOrthoZoom ( float InOrthoZoom )	Sets ortho zoom amount
void	SetViewLocation ( const FVector& NewLocation )	Sets the location of the viewport's camera
void	SetViewRotation ( const FRotator& NewRotation )	Sets the location of the viewport's camera
void	Tick ( float InDeltaTime )

Overridden from FViewportClient

		Name	Description
	void	Draw ( FViewport* InViewport, FCanvas* Canvas )
	UWorld *	GetWorld()

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

Take our survey

Dismiss