Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
| Name | UAxisAngleGizmo |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/AxisAngleGizmo.h |
| Include Path | #include "BaseGizmos/AxisAngleGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class UAxisAngleGizmo :
public UInteractiveGizmo ,
public IClickDragBehaviorTarget ,
public IHoverBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveGizmo → UAxisAngleGizmo
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FCustomDestinationParams |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AngleSource | TScriptInterface< IGizmoFloatParameterSource > | BaseGizmos/AxisAngleGizmo.h | ||
| AxisSource | TScriptInterface< IGizmoAxisSource > | The below properties can be manipulated for more fine-grained control, but typically it is sufficient to use the initialization method above. | BaseGizmos/AxisAngleGizmo.h | |
| bInInteraction | bool | BaseGizmos/AxisAngleGizmo.h | ||
| CustomDestinationFunc | TUniqueFunction< bool(const FCustomDestinationParams &WorldRay, FVector &OutputPoint)> | 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. | BaseGizmos/AxisAngleGizmo.h | |
| HitTarget | TScriptInterface< IGizmoClickTarget > | BaseGizmos/AxisAngleGizmo.h | ||
| InteractionCurAngle | float | BaseGizmos/AxisAngleGizmo.h | ||
| InteractionCurPoint | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| InteractionStartAngle | float | BaseGizmos/AxisAngleGizmo.h | ||
| InteractionStartPoint | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| MouseBehavior | TObjectPtr< UClickDragInputBehavior > | The mouse click behavior of the gizmo is accessible so that it can be modified to use different mouse keys. | BaseGizmos/AxisAngleGizmo.h | |
| RotationAxis | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| RotationOrigin | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| RotationPlaneX | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| RotationPlaneY | FVector | BaseGizmos/AxisAngleGizmo.h | ||
| ShouldUseCustomDestinationFunc | TUniqueFunction< bool()> | 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. | BaseGizmos/AxisAngleGizmo.h | |
| StateTarget | TScriptInterface< IGizmoStateTarget > | BaseGizmos/AxisAngleGizmo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool InitializeAsRotateGizmo
(
const UE::GizmoUtil::FTransformSubGizmoCommonParams& InitializationParams, |
Helper that initializes AxisSource, AngleSource, HitTarget, and StateTarget for the common case of being used to control the rotation of a transform. | BaseGizmos/AxisAngleGizmo.h |
Overridden from UInteractiveGizmo
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Setup() |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called | BaseGizmos/AxisAngleGizmo.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
Test if target can begin click-drag interaction at this point | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnClickDrag
(
const FInputDeviceRay& DragPos |
Notify Target that input position has changed | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnClickPress
(
const FInputDeviceRay& PressPos |
Notify Target that click press ocurred | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnClickRelease
(
const FInputDeviceRay& ReleasePos |
Notify Target that click release occurred | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnTerminateDragSequence() |
Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) | BaseGizmos/AxisAngleGizmo.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
IModifierToggleBehaviorTarget implementation (inherited via IClickDragBehaviorTarget) | BaseGizmos/AxisAngleGizmo.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
IHoverBehaviorTarget implementation. | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnBeginHover
(
const FInputDeviceRay& DevicePos |
Initialize hover sequence at given position | BaseGizmos/AxisAngleGizmo.h | |
virtual void OnEndHover() |
Terminate active hover sequence | BaseGizmos/AxisAngleGizmo.h | |
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
Update active hover sequence with new input position | BaseGizmos/AxisAngleGizmo.h |