FUMGViewportClient Class Reference

#include <Viewport.h>

Inheritance diagram for FUMGViewportClient:

Public Member Functions
UMG_API	FUMGViewportClient (FPreviewScene *InPreviewScene=nullptr)
virtual UMG_API	~FUMGViewportClient ()
virtual UMG_API UWorld *	GetWorld () const override
virtual UMG_API void	Draw (FViewport *InViewport, FCanvas *Canvas) override
virtual UMG_API void	Tick (float InDeltaTime)
virtual UMG_API FSceneView *	CalcSceneView (FSceneViewFamily *ViewFamily)
virtual UMG_API FSceneInterface *	GetScene () const
UMG_API bool	IsAspectRatioConstrained () const
UMG_API void	SetBackgroundColor (FLinearColor InBackgroundColor)
UMG_API FLinearColor	GetBackgroundColor () const
void	SetViewLocation (const FVector &NewLocation)
void	SetViewRotation (const FRotator &NewRotation)
void	SetLookAtLocation (const FVector &LookAt, bool bRecalculateView=false)
void	SetOrthoZoom (float InOrthoZoom)
const FVector &	GetViewLocation () const
const FRotator &	GetViewRotation () const
const FVector &	GetLookAtLocation () const
float	GetOrthoZoom () const
UMG_API float	GetOrthoUnitsPerPixel (const FViewport *Viewport) const
void	SetEngineShowFlags (FEngineShowFlags InEngineShowFlags)
FMatrix	GetViewProjectionMatrix () const
virtual void	Draw (const FSceneView *View, FPrimitiveDrawInterface *PDI)
Public Member Functions inherited from FCommonViewportClient
	FCommonViewportClient ()
virtual ENGINE_API	~FCommonViewportClient () override
ENGINE_API void	RequestUpdateDPIScale ()
ENGINE_API float	GetDPIDerivedResolutionFraction () const
virtual ENGINE_API float	GetDPIScale () const override
ENGINE_API void	DrawHighResScreenshotCaptureRegion (FCanvas &Canvas)
Public Member Functions inherited from FViewportClient
virtual	~FViewportClient ()
virtual void	Precache ()
virtual ENGINE_API void	RedrawRequested (FViewport *Viewport)
virtual ENGINE_API void	RequestInvalidateHitProxy (FViewport *Viewport)
virtual bool	ProcessScreenShots (FViewport *Viewport)
virtual struct FEngineShowFlags *	GetEngineShowFlags ()
virtual bool	InputKey (const FInputKeyEventArgs &EventArgs)
virtual ENGINE_API bool	InputAxis (FViewport *Viewport, FInputDeviceId InputDevice, FKey Key, float Delta, float DeltaTime, int32 NumSamples=1, bool bGamepad=false) final
virtual bool	InputAxis (const FInputKeyEventArgs &Args)
virtual bool	InputChar (FViewport *Viewport, int32 ControllerId, TCHAR Character)
virtual ENGINE_API bool	InputTouch (FViewport *Viewport, int32 ControllerId, uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex) final
virtual bool	InputTouch (FViewport *Viewport, const FInputDeviceId DeviceId, uint32 Handle, ETouchType::Type Type, const FVector2D &TouchLocation, float Force, uint32 TouchpadIndex, const uint64 Timestamp)
virtual ENGINE_API bool	InputGesture (FViewport *Viewport, EGestureEvent GestureType, const FVector2D &GestureDelta, bool bIsDirectionInvertedFromDevice) final
virtual bool	InputGesture (FViewport *Viewport, const FInputDeviceId DeviceId, EGestureEvent GestureType, const FVector2D &GestureDelta, bool bIsDirectionInvertedFromDevice, const uint64 Timestamp)
virtual ENGINE_API bool	InputMotion (FViewport *Viewport, int32 ControllerId, const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration) final
virtual bool	InputMotion (FViewport *Viewport, const FInputDeviceId DeviceId, const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration, const uint64 Timestamp)
virtual void	SetIsSimulateInEditorViewport (bool bInIsSimulateInEditorViewport)
virtual bool	WantsPollingMouseMovement (void) const
virtual void	MouseEnter (FViewport *Viewport, int32 x, int32 y)
virtual void	MouseLeave (FViewport *Viewport)
virtual void	MouseMove (FViewport *Viewport, int32 X, int32 Y)
virtual void	CapturedMouseMove (FViewport *InViewport, int32 InMouseX, int32 InMouseY)
virtual void	ProcessAccumulatedPointerInput (FViewport *InViewport)
virtual EMouseCursor::Type	GetCursor (FViewport *Viewport, int32 X, int32 Y)
virtual ENGINE_API TOptional< TSharedRef< SWidget > >	MapCursor (FViewport *Viewport, const FCursorReply &CursorReply)
virtual TOptional< bool >	QueryShowFocus (const EFocusCause InFocusCause) const
virtual void	LostFocus (FViewport *Viewport)
virtual void	ReceivedFocus (FViewport *Viewport)
virtual bool	IsFocused (FViewport *Viewport)
virtual void	Activated (FViewport *Viewport, const FWindowActivateEvent &InActivateEvent)
virtual void	Deactivated (FViewport *Viewport, const FWindowActivateEvent &InActivateEvent)
virtual bool	IsInPermanentCapture ()
virtual bool	WindowCloseRequested ()
virtual void	CloseRequested (FViewport *Viewport)
virtual bool	RequiresHitProxyStorage ()
virtual bool	RequiresUncapturedAxisInput () const
virtual bool	RequiresKeyboardInput () const
virtual bool	IsOrtho () const
virtual bool	IsInGameView () const
virtual class UWorld *	ConditionalSetWorld ()
virtual void	ConditionalRestoreWorld (class UWorld *InWorld)
virtual bool	OverrideHighResScreenshotCaptureRegion (FIntRect &OutCaptureRegion)
virtual FStatUnitData *	GetStatUnitData () const
virtual FStatHitchesData *	GetStatHitchesData () const
virtual const TArray< FString > *	GetEnabledStats () const
virtual void	SetEnabledStats (const TArray< FString > &InEnabledStats)
virtual bool	IsStatEnabled (const FString &InName) const
virtual void	SetShowStats (bool bWantStats)
virtual bool	IgnoreInput ()
virtual EMouseCaptureMode	GetMouseCaptureMode () const
virtual bool	CaptureMouseOnLaunch ()
virtual bool	LockDuringCapture ()
virtual bool	ShouldAlwaysLockMouse ()
virtual bool	HideCursorDuringCapture () const
virtual ENGINE_API FPopupMethodReply	OnQueryPopupMethod () const
virtual bool	HandleNavigation (const uint32 InUserIndex, TSharedPtr< SWidget > InDestination)
virtual bool	ShouldDPIScaleSceneCanvas () const

Protected Attributes
FPreviewScene *	PreviewScene
FMinimalViewInfo	ViewInfo
FLinearColor	BackgroundColor
FUMGViewportCameraTransform	ViewTransform
FViewport *	Viewport
FSceneViewStateReference	ViewState
FEngineShowFlags	EngineShowFlags
FMatrix	CachedViewProjectionMatrix

Additional Inherited Members
Protected Member Functions inherited from FCommonViewportClient
virtual float	UpdateViewportClientWindowDPIScale () const

Constructor & Destructor Documentation

FUMGViewportClient()

FUMGViewportClient::FUMGViewportClient

(

FPreviewScene *

InPreviewScene = nullptr

)

~FUMGViewportClient()

FUMGViewportClient::~FUMGViewportClient ( )

virtual

Member Function Documentation

CalcSceneView()

FSceneView * FUMGViewportClient::CalcSceneView ( FSceneViewFamily *  ViewFamily )

virtual

Draw() [1/2]

virtual void FViewElementDrawer::Draw ( const FSceneView *  View, FPrimitiveDrawInterface *  PDI  )

inlinevirtual

Draws the interaction using the given draw interface.

Reimplemented from FViewElementDrawer.

Draw() [2/2]

void FUMGViewportClient::Draw ( FViewport *  InViewport, FCanvas *  Canvas  )

overridevirtual

Reimplemented from FViewportClient.

GetBackgroundColor()

FLinearColor FUMGViewportClient::GetBackgroundColor

(

)

const

GetLookAtLocation()

const FVector & FUMGViewportClient::GetLookAtLocation ( ) const

inline

Returns

the current look at location

GetOrthoUnitsPerPixel()

float FUMGViewportClient::GetOrthoUnitsPerPixel

(

const FViewport *

Viewport

)

const

Returns

The number of units per pixel displayed in this viewport

GetOrthoZoom()

float FUMGViewportClient::GetOrthoZoom ( ) const

inline

Returns

the current ortho zoom amount

GetScene()

FSceneInterface * FUMGViewportClient::GetScene ( ) const

virtual

Returns

The scene being rendered in this viewport

GetViewLocation()

const FVector & FUMGViewportClient::GetViewLocation ( ) const

inline

Returns

the current viewport camera location

GetViewProjectionMatrix()

FMatrix FUMGViewportClient::GetViewProjectionMatrix

(

)

const

GetViewRotation()

const FRotator & FUMGViewportClient::GetViewRotation ( ) const

inline

Returns

the current viewport camera rotation

GetWorld()

UWorld * FUMGViewportClient::GetWorld ( ) const

overridevirtual

Reimplemented from FViewportClient.

IsAspectRatioConstrained()

bool FUMGViewportClient::IsAspectRatioConstrained

(

)

const

SetBackgroundColor()

void FUMGViewportClient::SetBackgroundColor

(

FLinearColor

InBackgroundColor

)

SetEngineShowFlags()

void FUMGViewportClient::SetEngineShowFlags ( FEngineShowFlags  InEngineShowFlags )

inline

SetLookAtLocation()

void FUMGViewportClient::SetLookAtLocation ( const FVector &  LookAt, bool  bRecalculateView = false  )

inline

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

Parameters

LookAt	The new look at location
bRecalulateView	If true, will recalculate view location and rotation to look at the new point immediatley

SetOrthoZoom()

void FUMGViewportClient::SetOrthoZoom ( float  InOrthoZoom )

inline

Sets ortho zoom amount

SetViewLocation()

void FUMGViewportClient::SetViewLocation ( const FVector &  NewLocation )

inline

Sets the location of the viewport's camera

SetViewRotation()

void FUMGViewportClient::SetViewRotation ( const FRotator &  NewRotation )

inline

Sets the location of the viewport's camera

Tick()

void FUMGViewportClient::Tick ( float  InDeltaTime )

virtual

Member Data Documentation

BackgroundColor

FLinearColor FUMGViewportClient::BackgroundColor

protected

CachedViewProjectionMatrix

FMatrix FUMGViewportClient::CachedViewProjectionMatrix

protected

EngineShowFlags

FEngineShowFlags FUMGViewportClient::EngineShowFlags

protected

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

PreviewScene

FPreviewScene* FUMGViewportClient::PreviewScene

protected

The scene used for the viewport. Owned externally

ViewInfo

FMinimalViewInfo FUMGViewportClient::ViewInfo

protected

Viewport

FViewport* FUMGViewportClient::Viewport

protected

ViewState

FSceneViewStateReference FUMGViewportClient::ViewState

protected

The viewport's scene view state.

ViewTransform

FUMGViewportCameraTransform FUMGViewportClient::ViewTransform

protected

Viewport camera transform data

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/UMG/Public/Components/Viewport.h
• Engine/Source/Runtime/UMG/Private/Components/Viewport.cpp