Class UUxtGrabTargetComponent

Interactable component that listens to grab events from near pointers.

A pointer that starts grabing while near the actor is considered a grabbing pointer. The grab is released when the pointer stops grabing, regardless of whether it is still near or not.

The GrabComponent does not react to grabbing pointers by itself, but serves as a base class for manipulation.

Inheritance

System::Object

USceneComponent

UUxtGrabTargetComponent

Inherited Members

IUxtFarTarget::IsFarFocusable(const UPrimitiveComponent *Primitive)

IUxtGrabTarget::IsGrabFocusable(const UPrimitiveComponent *Primitive)

IUxtGrabTarget::OnBeginGrab(UUxtNearPointerComponent *Pointer)

IUxtGrabTarget::OnEndGrab(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnEnterFarFocus(UUxtFarPointerComponent *Pointer)

IUxtGrabTarget::OnEnterGrabFocus(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnExitFarFocus(UUxtFarPointerComponent *Pointer)

IUxtGrabTarget::OnExitGrabFocus(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnFarDragged(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnFarPressed(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnFarReleased(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnUpdatedFarFocus(UUxtFarPointerComponent *Pointer)

IUxtGrabTarget::OnUpdateGrab(UUxtNearPointerComponent *Pointer)

IUxtGrabTarget::OnUpdateGrabFocus(UUxtNearPointerComponent *Pointer)

Namespace:

Assembly: .dll

Syntax

public: class UUxtGrabTargetComponent : public xtGrabTarget, public xtFarTarget

Constructors

| Improve this Doc View Source

UUxtGrabTargetComponent()

Declaration

public: UUxtGrabTargetComponent()

Fields

| Improve this Doc View Source

OnBeginGrab

Event raised when grab starts.

Declaration

public: FUxtBeginGrabDelegate OnBeginGrab

Field Value

Type	Description
FUxtBeginGrabDelegate

| Improve this Doc View Source

OnEndGrab

Event raised when grab ends.

Declaration

public: FUxtEndGrabDelegate OnEndGrab

Field Value

Type	Description
FUxtEndGrabDelegate

| Improve this Doc View Source

OnUpdateGrab

Event raised when grab updates.

Declaration

public: FUxtUpdateGrabDelegate OnUpdateGrab

Field Value

Type	Description
FUxtUpdateGrabDelegate

Methods

| Improve this Doc View Source

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

| Improve this Doc View Source

FindGrabPointer(UUxtNearPointerComponent NearPointer, UUxtFarPointerComponent FarPointer, bool &Success, FUxtGrabPointerData &PointerData, int &Index)

Returns true if the pointer is currently grabbing the actor. PointerData will contain the associated grab data for the pointer. Index is the order in which pointers started grabbing.

Declaration

public: void FindGrabPointer(UUxtNearPointerComponent *NearPointer, UUxtFarPointerComponent *FarPointer, bool &Success, FUxtGrabPointerData &PointerData, int &Index) const

Parameters

Type	Name	Description
UUxtNearPointerComponent *	NearPointer
UUxtFarPointerComponent *	FarPointer
bool &	Success
FUxtGrabPointerData &	PointerData
int &	Index

| Improve this Doc View Source

GetGrabPointCentroid(const FTransform &Transform)

Compute the centroid of the grab points in world space.

Declaration

public: FVector GetGrabPointCentroid(const FTransform &Transform) const

Parameters

Type	Name	Description
const FTransform &	Transform

Returns

Type	Description
FVector

| Improve this Doc View Source

GetGrabPointers()

Returns a list of all currently grabbing pointers.

Declaration

public: const TArray<FUxtGrabPointerData> & GetGrabPointers() const

Returns

Type	Description
const TArray<FUxtGrabPointerData> &

| Improve this Doc View Source

GetPointersTransformCentroid()

Compute the average transform of currently grabbing pointers

Declaration

protected: FTransform GetPointersTransformCentroid() const

Returns

Type	Description
FTransform

| Improve this Doc View Source

GetPrimaryGrabPointer(bool &Valid, FUxtGrabPointerData &PointerData)

Returns the first active grab pointer. If no pointer is grabbing the Valid output will be false.

Declaration

public: void GetPrimaryGrabPointer(bool &Valid, FUxtGrabPointerData &PointerData) const

Parameters

Type	Name	Description
bool &	Valid
FUxtGrabPointerData &	PointerData

| Improve this Doc View Source

GetSecondaryGrabPointer(bool &Valid, FUxtGrabPointerData &PointerData)

Returns the second active grab pointer. If less than two pointers are grabbing the Valid output will be false.

Declaration

public: void GetSecondaryGrabPointer(bool &Valid, FUxtGrabPointerData &PointerData) const

Parameters

Type	Name	Description
bool &	Valid
FUxtGrabPointerData &	PointerData

| Improve this Doc View Source

GetTargetCentroid()

Compute the centroid of the pointer targets in world space.

Declaration

public: FVector GetTargetCentroid() const

Returns

Type	Description
FVector

| Improve this Doc View Source

GetTickOnlyWhileGrabbed()

Declaration

public: bool GetTickOnlyWhileGrabbed() const

Returns

Type	Description
bool

| Improve this Doc View Source

IsFarFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration

protected: virtual bool IsFarFocusable_Implementation(const UPrimitiveComponent *Primitive) override

Parameters

Type	Name	Description
const UPrimitiveComponent *	Primitive

Returns

Type	Description
bool

| Improve this Doc View Source

IsGrabFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration

protected: virtual bool IsGrabFocusable_Implementation(const UPrimitiveComponent *Primitive) override

Parameters

Type	Name	Description
const UPrimitiveComponent *	Primitive

Returns

Type	Description
bool

| Improve this Doc View Source

OnBeginGrab_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnBeginGrab_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnEndGrab_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnEndGrab_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnFarDragged_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnFarDragged_Implementation(UUxtFarPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnFarPressed_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnFarPressed_Implementation(UUxtFarPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnFarReleased_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnFarReleased_Implementation(UUxtFarPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnUpdateGrab_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnUpdateGrab_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

SetTickOnlyWhileGrabbed(bool bEnable)

Declaration

public: void SetTickOnlyWhileGrabbed(bool bEnable)

Parameters

Type	Name	Description
bool	bEnable