1. Epic GamesDeveloper
  3. FSceneViewport

FSceneViewport

A viewport for use with Slate SViewport widgets.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Slate

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Slate/SceneViewport.h
Include #include "Slate/SceneViewport.h"

Syntax

class FSceneViewport :  
    public FViewportFrame ,  
    public FViewport ,  
    public ISlateViewport

Remarks

A viewport for use with Slate SViewport widgets.

Constructors

  Type Name Description
Public function  

FSceneViewport ( FViewportClient* InViewportClient,
TSharedPtr< SViewport > InViewportWidget
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function TSharedPtr< SWindow >  
Public function Const const FGeometry & Get the cached viewport geometry.
Public function Const bool  
Public function Const EPixelFormat Returns format for the scene of this viewport.
Public function Virtual Const FIntPoint

GetSize ()

  
Public function Virtual Const FVector2D  
Public function Virtual Const ESlateViewportDynamicRange  
Public function Virtual Const FSlateShaderResource * ISlateViewport interface
Public function Const TWeakPtr< SViewport >  
Public function Virtual TWeakPtr< SWidget >  
Public function Virtual bool

HandleNavigation ( const uint32 InUserIndex,
TSharedPtr< SWidget > InDestination
)

  
Public function Const bool Does the viewport has a fixed size
Public function Virtual FReply

OnAnalogValueChanged ( const FGeometry& MyGeometry,
const FAnalogInputEvent& InAnalogInputEvent
)

  
Public function Virtual FCursorReply

OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

  
Public function Virtual void

OnDrawViewport ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

  
Public function Virtual void  
Public function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

  
Public function Virtual FReply

OnFocusReceived ( const FFocusEvent& InFocusEvent
)

  
Public function Virtual FReply

OnKeyChar ( const FGeometry& InGeometry,
const FCharacterEvent& InCharacterEvent
)

  
Public function Virtual FReply

OnKeyDown ( const FGeometry& InGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function Virtual FReply

OnKeyUp ( const FGeometry& InGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function Virtual TOptional< TSharedRef< SWidget > >

OnMapCursor ( const FCursorReply& CursorReply
)

  
Public function Virtual FReply

OnMotionDetected ( const FGeometry& MyGeometry,
const FMotionEvent& InMotionEvent
)

  
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& InGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& InGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual void

OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseMove ( const FGeometry& InGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual FReply

OnMouseWheel ( const FGeometry& InGeometry,
const FPointerEvent& MouseEvent
)

  
Public function void

OnPlayWorldViewportSwapped ( const FSceneViewport& OtherViewport
)

 Performs a resize when in swapping viewports while viewing the play world.
Public function Virtual Const FPopupMethodReply  
Public function Virtual Const TOptional< bool >

OnQueryShowFocus ( const EFocusCause InFocusCause
)

  
Public function Virtual FReply  
Public function Virtual FReply

OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

  
Public function Virtual FReply

OnTouchFirstMove ( const FGeometry& MyGeometry,
const FPointerEvent& TouchEvent
)

  
Public function Virtual FReply

OnTouchForceChanged ( const FGeometry& MyGeometry,
const FPointerEvent& TouchEvent
)

  
Public function Virtual FReply

OnTouchGesture ( const FGeometry& MyGeometry,
const FPointerEvent& InGestureEvent
)

  
Public function Virtual FReply

OnTouchMoved ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

  
Public function Virtual FReply

OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

  
Public function Virtual FReply

OnViewportActivated ( const FWindowActivateEvent& InActivateEvent
)

  
Public function Virtual void  
Public function Virtual void

OnViewportDeactivated ( const FWindowActivateEvent& InActivateEvent
)

  
Public function Const void

PaintDebugCanvas ( const FGeometry& AllottedGeometry,
FSlateWindowElementList& OutDrawElements,
int32 LayerId
)

 Adds a draw element for the debug canvas.
Public function Virtual Const bool Returns true if the viewport should be vsynced.
Public function void

SetDebugCanvas ( TSharedPtr< class SDebugCanvas > InDebugCanvas
)

 Sets the debug canvas used to display FCanvas on top of this viewport
Public function void

SetFixedViewportSize ( uint32 NewSizeX,
uint32 NewSizeY
)

  
Public function void

SetGammaOverride ( const float InGammaOverride
)

 Set an optional display gamma to use for this viewport
Public function void Sets the Viewport resize delegate.
Public function void

SetPlayInEditorGetsMouseControl ( const bool bGetsMouseControl
)

 Sets whether a PIE viewport takes mouse control on startup.
Public function void

SetPlayInEditorIsSimulate ( const bool bIsSimulate
)

  
Public function Virtual void  
Public function void

SetViewportSize ( uint32 NewSizeX,
uint32 NewSizeY
)

  
Public function void

SwapStatCommands ( const FSceneViewport& OtherViewport
)

 Swaps the active stats with another viewports
Public function Virtual void

Tick ( const FGeometry& AllottedGeometry,
double InCurrentTime,
float InDeltaTime
)

 Ticks the viewport

Overridden from FViewportFrame

  Type Name Description
Public function Virtual FViewport * FViewportFrame interface
Public function Virtual void

ResizeFrame ( uint32 NewSizeX,
uint32 NewSizeY,
EWindowMode::Type NewWindowMode
)

 Called to resize the actual window where this viewport resides

Overridden from FViewport

  Type Name Description
Public function Virtual void Called when a frame starts to render
Public function Virtual void

CaptureMouse ( bool bCapture
)

  
Public function Virtual void Invalidates the viewport's cached hit proxies at the end of the frame.
Public function Virtual void

EndRenderFrame ( FRHICommandListImmediate& RHICmdList,
bool bPresent,
bool bLockToVsync
)

 Called when a frame is done rendering
Public function Virtual void

EnqueueBeginRenderFrame ( const bool bShouldPresent
)

 Called before BeginRenderFrame is enqueued
Public function Virtual void

EnqueueEndRenderFrame ( const bool bLockToVsync,
const bool bShouldPresent
)

 Ends a rendering frame. Called from the game thread.
Public function Virtual FCanvas *  
Public function Virtual void

GetMousePos ( FIntPoint& MousePosition,
const bool bLocalPosition
)

 Sets MousePosition to the current mouse position
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const FIntPoint Returns dimensions of RenderTarget texture. Can be called on a game thread.
Public function Virtual FViewportFrame * Retrieves the interface to the viewport's frame, if it has one.
Public function Virtual void *  
Public function Virtual Const bool  
Public function Virtual Const bool New MouseCapture/MouseLock API.
Public function Virtual void Called when the viewport should be invalidated and redrawn
Public function Virtual Const bool Returns true if the mouse cursor is currently visible
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Should return true, if stereo rendering is allowed in this viewport
Public function Virtual Const bool

KeyState ( FKey Key
)

 Returns the state of the provided key.
Public function Virtual void

LockMouseToViewport ( bool bLock
)

  
Public function Virtual void

MoveWindow ( int32 NewPosX,
int32 NewPosY,
int32 NewSizeX,
int32 NewSizeY
)

 FViewport interface
Public function Virtual void

ProcessInput ( float DeltaTime
)

 Additional input processing that happens every frame
Public function Virtual void

SetMouse ( int32 X,
int32 Y
)

 Not implemented
Public function Virtual void Sets PreCapture coordinates from the current position of the slate cursor.
Public function Virtual void

SetRequiresVsync ( bool bShouldVsync
)

 Indicate that the viewport should be block for vsync.
Public function Virtual void  
Public function Virtual bool

SetUserFocus ( bool bFocus
)

 Captures or uncaptures the joystick
Public function Virtual void

ShowCursor ( bool bVisible
)

  
Public function Virtual void

ShowSoftwareCursor ( bool bVisible
)

  
Public function Virtual void

UpdateViewportRHI ( bool bDestroyed,
uint32 NewSizeX,
uint32 NewSizeY,
EWindowMode::Type NewWindowMode,
EPixelFormat PreferredPixelFormat
)

 Updates the viewport RHI with a new size and fullscreen flag
Public function Virtual Const FIntPoint

ViewportToVirtualDesktopPixel ( FVector2D ViewportCoordinate
)

 Transforms a coordinate in the local space of this viewport into a virtual desktop pixel.
Public function Virtual Const FVector2D

VirtualDesktopPixelToViewport ( FIntPoint VirtualDesktopPointPx
)

 Transforms a virtual desktop pixel (the origin is in the primary screen's top left corner) to the local space of this viewport

Overridden from FRenderTarget

  Type Name Description
Public function Virtual Const EDisplayColorGamut  
Public function Virtual Const float  
Public function Virtual Const EDisplayOutputFormat  
Public function Virtual Const const FTextureRHIRef & Gets the proper RenderTarget based on the current thread
Public function Virtual Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page