UGizmoViewContext

A context object that is meant to hold the scene information for the hovered viewport on a game thread, to be used by a gizmo later for hit testing.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoViewContext.h

Include

#include "BaseGizmos/GizmoViewContext.h"

Syntax

class UGizmoViewContext : public UObject

Remarks

A context object that is meant to hold the scene information for the hovered viewport on a game thread, to be used by a gizmo later for hit testing. The organization mirrors FSceneView so that functions could be written in a templated way to use either FSceneView or UGizmoViewContext, though UGizmoViewContext only keeps the needed data.

Variables

Name Description

Protected variable

bool

 

bIsPerspectiveProjection

Public variable

FIntRect

 

UnscaledViewRect

Public variable

FVector

 

ViewLocation

Public variable

FMatrices

 

ViewMatrices

Functions

Name Description

Public function Const

FVector

 

GetViewDirection()

Public function Const

FVector

 

GetViewRight()

FSceneView-like functions/properties:

Public function Const

FVector

 

GetViewUp()

Public function Const

bool

 

IsPerspectiveProjection()

As a function just for similarity with FSceneView.

Public function

void

 

ResetFromSceneView

(
    const FSceneView& SceneView
)

Use this to reinitialize the object each frame for the hovered viewport.

Public function Const

FVector4

 

WorldToScreen

(
    const FVector& WorldPoint
)

Classes

Name

Description

Public class

FMatrices

Wrapping class for the matrices so that they can be accessed in the same way that they are accessed in FSceneView.