UGizmoComponentHitTarget

[UGizmoComponentHitTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoComponentHitTarget) is an [IGizmoClickTarget](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoClickTarget) implementation that hit-tests a [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGizmoComponentHitTarget

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/HitTargets.h

Include

#include "BaseGizmos/HitTargets.h"

Syntax

class UGizmoComponentHitTarget :
    public UObject,
    public IGizmoClickTarget

Remarks

UGizmoComponentHitTarget is an IGizmoClickTarget implementation that hit-tests a UPrimitiveComponent

Variables

Name Description

Public variable

TObjectPtr< UPr...

 

Component

Component->LineTraceComponent() is called to determine if the target is hit

Public variable

TFunction< bool...

 

Condition

If set, this condition is checked before performing the hit test.

Public variable

TFunction< void...

 

UpdateHoverFunction

This function is called to update hover state of the target

Public variable

TFunction< void...

 

UpdateInteractingFunction

This function is called to update interacting state of the target

Functions

Name Description

Public function Static

UGizmoCompon...

 

Construct

(
    UPrimitiveComponent* Component,
    UObject* Outer
)

Overridden from IGizmoClickTarget

Name Description

Public function Virtual Const

FInputRayHit

 

IsHit

(
    const FInputDeviceRay& ClickPos
)

Public function Virtual

void

 

UpdateHoverState

(
    bool bHovering
)

Updates the hover state indicating whether the input device is currently hovering over the Standard gizmo.

Public function Virtual

void

 

UpdateInteractingState

(
    bool bInteracting
)

Updates the interacting state indicating when interaction with the Standard gizmo is actively occurring, typically upon the input device clicking and dragging the Standard gizmo.