FUMGViewportClient

Windows
MacOS
Linux

Inheritance Hierarchy

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

Protected variable

FLinearColor

 

BackgroundColor

Protected variable

FEngineShowFlag...

 

EngineShowFlags

A set of flags that determines visibility for various scene elements.

Protected variable

FPreviewScene &...

 

PreviewScene

The scene used for the viewport. Owned externally

Protected variable

FMinimalViewInf...

 

ViewInfo

Protected variable

FViewport *

 

Viewport

Protected variable

FSceneViewState...

 

ViewState

The viewport's scene view state.

Protected variable

FUMGViewportCam...

 

ViewTransform

Viewport camera transform data

Constructors

Name Description

Public function

FUMGViewportClient

(
    FPreviewScene* InPreviewScene
)

Destructors

Name Description

Public function Virtual

~FUMGViewportClient()

Functions

Name Description

Public function Virtual

FSceneView &...

 

CalcSceneView

(
    FSceneViewFamily* ViewFamily
)

Public function Const

FLinearColor

 

GetBackgroundColor()

Public function Const

const FVecto...

 

GetLookAtLocation()

Public function Const

float

 

GetOrthoUnitsPerPixel

(
    const FViewport* Viewport
)

Public function Const

float

 

GetOrthoZoom()

Public function Virtual Const

FSceneInterf...

 

GetScene()

Public function Const

const FVecto...

 

GetViewLocation()

Public function Const

const FRotat...

 

GetViewRotation()

Public function Const

bool

 

IsAspectRatioConstrained()

Public function

void

 

SetBackgroundColor

(
    FLinearColor InBackgroundColor
)

Public function

void

 

SetEngineShowFlags

(
    FEngineShowFlags InEngineShowFlags
)

Public function

void

 

SetLookAtLocation

(
    const FVector& LookAt,
    bool bRecalculateView
)

Sets the look at location of the viewports camera for orbit *

Public function

void

 

SetOrthoZoom

(
    float InOrthoZoom
)

Sets ortho zoom amount

Public function

void

 

SetViewLocation

(
    const FVector& NewLocation
)

Sets the location of the viewport's camera

Public function

void

 

SetViewRotation

(
    const FRotator& NewRotation
)

Sets the location of the viewport's camera

Public function Virtual

void

 

Tick

(
    float InDeltaTime
)

Overridden from FViewportClient

Name Description

Public function Virtual

void

 

Draw

(
    FViewport* InViewport,
    FCanvas* Canvas
)

Public function Virtual Const

UWorld *

 

GetWorld()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback