Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/UGizmoElementBase
Render traversal state structure used to maintain the current render state while rendering. As the gizmo element hierarchy is traversed, current state is maintained and updated. Element state attribute inheritance works as follows:
- Child element state that is not set inherits from parent state.
- Overrides: parent element state with override set to true replaces all child state regardless of whether the child state has been set.
| Name | FRenderTraversalState |
| Type | struct |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementBase.h |
| Include Path | #include "BaseGizmos/GizmoElementBase.h" |
Syntax
struct FRenderTraversalState
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DepthAtPixelToWorldReferencePoint | double | The screen space depth of the reference point used to compute PixelToWorldScale. Defaults to -1.0 (unset). Should not be used if negative. | BaseGizmos/GizmoElementBase.h | |
| FlattenScale | FVector | The potentially flattened scale of this state, if this view is orthographic. | BaseGizmos/GizmoElementBase.h | |
| InteractionState | EGizmoElementInteractionState | Interact state, if not equal to none, overrides the element's interact state. | BaseGizmos/GizmoElementBase.h | |
| LineRenderState | FGizmoElementLineRenderStateAttributes | Current state used for rendering lines. | BaseGizmos/GizmoElementBase.h | |
| LocalToWorldTransform | FTransform | LocalToWorld transform Note: non-uniform scale is not supported and the X scale element will be used for uniform scaling. | BaseGizmos/GizmoElementBase.h | |
| MeshRenderState | FGizmoElementMeshRenderStateAttributes | Current state used for rendering meshes. | BaseGizmos/GizmoElementBase.h | |
| PixelToWorldScale | double | Pixel to world scale. Also accounts for DPI scale,. | BaseGizmos/GizmoElementBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Returns the line color based on the current interaction state. | BaseGizmos/GizmoElementBase.h | ||
| Returns the line color based on the current interaction state. | BaseGizmos/GizmoElementBase.h | ||
const UMaterialInterface * GetCurrentMaterial () |
Returns the mesh material based on the current interaction state. | BaseGizmos/GizmoElementBase.h | |
const UMaterialInterface * GetCurrentMaterial () |
BaseGizmos/GizmoElementBase.h | ||
| Returns the mesh vertex color based on the current interaction state. | BaseGizmos/GizmoElementBase.h | ||
| Returns the mesh vertex color based on the current interaction state. | BaseGizmos/GizmoElementBase.h | ||
void Initialize
(
const UE::GizmoRenderingUtil::ISceneViewInterface& InView, |
Initialize state. | BaseGizmos/GizmoElementBase.h | |
void Initialize
(
const FSceneView* InSceneView, |
Initialize state | BaseGizmos/GizmoElementBase.h | |
FScaleMatrix SafeFlattenMatrix () |
Returns the flatten scale if the LocalToWorldTransform is safe to flatten. Otherwise, returns an unscaled matrix. | BaseGizmos/GizmoElementBase.h | |
FScaleMatrix SafeFlattenMatrix
(
const FTransform& InLocalToWorldTransform |
Returns the flatten scale if the provided LocalToWorldTransform is safe to flatten. | BaseGizmos/GizmoElementBase.h |