Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoElementHitMultiTarget
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementHitTargets.h |
| Include | #include "BaseGizmos/GizmoElementHitTargets.h" |
Syntax
class UGizmoElementHitMultiTarget :
public UObject,
public IGizmoClickMultiTarget
Remarks
UGizmoElementHitMultiTarget is an IGizmoClickMultiTarget implementation that hit-tests any object derived from UGizmoElementBase. This implementation is used for HitTargets which support hitting multiple parts within a gizmo element hierarchy.
For a gizmo with multiple parts, the part identifier establishes a correspondence between a gizmo part and the elements representing that part within the hit target. The valid part identifiers should be defined in the gizmo. Identifier 0 is reserved for the default ID which should be assigned to elements that do not correspond to any gizmo part, such as non-hittable decorative elements.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TFunction< bool(const FInputDeviceRay &)> | Condition | If set, this condition is checked before performing the hit test. | |
| TObjectPtr< UGizmoElementBase > | GizmoElement | Gizmo element. | |
| TObjectPtr< UTransformProxy > | GizmoTransformProxy | ||
| TObjectPtr< UGizmoViewContext > | GizmoViewContext |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UGizmoElementHitMultiTarget * | Construct
(
UGizmoElementBase* InGizmoElement, |
Overridden from IGizmoClickMultiTarget
| Type | Name | Description | |
|---|---|---|---|
| FInputRayHit | IsHit
(
const FInputDeviceRay& ClickPos |
||
| void | UpdateHittableState
(
bool bHittable, |
Updates the hittable state of the specified gizmo part. | |
| void | UpdateHoverState
(
bool bHovering, |
Updates the hover state of the specified gizmo part, indicating whether the input device is currently hovering over the Standard gizmo. | |
| void | UpdateInteractingState
(
bool bInteracting, |
Updates the interacting state of the specified gizmo part, indicating when interaction with the Standard gizmo is actively occurring, typically upon the input device clicking and dragging the Standard gizmo. |