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