Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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.
| Name | UGizmoElementHitMultiTarget |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementHitTargets.h |
| Include Path | #include "BaseGizmos/GizmoElementHitTargets.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoElementHitMultiTarget :
public UObject ,
public IGizmoClickMultiTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoElementHitMultiTarget
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Condition | TFunction< bool(const FInputDeviceRay &)> | If set, this condition is checked before performing the hit test. | BaseGizmos/GizmoElementHitTargets.h | |
| GizmoElement | TObjectPtr< UGizmoElementBase > | Gizmo element. | BaseGizmos/GizmoElementHitTargets.h | |
| GizmoTransformProxy | TObjectPtr< UTransformProxy > | BaseGizmos/GizmoElementHitTargets.h | ||
| GizmoViewContext | TObjectPtr< UGizmoViewContext > | BaseGizmos/GizmoElementHitTargets.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateHittableState
(
bool bHittable, |
BaseGizmos/GizmoElementHitTargets.h | ||
virtual void UpdateHoverState
(
bool bHovering, |
BaseGizmos/GizmoElementHitTargets.h | ||
virtual void UpdateInteractingState
(
bool bInteracting, |
BaseGizmos/GizmoElementHitTargets.h | ||
virtual void UpdateSelectedState
(
bool bInSelected, |
BaseGizmos/GizmoElementHitTargets.h | ||
virtual void UpdateSubdueState
(
bool bInSubdued, |
BaseGizmos/GizmoElementHitTargets.h |
Overridden from IGizmoClickMultiTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit IsHit
(
const FInputDeviceRay& ClickPos |
BaseGizmos/GizmoElementHitTargets.h | ||
virtual void UpdateHittableState
(
bool bHittable, |
Updates the hittable state of the specified gizmo part. | BaseGizmos/GizmoElementHitTargets.h | |
virtual 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. | BaseGizmos/GizmoElementHitTargets.h | |
virtual 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. | BaseGizmos/GizmoElementHitTargets.h | |
virtual void UpdateSelectedState
(
bool bSelected, |
Updates the selected state of the specified gizmo part, indicating when the gizmo part is currently selected, typically upon the input device clicking the Standard gizmo. | BaseGizmos/GizmoElementHitTargets.h | |
virtual void UpdateSubdueState
(
bool bSubdued, |
Updates the subdued state of the specified gizmo part, indicating when the element should have a subdued/background appearance, typically upon interacting with one of a set of gizmos representing 3 axis - the two not interacted with would be subdued. | BaseGizmos/GizmoElementHitTargets.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UGizmoElementHitMultiTarget * Construct
(
UGizmoElementBase* InGizmoElement, |
BaseGizmos/GizmoElementHitTargets.h |