Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UScalableSphereGizmo provides a sphere that can be scaled in all directions by dragging anywhere on the three axial circles that represent it
| Name | UScalableSphereGizmo |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ScalableSphereGizmo.h |
| Include Path | #include "BaseGizmos/ScalableSphereGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class UScalableSphereGizmo :
public UInteractiveGizmo ,
public IHoverBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveGizmo → UScalableSphereGizmo
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HitErrorThreshold | float | The error threshold for hit detection with the sphere. | BaseGizmos/ScalableSphereGizmo.h | |
| TransactionDescription | FText | The text that will be used as the transaction description for undo/redo. | BaseGizmos/ScalableSphereGizmo.h | |
| UpdateRadiusFunc | TFunction< void(const float)> | Called when the radius is chaged (by dragging or setting). Sends new radius as parameter. | BaseGizmos/ScalableSphereGizmo.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveAxis | FVector | The current axis that is being dragged along. | BaseGizmos/ScalableSphereGizmo.h | |
| ActiveTarget | TObjectPtr< UTransformProxy > | BaseGizmos/ScalableSphereGizmo.h | ||
| bIsDragging | bool | Whether the sphere is currently being dragged. | BaseGizmos/ScalableSphereGizmo.h | |
| bIsHovering | bool | Whether the sphere is currently being hovered over. | BaseGizmos/ScalableSphereGizmo.h | |
| DragCurrentPositionProjected | FVector | The position the drag is on currently (projected onto the line it is being dragged along) | BaseGizmos/ScalableSphereGizmo.h | |
| DragStartWorldPosition | FVector | The position the drag was started on. | BaseGizmos/ScalableSphereGizmo.h | |
| InteractionStartParameter | float | The initial parameter along the drag axist. | BaseGizmos/ScalableSphereGizmo.h | |
| Radius | float | The radius of the sphere. | BaseGizmos/ScalableSphereGizmo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool HitTest
(
const FRay& Ray, |
Check if the input Ray hit any of the components of the internal actor | BaseGizmos/ScalableSphereGizmo.h | |
virtual void OnBeginDrag
(
const FInputDeviceRay& Ray |
BaseGizmos/ScalableSphereGizmo.h | ||
virtual void OnEndDrag
(
const FInputDeviceRay& Ray |
BaseGizmos/ScalableSphereGizmo.h | ||
virtual void OnUpdateDrag
(
const FInputDeviceRay& Ray |
BaseGizmos/ScalableSphereGizmo.h | ||
void SetRadius
(
float InRadius |
Set the Radius of the Sphere | BaseGizmos/ScalableSphereGizmo.h | |
virtual void SetTarget
(
UTransformProxy* InTarget |
Set the Target to which the gizmo will be attached | BaseGizmos/ScalableSphereGizmo.h |
Overridden from UInteractiveGizmo
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
Allow the Gizmo to do any custom drawing (ie via PDI/RHI) | BaseGizmos/ScalableSphereGizmo.h | |
virtual void Setup() |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called | BaseGizmos/ScalableSphereGizmo.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
Do hover hit-test | BaseGizmos/ScalableSphereGizmo.h | |
virtual void OnBeginHover
(
const FInputDeviceRay& DevicePos |
Initialize hover sequence at given position | BaseGizmos/ScalableSphereGizmo.h | |
virtual void OnEndHover() |
Terminate active hover sequence | BaseGizmos/ScalableSphereGizmo.h | |
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
Update active hover sequence with new input position | BaseGizmos/ScalableSphereGizmo.h |