Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveGizmo
- UAxisAngleGizmo
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/AxisAngleGizmo.h |
| Include | #include "BaseGizmos/AxisAngleGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class UAxisAngleGizmo :
public UInteractiveGizmo ,
public IClickDragBehaviorTarget ,
public IHoverBehaviorTarget
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
TScriptInterface< IGizmoFloatParameterSource > | AngleSource | |
  |
TScriptInterface< IGizmoAxisSource > | AxisSource | |
  |
bool | bInInteraction | |
 |
float | ClosestAxisStartAngle | The angle of the closest axis in the plane of the angle gizmo (will be 0, pi/2, pi, or 3pi/2). |
 |
TUniqueFunction< bool(const FCustomDestinationParams &WorldRay, FVector &OutputPoint)> | CustomDestinationFunc | If ShouldUseCustomDestinationFunc() returns true, this function is used to get a destination point, and the output parameter is picked in such a way that the closest axis in the plane of the gizmo (the positive or negative x or y, if we're rotating around z, for instance) moves to the closest point in the plane to the destination point. |
  |
TScriptInterface< IGizmoClickTarget > | HitTarget | |
 |
float | InitialTargetAngle | |
  |
float | InteractionCurAngle | |
  |
FVector | InteractionCurPoint | |
  |
float | InteractionStartAngle | |
  |
FVector | InteractionStartPoint | |
 |
FVector | LastHitPosition | |
  |
TObjectPtr< UClickDragInputBehavior > | MouseBehavior | The mouse click behavior of the gizmo is accessible so that it can be modified to use different mouse keys. |
  |
FVector | RotationAxis | |
  |
FVector | RotationOrigin | |
  |
FVector | RotationPlaneX | |
  |
FVector | RotationPlaneY | |
 |
TUniqueFunction< bool()> | ShouldUseCustomDestinationFunc | This gets checked to see if we should use the custom ray caster to get a destination point for the gizmo, rather than grabbing the intersection with the gizmo plane. |
  |
TScriptInterface< IGizmoStateTarget > | StateTarget |
Overridden from UInteractiveGizmo
| Type | Name | Description | |
|---|---|---|---|
  |
void | Setup () |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called |
Overridden from IClickDragBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
FInputRayHit | CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
Test if target can begin click-drag interaction at this point |
  |
void | OnClickDrag
(
const FInputDeviceRay& DragPos |
Notify Target that input position has changed |
  |
void | OnClickPress
(
const FInputDeviceRay& PressPos |
Notify Target that click press ocurred |
  |
void | OnClickRelease
(
const FInputDeviceRay& ReleasePos |
Notify Target that click release occurred |
  |
void | Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) |
Overridden from IModifierToggleBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnUpdateModifierState
(
int ModifierID, |
IModifierToggleBehaviorTarget implementation (inherited via IClickDragBehaviorTarget) |
Overridden from IHoverBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
FInputRayHit | BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
IHoverBehaviorTarget implementation. |
  |
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 |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FCustomDestinationParams |