1. Epic GamesDeveloper
  3. UGizmoElementLineBase

UGizmoElementLineBase

Base class for 2d and 3d primitive objects which support line drawing, intended to be used as part of 3D Gizmos.

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementLineBase.h
Include #include "BaseGizmos/GizmoElementLineBase.h"

Syntax

class UGizmoElementLineBase : public UGizmoElementBase

Remarks

Base class for 2d and 3d primitive objects which support line drawing, intended to be used as part of 3D Gizmos.

Variables

  Type Name Description
Protected variable bool bScreenSpaceLine Whether line thickness is in screen space.
Protected variable float HoverLineThicknessMultiplier Multiplier applied to line thickness when hovering.
Protected variable float InteractLineThicknessMultiplier Multiplier applied to line thickness when interacting.
Protected variable FGizmoElementLineRenderStateAttributes LineRenderAttributes Line render state attributes for this element.
Protected variable float LineThickness Line thickness when rendering lines, must be >= 0.0, value of 0.0 will render thinnest line.

Functions

  Type Name Description
Public function Virtual void Clear line render state hover line color attribute.
Public function Virtual void Clear line render state interact line color attribute.
Public function Virtual void Clear line render state line color attribute.
Public function Virtual Const bool Get line render state hover line color attribute's override setting.
Public function Virtual Const bool Get line render state interact line color attribute's override setting.
Public function Virtual Const bool Get line render state line color attribute's override setting.
Public function Virtual Const float

GetCurrentLineThickness ( bool bPerspectiveView,
float InViewFOV
)

 Get line thickness for based on current element interaction state and view.
Public function Virtual Const FLinearColor Get line render state hover line color attribute's value.
Public function Virtual Const float  
Public function Virtual Const FLinearColor Get line render state interact line color attribute's value.
Public function Virtual Const float  
Public function Virtual Const FLinearColor Get line render state line color attribute's value.
Public function Virtual Const float  
Public function Virtual Const bool  
Public function Virtual Const bool Returns true if line render state hover line color attribute has been set.
Public function Virtual Const bool Returns true if line render state interact line color attribute has been set.
Public function Virtual Const bool Returns true if line render state line color attribute has been set.
Public function Virtual void

SetHoverLineColor ( FLinearColor InColor,
bool InOverridesChildState
)

 Set line render state hover line color attribute.
Public function Virtual void

SetHoverLineThicknessMultiplier ( float InHoverLineThicknessMultiplier
)

 Multiplier applied to line thickness when hovering.
Public function Virtual void

SetInteractLineColor ( FLinearColor InColor,
bool InOverridesChildState
)

 Set line render state interact line color attribute.
Public function Virtual void

SetInteractLineThicknessMultiplier ( float InInteractLineThicknessMultiplier
)

 Multiplier applied to line thickness when interacting.
Public function Virtual void

SetLineColor ( FLinearColor InColor,
bool InOverridesChildState
)

 Methods for managing line state attributes: LineColor, HoverLineColor, InteractLineColor
Public function Virtual void

SetLineThickness ( float InLineThickness
)

 Line thickness when rendering lines, 0.0 is valid and will render thinnest line.
Public function Virtual void

SetScreenSpaceLine ( bool bInScreenSpaceLine
)

 Whether line thickness is in screen space.

Overridden from UGizmoElementBase

  Type Name Description
Protected function Virtual bool

UpdateRenderState ( IToolsContextRenderAPI* RenderAPI,
const FVector& InLocalOrigin,
FRenderTraversalState& InOutRenderState
)

 Update render state during render traversal, determines the current render state for this element

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page