Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UPrimitiveComponent
- IGizmoBaseComponentInterface
- UGizmoBaseComponent
- UGizmoArrowComponent
- UGizmoBoxComponent
- UGizmoCircleComponent
- UGizmoLineHandleComponent
- UGizmoRectangleComponent
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoBaseComponent.h |
| Include | #include "BaseGizmos/GizmoBaseComponent.h" |
Syntax
UCLASS (ClassGroup=Utility, HideCategories=(Physics, Collision, Mobile), MinimalAPI)
class UGizmoBaseComponent :
public UPrimitiveComponent,
public IGizmoBaseComponentInterface
Remarks
Base class for simple Components intended to be used as part of 3D Gizmos. Contains common properties and utility functions. This class does nothing by itself, use subclasses like UGizmoCircleComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bHovering | Hover state |
 |
bool | bIsViewDependent | True when GizmoViewContext is not null. |
 |
bool | bWorld | World/local coordinates state |
   |
FLinearColor | Color | |
  |
TObjectPtr< UGizmoViewContext > | GizmoViewContext | |
   |
float | HoverSizeMultiplier | |
   |
float | PixelHitDistanceThreshold |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Currently this must be called if you change UProps on Base or subclass, to recreate render proxy which has a local copy of those settings | |
 |
void | SetGizmoViewContext
(
UGizmoViewContext* GizmoViewContextIn |
Overridden from IGizmoBaseComponentInterface
| Type | Name | Description | |
|---|---|---|---|
   |
void | UpdateHoverState
(
bool bHoveringIn |
|
   |
void | UpdateWorldLocalState
(
bool bWorldIn |