FEditorViewportClient

True if this window is allowed to be possessed by cinematic tools for previewing sequences in real-time

Camera Lock or not

True if all input is rejected from this viewport

True if the user is dragging by a widget handle.

If true, draw the axis indicators when the viewport is perspective.

If true, draw vertices for selected BSP brushes and static meshes if the large vertices show flag is set.

If true, force this viewport to use real time audio regardless of other settings

True if we've forced the SHOW_Lighting show flag off because there are no lights in the scene

If true, this viewport gets to set audio parameters (e.g. set the listener)

If true, the canvas has been been moved using bMoveCanvas Mode

Is the camera moving?

Is the camera moving at the beginning of the tick?

If the viewport is currently realtime

True if this level viewport can be used to view Simulate in Editor sessions

True when within a FMouseDeltaTracker::StartTracking/EndTracking block.

Flag to lock the viewport fly camera

If, following the next redraw, we should invalidate hit proxies on the viewport

The number of pending viewport redraws.

Does this viewport client own the mode tools instance pointed at by ModeTools control the lifetime of it?

If true, the listener position will be set

Whether view modifiers should be called and applied.

True when we are in a state where we can check the hit proxy for hovering.

True if we should draw stats over the viewport

Whether the widget should be drawn.

If true, numpad keys will be used to move camera in perspective viewport

True is the use is controling the light via a shorcut

True if this viewport uses a draw helper

True if the orbit camera is currently being used

True if the widget's axis is being controlled by an active mouse drag.

Represents the last mouse position.

Represents the last known mouse position.

Camera controller object that's used for piloting the camera around

Camera speed scalar

Camera speed setting

Current cached impulse state

Cumulative camera drag and rotation deltas from trackpad gesture in current Tick

-1, -1 if not set

Default set up for toggling back

Draw helper for rendering common editor functionality like the grid

The editor viewport widget this client is attached to

A list of all the stat names which are enabled for this viewport

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

Editor setting to allow designers to override the automatic expose

Extra camera speed scale for flight camera

Viewport's stored horizontal field of view (saved in ini files).

The number of frames since this viewport was last drawn.

Delegate used to get whether or not this client is in an immersive viewport

Cached state of joystick axes and buttons

Override the LOD of landscape in this viewport.

Previous value for engine show flags, used for toggling.

Updated on each mouse drag start

Editor mode tools provided to this instance.

Used for the display of the current preview light after it has been adjusted.

Custom override function that will be called every ::Draw() until override is disabled

The scene used for the viewport. Owned externally

Temporary realtime overrides and user messages that are not saved between editor sessions.

Overrides bIsRealtime until GFrameCounter is >= this number.

InterpEd, should only be set if used for matinee recording

Cursor visibility and appearance information

Data needed to display per-frame stat tracking when STAT HITCHES is enabled

Data needed to display per-frame stat tracking when STAT UNIT is enabled

Viewport view state when stereo rendering is enabled

When we have LOD locking, it's slow to force redraw of other viewports, so we delay invalidates to reduce the number of redraws

Viewport's current horizontal field of view (can be modified by locked cameras etc.)

Index of this view in the editor's list of views

List of view modifiers to apply on view parameters.

The viewport type.

The viewport's scene view state.

Viewport camera transform data for orthographic viewports

Viewport camera transform data for perspective viewports

Delegate used to get the visibility of this client from a slate viewport layout and tab configuration

Non-copyable

Aborts mouse tracking (stop and cancel)

Overrides the realtime state of this viewport until RemoveViewportsRealtimeOverride is called.

Adjusts the current transform widget size by the provided delta value

Returns true if the viewport is allowed to be possessed for previewing cinematic sequences or keyframe animations

Updates the rotate widget with the passed in delta rotation.

Apply the required cursor visibility states from the RequiredCursorVisibiltyAndAppearance struct

Configures the specified FSceneView object with the view and projection matrices for this viewport.

Helper function to calculate the safe frame rectangle on the current viewport

Computes a matrix to use for viewport location and rotation

Whether or not the widget mode can be cycled

Checks the viewport to see if the given object can be dropped using the given mouse coordinates local to this viewport

Whether or not the new widget mode can be set in this viewport

Translates the viewport so that the given LookAt point is at the center of viewport, while maintaining current Location/LookAt distance

Changes the buffer visualization mode for this viewport

Changes the ray tracing debug visualization mode for this viewport

Called when the mouse cursor is hovered over a hit proxy

Converts a generic movement delta into drag/rotation deltas based on the viewport and keys held down.

If dragging an actor for placement, this function destroys the actor.

Disable EngineShowFlags override if enabled

Draws a screen space bounding box around the specified actor

Draws viewport axes

Called to draw onto the viewports 2D canvas

Draws a visualization of the preview light if it was recently moved.

Draws viewport scale units

Attempts to intelligently drop the given objects in the viewport, using the given mouse coordinates local to this viewport

Enables or disables camera lock

Enable customization of the EngineShowFlags for rendering.

Focuses the viewport to the center of the bounding box ensuring that the entire box is in view

Helper used by DrawSafeFrames to get the current safe frame aspect ratio.

Get the camera speed for this viewport

Get the camera speed for this viewport based on the specified speed setting

Get the camera speed scalar for this viewport

Get the camera speed setting for this viewport

It returns the FText display name associate with CurrentBufferVisualizationMode

Gets the world space cursor info from the current mouse position

Get the editor viewport widget

Get the far clipping plane override for this viewport.

Returns the location of the object at the given viewport X,Y

Gets a joystick state cache for the specified controller ID

Editor mode tool manager being used for this viewport client

Mouse info is usually transformed to gizmo space before FEdMode handles it, this allows raw delta X and Y access

Get the near clipping plane for this viewport.

Get the custom pivot point around which the camera should orbit for this viewport

Retrieves the FPreviewScene used by this instance of FEditorViewportClient.

Returns the scene depth at the given viewport X,Y

Returns the map allowing to convert from the viewmode param to a name.

Gets the dimensions of the viewport

Returns the effective viewport type (taking into account any actor locking or camera possession)

Gets ViewportCameraTransform object for the current viewport type

Delegate handler fired to determine the state of a show flag

Delegate handler fired when a show flag is toggled

Returns true if a placement dragging actor exists

Returns whether there's a realtime override registered with the given system name.

Implements screenshot capture for editor viewports.

Called to give the viewport client a chance to handle widgets being moved

Invalidates this viewport and optionally child views.

Invalidates the viewport widget (if valid) to register its active timer

Utility functions to return the modifier key states.

Is the aspect ratio currently constrained?

Checks if a buffer visualization mode is selected

Callback for checking the camera lock flag.

Returns whether or not the flight camera is active

If true, this is a level editor viewport

Returns true if camera recoil is currently allowed

Returns true if this viewport is perspective.

Checks if a ray tracing debug visualization mode is selected

Callback for checking the bounds show flag.

Callback for checking the collision geometry show flag.

Callback for checking the grid show flag.

Determines whether this viewport is currently allowed to use Absolute Movement

True if the window is maximized or floating

Returns whether visualize debug material is enabled.

Called to make a drag tool when the user starts dragging in the viewport

Forces a cursor update and marks the window as a move has occurred

Moves the viewport Scamera according to the specified drag and rotation.

Called when a user changes the camera speed

Called when a user dollys the perspective camera

Called when a user zooms the ortho viewport

Opens the screenshot in the uses default bitmap viewer (determined by OS)

Override the far clipping plane. Set to a negative value to disable the override.

Subclasses may override the near clipping plane. Set to a negative value to disable the override.

Called to override any post process settings for the view

Called when the perspective viewport camera moves

Removes the last added realtime override.

Called when the user clicks in the viewport

Handles clicking in the viewport

Handles double clicking in the viewport

Invalidates this and other linked viewports (anything viewing the same scene)

Removes the most recent realtime override registered with the given system name.

Render the drag tool in the viewport

Get the number of real-time frames to draw (overrides bRealtime) @note When non-zero, the viewport will render RealTimeFrameCount frames in real-time mode, then revert back to bIsRealtime this can be used to ensure that not only the viewport renders a frame, but also that the world ticks

Rotate through viewport view options

Saves the realtime state to a config location. Does not save any temp overrides

Sets whether or not this viewport is allowed to be possessed by cinematic/scrubbing tools

Callback for toggling the camera lock flag.

This set ups camera for both orbit and non orbit control

Set the camera speed scalar for this viewport

Set the speed setting for the camera in this viewport

Sets the current axis being manipulated by the transform widget

True to force realtime audio to be true, false to stop forcing it

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

Set whether previewing for low DPI.

Allows custom disabling of camera recoil

Sets ortho zoom amount

Set preview screen percentage on UI behalf.

Sets whether or not the viewport updates in realtime.

Sets the required hardware and software cursor.

Overrides current cursor.

Aspect ratio bar display settings

Sets the show bounds flag

Callback for toggling the collision geometry show flag.

Callback for toggling the grid show flag.

Called to do any additional set up of the view for rendering

Sets the location of the viewport's camera

Sets the camera view location such that the LookAtPoint point is at the specified location.

Sets how the viewport is displayed (lit, wireframe, etc) for the current viewport type

Set the viewmode param.

Sets how the viewport is displayed (lit, wireframe, etc)

Set the viewport type of the client

Sets the location of the viewport's camera

Sets the coordinate system space to use

Sets the current widget mode

Overrides current widget mode

Returns true if status information should be displayed over the viewport

Determines if the new MoveCanvas movement should be used

Show or hide the widget.

Starts tracking the mouse due to mouse input

Stops any mouse tracking

Takes the screenshot capture, this is called by keybinded events as well InputTakeScreenshot

Ticks this viewport client

Toggle between orbit camera and fly camera

Toggles whether or not the viewport updates in realtime and returns the updated state.

Callback for toggling the bounds show flag.

Called when mouse movement tracking begins

Called when mouse movement tracking stops

Determines which axis InKey and InDelta most refer to and returns a corresponding FVector.

Get a prettified string representation of the specified unreal units

Updates the visibility of the hardware and software cursors according to the viewport's state.

If dragging an actor for placement, this function updates its position.

Called each frame to update the viewport based on delta trackpad gestures

When collision draw mode changes, this function allows hidden objects to be drawn, so hidden colliding objects can be seen

Called each frame to update the viewport based on delta mouse movements

Setup the cursor visibility state we require and store in RequiredCursorVisibiltyAndAppearance struct

Should this viewport use app time instead of world time.

Normally we disable all viewport rendering when the editor is minimized, but the render commands may need to be processed regardless (like if we were outputting to a monitor via capture card).

FCommonViewportClient interface

Called when the mouse is moved while a window input capture is in effect

Retrieves the cursor that should be displayed by the OS

Get a ptr to the enabled stats list

Get a ptr to the stat unit data for this viewport

Get a ptr to the stat unit data for this viewport

Use the viewports Scene to get a world.

Check an axis movement received by the viewport.

Check a gesture event received by the viewport.

Returns true if this viewport is excluding non-game elements from its display

Returns true if this viewport is orthogonal.

Check whether a specific stat is enabled for this viewport

Called from slate when input is finished for this frame, and we should process any queued mouse moves.

FViewportClient interface

Sets all the stats that should be enabled for the viewport

Sets whether or not stats info is displayed over the viewport

FViewElementDrawer interface

FGCObject interface

Use this method to report a name for your referencer.

Used to store the required cursor visibility states and override cursor appearance

Used by the custom temporal upscaler plugin.

DPI mode for scene rendering.

Default view mode for orthographic viewports

Default view mode for perspective viewports

The Maximum Mouse/Camera Speeds Setting supported

Constant for how much the camera safe zone rectangle is inset when being displayed in the editor

Use the new InputKey(const FInputKeyEventArgs& EventArgs) function.

Use OnEditorModeIDChanged() instead.

RemoveRealtimeOverride now takes a system display name to help remove the correct override.

To save and restore realtime state non-permanently use AddRealtimeOverride and RemoveRealtimeOverride

SetRealtime no longer takes in bStoreCurrentValue parameter. For temporary overrides use AddRealtimeOverride

SetRealtimeOverride is replaced with AddRealtimeOverride, as multiple overrides can now be added.