UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IGizmoClickMultiTarget Class Referenceabstract

#include <GizmoInterfaces.h>

+ Inheritance diagram for IGizmoClickMultiTarget:

Public Member Functions

virtual FInputRayHit IsHit (const FInputDeviceRay &ClickPos) const =0
 
virtual void UpdateHoverState (bool bHovering, uint32 InPartIdentifier)=0
 
virtual void UpdateInteractingState (bool bInteracting, uint32 InPartIdentifier)=0
 
virtual void UpdateSelectedState (bool bSelected, uint32 InPartIdentifier)=0
 
virtual void UpdateSubdueState (bool bSubdued, uint32 InPartIdentifier)=0
 
virtual void UpdateHittableState (bool bHittable, uint32 InPartIdentifier)=0
 

Detailed Description

IGizmoClickMultiTarget is an interface used to provide a ray-object hit test against a target which supports hitting parts of the target.

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.

Member Function Documentation

◆ IsHit()

virtual FInputRayHit IGizmoClickMultiTarget::IsHit ( const FInputDeviceRay ClickPos) const
pure virtual
Returns
FInputRayHit indicating whether or not the target object was hit by the device-ray at ClickPos The ray hit contains client-defined ID, HitOwner and HitObject which are used to identify the hit part.

Implemented in UGizmoElementHitMultiTarget.

◆ UpdateHittableState()

virtual void IGizmoClickMultiTarget::UpdateHittableState ( bool  bHittable,
uint32  InPartIdentifier 
)
pure virtual

Implemented in UGizmoElementHitMultiTarget.

◆ UpdateHoverState()

virtual void IGizmoClickMultiTarget::UpdateHoverState ( bool  bHovering,
uint32  InPartIdentifier 
)
pure virtual

Implemented in UGizmoElementHitMultiTarget.

◆ UpdateInteractingState()

virtual void IGizmoClickMultiTarget::UpdateInteractingState ( bool  bInteracting,
uint32  InPartIdentifier 
)
pure virtual

Implemented in UGizmoElementHitMultiTarget.

◆ UpdateSelectedState()

virtual void IGizmoClickMultiTarget::UpdateSelectedState ( bool  bSelected,
uint32  InPartIdentifier 
)
pure virtual

Implemented in UGizmoElementHitMultiTarget.

◆ UpdateSubdueState()

virtual void IGizmoClickMultiTarget::UpdateSubdueState ( bool  bSubdued,
uint32  InPartIdentifier 
)
pure virtual

Implemented in UGizmoElementHitMultiTarget.


The documentation for this class was generated from the following file: