FUxtGrabPointerFocus

Focus implementation for the grab pointers.

struct FUxtGrabPointerFocus;

Header

#include <UxtPointerFocus.h>

Inheritance

Inherits from FUxtPointerFocus

Public Functions

	Name
void	BeginGrab(UUxtNearPointerComponent * Pointer)
void	UpdateGrab(UUxtNearPointerComponent * Pointer)
void	EndGrab(UUxtNearPointerComponent * Pointer)
bool	IsGrabbing() const

Protected Functions

	Name
virtual UClass *	GetInterfaceClass() const override
virtual bool	ImplementsTargetInterface(UObject * Target) const override
virtual bool	GetClosestPointOnTarget(const UActorComponent * Target, const UPrimitiveComponent * Primitive, const FVector & Point, FVector & OutClosestPoint, FVector & OutNormal) const override
virtual void	RaiseEnterFocusEvent(UPrimitiveComponent * Target, UUxtNearPointerComponent * Pointer) const override
virtual void	RaiseUpdateFocusEvent(UPrimitiveComponent * Target, UUxtNearPointerComponent * Pointer) const override
virtual void	RaiseExitFocusEvent(UPrimitiveComponent * Target, UUxtNearPointerComponent * Pointer) const override

Additional inherited members

Public Functions inherited from FUxtPointerFocus

	Name
virtual	~FUxtPointerFocus()
const FVector &	GetClosestTargetPoint() const
const FVector &	GetClosestTargetNormal() const
UObject *	GetFocusedTarget() const
UPrimitiveComponent *	GetFocusedPrimitive() const
UObject *	GetFocusedTargetChecked() const
void	SelectClosestTarget(UUxtNearPointerComponent * Pointer, const FTransform & PointerTransform, const TArray< FOverlapResult > & Overlaps)
void	UpdateClosestTarget(const FTransform & PointerTransform)
void	SelectClosestPointOnTarget(UUxtNearPointerComponent * Pointer, const FTransform & PointerTransform, UActorComponent * NewTarget)
void	ClearFocus(UUxtNearPointerComponent * Pointer)
void	UpdateFocus(UUxtNearPointerComponent * Pointer) const
UActorComponent *	FindInterfaceComponent(AActor * Owner) const

Protected Functions inherited from FUxtPointerFocus

	Name
void	SetFocus(UUxtNearPointerComponent * Pointer, const FTransform & PointerTransform, const FUxtPointerFocusSearchResult & FocusResult)
FUxtPointerFocusSearchResult	FindClosestTarget(const TArray< FOverlapResult > & Overlaps, const FVector & Point) const
FUxtPointerFocusSearchResult	FindClosestPointOnComponent(UActorComponent * Target, const FVector & Point) const

Public Functions Documentation

function BeginGrab

void BeginGrab(
    UUxtNearPointerComponent * Pointer
)

Notify the target object that grab has started.

function UpdateGrab

void UpdateGrab(
    UUxtNearPointerComponent * Pointer
)

Notify the grabbed target object that the pointer has been updated.

function EndGrab

void EndGrab(
    UUxtNearPointerComponent * Pointer
)

Notify the target object that grab has ended.

function IsGrabbing

bool IsGrabbing() const

Protected Functions Documentation

function GetInterfaceClass

virtual UClass * GetInterfaceClass() const override

Reimplements: FUxtPointerFocus::GetInterfaceClass

Get the interface class that targets for the pointer must implement.

function ImplementsTargetInterface

virtual bool ImplementsTargetInterface(
    UObject * Target
) const override

Reimplements: FUxtPointerFocus::ImplementsTargetInterface

Returns true if the given object implements the required target interface.

function GetClosestPointOnTarget

virtual bool GetClosestPointOnTarget(
    const UActorComponent * Target,
    const UPrimitiveComponent * Primitive,
    const FVector & Point,
    FVector & OutClosestPoint,
    FVector & OutNormal
) const override

Reimplements: FUxtPointerFocus::GetClosestPointOnTarget

Find the closest point on the given primitive using the distance function of the target interface.

function RaiseEnterFocusEvent

virtual void RaiseEnterFocusEvent(
    UPrimitiveComponent * Target,
    UUxtNearPointerComponent * Pointer
) const override

Reimplements: FUxtPointerFocus::RaiseEnterFocusEvent

Notify the target object that it has entered focus.

function RaiseUpdateFocusEvent

virtual void RaiseUpdateFocusEvent(
    UPrimitiveComponent * Target,
    UUxtNearPointerComponent * Pointer
) const override

Reimplements: FUxtPointerFocus::RaiseUpdateFocusEvent

Notify the focused target object that the pointer has been updated.

function RaiseExitFocusEvent

virtual void RaiseExitFocusEvent(
    UPrimitiveComponent * Target,
    UUxtNearPointerComponent * Pointer
) const override

Reimplements: FUxtPointerFocus::RaiseExitFocusEvent

Notify the target object that it has exited focus.

---

Updated on 19 August 2021 at 17:42:52 Coordinated Universal Time