Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Base class for 2d and 3d primitive objects which support line drawing, intended to be used as part of 3D Gizmos.
| Name | UGizmoElementLineBase |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementLineBase.h |
| Include Path | #include "BaseGizmos/GizmoElementLineBase.h" |
Syntax
UCLASS (Transient, Abstract, MinimalAPI)
class UGizmoElementLineBase : public UGizmoElementBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoElementBase → UGizmoElementLineBase
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearHoverLineColor() |
Clear line render state hover line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void ClearInteractLineColor() |
Clear line render state interact line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void ClearLineColor() |
Clear line render state line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void ClearSelectLineColor() |
Clear line render state interact line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void ClearSubdueLineColor() |
Clear line render state interact line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool DoesHoverLineColorOverrideChildState() |
Get line render state hover line color attribute's override setting. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool DoesInteractLineColorOverrideChildState() |
Get line render state interact line color attribute's override setting. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool DoesLineColorOverrideChildState() |
Get line render state line color attribute's override setting. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool DoesSelectLineColorOverrideChildState() |
Get line render state interact line color attribute's override setting. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool DoesSubdueLineColorOverrideChildState() |
Get line render state interact line color attribute's override setting. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetCurrentLineThickness
(
bool bPerspectiveView, |
Get line thickness for based on current element interaction state and view. | BaseGizmos/GizmoElementLineBase.h | |
virtual FLinearColor GetHoverLineColor() |
Get line render state hover line color attribute's value. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetHoverLineThicknessMultiplier() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual FLinearColor GetInteractLineColor() |
Get line render state interact line color attribute's value. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetInteractLineThicknessMultiplier() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual FLinearColor GetLineColor() |
Get line render state line color attribute's value. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetLineThickness() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual bool GetScreenSpaceLine() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual FLinearColor GetSelectLineColor() |
Get line render state interact line color attribute's value. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetSelectLineThicknessMultiplier() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual FLinearColor GetSubdueLineColor() |
Get line render state interact line color attribute's value. | BaseGizmos/GizmoElementLineBase.h | |
virtual float GetSubdueLineThicknessMultiplier() |
BaseGizmos/GizmoElementLineBase.h | ||
virtual bool HasHoverLineColor() |
Returns true if line render state hover line color attribute has been set. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool HasInteractLineColor() |
Returns true if line render state interact line color attribute has been set. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool HasLineColor() |
Returns true if line render state line color attribute has been set. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool HasSelectLineColor() |
Returns true if line render state interact line color attribute has been set. | BaseGizmos/GizmoElementLineBase.h | |
virtual bool HasSubdueLineColor() |
Returns true if line render state interact line color attribute has been set. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetHoverLineColor
(
FLinearColor InColor, |
Set line render state hover line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetHoverLineThicknessMultiplier
(
float InHoverLineThicknessMultiplier |
Multiplier applied to line thickness when hovering. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetInteractLineColor
(
FLinearColor InColor, |
Set line render state interact line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetInteractLineThicknessMultiplier
(
float InInteractLineThicknessMultiplier |
Multiplier applied to line thickness when interacting. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetLineColor
(
FLinearColor InColor, |
Methods for managing line state attributes: LineColor, HoverLineColor, InteractLineColor, SelectLineColor, SubdueLineColor | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetLineThickness
(
float InLineThickness |
Line thickness when rendering lines, 0.0 is valid and will render thinnest line. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetScreenSpaceLine
(
bool bInScreenSpaceLine |
Whether line thickness is in screen space. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetSelectLineColor
(
FLinearColor InColor, |
Set line render state Select line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetSelectLineThicknessMultiplier
(
float InSelectLineThicknessMultiplier |
Multiplier applied to line thickness when selected. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetSubdueLineColor
(
FLinearColor InColor, |
Set line render state subdue line color attribute. | BaseGizmos/GizmoElementLineBase.h | |
virtual void SetSubdueLineThicknessMultiplier
(
float InSubdueLineThicknessMultiplier |
Multiplier applied to line thickness when subdued. | BaseGizmos/GizmoElementLineBase.h |
Protected
Overridden from UGizmoElementBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool UpdateRenderState
(
IToolsContextRenderAPI* RenderAPI, |
Update render state during render traversal, determines the current render state for this element | BaseGizmos/GizmoElementLineBase.h |