UScalableSphereGizmo

[UScalableSphereGizmo](API\Runtime\InteractiveToolsFramework\BaseGizmos\UScalableSphereGizmo) provides a sphere that can be scaled in all directions by dragging anywhere on the three axial circles that represent it

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Name Description

Public variable

float

 

HitErrorThreshold

The error threshold for hit detection with the sphere.

Public variable

FText

 

TransactionDescription

The text that will be used as the transaction description for undo/redo.

Public variable

TFunction< void...

 

UpdateRadiusFunc

Called when the radius is chaged (by dragging or setting). Sends new radius as parameter.

Functions

Name Description

Public function

bool

 

HitTest

(
    const FRay& Ray,
    FHitResult& OutHit,
    FVector& OutAxis,
    FTransform& OutTransform
)

Check if the input Ray hit any of the components of the internal actor

Public function Virtual

void

 

OnBeginDrag

(
    const FInputDeviceRay& Ray
)

Public function Virtual

void

 

OnEndDrag

(
    const FInputDeviceRay& Ray
)

Public function Virtual

void

 

OnUpdateDrag

(
    const FInputDeviceRay& Ray
)

Public function

void

 

SetRadius

(
    float InRadius
)

Set the Radius of the Sphere

Public function Virtual

void

 

SetTarget

(
    UTransformProxy* InTarget
)

Set the Target to which the gizmo will be attached

Overridden from UInteractiveGizmo

Name Description

Public function Virtual

void

 

Render

(
    IToolsContextRenderAPI* Render...
)

Allow the Gizmo to do any custom drawing (ie via PDI/RHI)

Public function Virtual

void

 

Setup()

Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called

Overridden from IHoverBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

BeginHoverSequenceHitTest

(
    const FInputDeviceRay& PressPos
)

Do hover hit-test

Public function Virtual

void

 

OnBeginHover

(
    const FInputDeviceRay& DevicePos
)

Initialize hover sequence at given position

Public function Virtual

void

 

OnEndHover()

Terminate active hover sequence

Public function Virtual

bool

 

OnUpdateHover

(
    const FInputDeviceRay& DevicePos
)

Update active hover sequence with new input position