Class UUxtNearPointerComponent

Adds poke and grab interactions to an actor. It keeps track of all overlapping poke targets and raises focus events on the closest one. Targets use the transform of pointers focusing them to drive their interactions.

Inheritance

System::Object

UActorComponent

UUxtPointerComponent

UUxtNearPointerComponent

Inherited Members

UUxtPointerComponent::bFocusLocked

UUxtPointerComponent::GetCursorTransform()

UUxtPointerComponent::GetFocusLocked()

UUxtPointerComponent::GetFocusTarget()

UUxtPointerComponent::Hand

UUxtPointerComponent::SetFocusLocked(bool bLocked)

UUxtPointerComponent::UUxtPointerComponent()

Namespace:

Assembly: .dll

Syntax

public: class UUxtNearPointerComponent : public xtPointerComponent

Constructors

~UUxtNearPointerComponent()

Declaration

public: virtual ~UUxtNearPointerComponent()

UUxtNearPointerComponent()

Declaration

public: UUxtNearPointerComponent()

Fields

DebounceDepth

The distance the fingertip must be from a pokeable in order to fire a poke end event. This is used in order to distinguish the queries for poke begin and poke end so you cannot easily cause end touch to fire one frame and begin touch to fire on the next frame.

Declaration

public: float DebounceDepth= 0.5f

Field Value

Type	Description
float

GrabFocus

Focus of the grab pointer

Declaration

protected: FUxtGrabPointerFocus * GrabFocus

Field Value

Type	Description
FUxtGrabPointerFocus *

GrabRadius

Declaration

public: float GrabRadius= 3.5f

Field Value

Type	Description
float

PokeDepth

The depth beyond the front face at which a front face pokable no longer recieves poke events. While poking a front face pokable, if the near pointer moves beyond this depth, the pokable will receive a poke end event.

Declaration

public: float PokeDepth= 20.0f

Field Value

Type	Description
float

PokeFocus

Focus of the poke pointer

Declaration

protected: FUxtPokePointerFocus * PokeFocus

Field Value

Type	Description
FUxtPokePointerFocus *

PokeRadius

Declaration

public: float PokeRadius= 0.75f

Field Value

Type	Description
float

ProximityRadius

Declaration

public: float ProximityRadius= 11.0f

Field Value

Type	Description
float

TraceChannel

Declaration

public: TEnumAsByte<ECollisionChannel> TraceChannel= ECollisionChannel::ECC_Visibility

Field Value

Type	Description
TEnumAsByte<ECollisionChannel>

Methods

BeginPlay()

Declaration

public: virtual void BeginPlay() override

EndPlay(const EEndPlayReason::Type EndPlayReason)

Declaration

public: virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override

Parameters

Type	Name	Description
const EEndPlayReason::Type	EndPlayReason

GetCursorTransform()

Declaration

public: virtual FTransform GetCursorTransform() const override

Returns

Type	Description
FTransform

GetFocusedGrabTarget(FVector &OutClosestPointOnTarget)

Returns currently focused grab target or null if there is none.

Declaration

public: UObject * GetFocusedGrabTarget(FVector &OutClosestPointOnTarget) const

Parameters

Type	Name	Description
FVector &	OutClosestPointOnTarget

Returns

Type	Description
UObject *

GetFocusedPokeTarget(FVector &OutClosestPointOnTarget)

Returns currently focused poke target or null if there is none.

Declaration

public: UObject * GetFocusedPokeTarget(FVector &OutClosestPointOnTarget) const

Parameters

Type	Name	Description
FVector &	OutClosestPointOnTarget

Returns

Type	Description
UObject *

GetFocusTarget()

Declaration

public: virtual UObject * GetFocusTarget() const override

Returns

Type	Description
UObject *

GetGrabPointerTransform()

Declaration

public: FTransform GetGrabPointerTransform() const

Returns

Type	Description
FTransform

GetIsPoking()

Declaration

public: bool GetIsPoking() const

Returns

Type	Description
bool

GetPokePointerRadius()

Declaration

public: float GetPokePointerRadius() const

Returns

Type	Description
float

GetPokePointerTransform()

Declaration

public: FTransform GetPokePointerTransform() const

Returns

Type	Description
FTransform

IsGrabbing()

Declaration

public: bool IsGrabbing() const

Returns

Type	Description
bool

SetActive(bool bNewActive, bool bReset=false)

Declaration

public: virtual void SetActive(bool bNewActive, bool bReset=false) override

Parameters

Type	Name	Description
bool	bNewActive
bool	bReset

SetFocusedGrabTarget(UActorComponent *NewFocusedTarget, bool bEnableFocusLock)

Set a focused grab target explicitly which will receive grasp events. If bEnableFocusLock is true, then the new focus target will be locked until released by calling SetFocusLocked.

Declaration

public: bool SetFocusedGrabTarget(UActorComponent *NewFocusedTarget, bool bEnableFocusLock)

Parameters

Type	Name	Description
UActorComponent *	NewFocusedTarget
bool	bEnableFocusLock

Returns

Type	Description
bool

SetFocusedPokeTarget(UActorComponent *NewFocusedTarget, bool bEnableFocusLock)

Set a focused poke target explicitly which will receive grasp events. If bEnableFocusLock is true, then the new focus target will be locked until released by calling SetFocusLocked.

Declaration

public: bool SetFocusedPokeTarget(UActorComponent *NewFocusedTarget, bool bEnableFocusLock)

Parameters

Type	Name	Description
UActorComponent *	NewFocusedTarget
bool	bEnableFocusLock

Returns

Type	Description
bool

TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction)

Declaration

public: virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override

Parameters

Type	Name	Description
float	DeltaTime
ELevelTick	TickType
FActorComponentTickFunction *	ThisTickFunction

UpdatePokeInteraction()

Update poke distances and detect if poking the target.

Declaration

public: void UpdatePokeInteraction()