Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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
| Name | UGizmoBaseComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoBaseComponent.h |
| Include Path | #include "BaseGizmos/GizmoBaseComponent.h" |
Syntax
UCLASS (ClassGroup=Utility, HideCategories=(Physics, Collision, Mobile), MinimalAPI)
class UGizmoBaseComponent :
public UPrimitiveComponent,
public IGizmoBaseComponentInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UGizmoBaseComponent
Implements Interfaces
- IGizmoBaseComponentInterface
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Derived Classes
UGizmoBaseComponent derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UGizmoBaseComponent() |
BaseGizmos/GizmoBaseComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Color | FLinearColor | BaseGizmos/GizmoBaseComponent.h |
|
|
| HoverSizeMultiplier | float | BaseGizmos/GizmoBaseComponent.h |
|
|
| PixelHitDistanceThreshold | float | BaseGizmos/GizmoBaseComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void NotifyExternalPropertyUpdates() |
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 | BaseGizmos/GizmoBaseComponent.h | |
void SetGizmoViewContext
(
UGizmoViewContext* GizmoViewContextIn |
BaseGizmos/GizmoBaseComponent.h |
Overridden from IGizmoBaseComponentInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateHoverState
(
bool bHoveringIn |
BaseGizmos/GizmoBaseComponent.h | ||
virtual void UpdateWorldLocalState
(
bool bWorldIn |
BaseGizmos/GizmoBaseComponent.h |