Class UUxtTapToPlaceComponent

Tap to place is a control used to transform objects at a distance. The control allows you to select an object you wish to place using far interaction. After that, the object will be locked to your gaze and will be placed against surfaces and other objects. Any subsequent far release will end placement, even if the pointer is not pointing at the object being placed.

Inheritance

System::Object

UActorComponent

UUxtTapToPlaceComponent

Inherited Members

IUxtFarHandler::CanHandleFar(UPrimitiveComponent *Primitive)

IUxtFarTarget::IsFarFocusable(const UPrimitiveComponent *Primitive)

IUxtFarHandler::OnEnterFarFocus(UUxtFarPointerComponent *Pointer)

IUxtFarHandler::OnExitFarFocus(UUxtFarPointerComponent *Pointer)

IUxtFarHandler::OnFarDragged(UUxtFarPointerComponent *Pointer)

IUxtFarHandler::OnFarPressed(UUxtFarPointerComponent *Pointer)

IUxtFarHandler::OnFarReleased(UUxtFarPointerComponent *Pointer)

IUxtFarHandler::OnUpdatedFarFocus(UUxtFarPointerComponent *Pointer)

Namespace:

Assembly: .dll

Syntax

public: class UUxtTapToPlaceComponent : public xtFarTarget, public xtFarHandler

Constructors

| Improve this Doc View Source

UUxtTapToPlaceComponent()

Declaration

public: UUxtTapToPlaceComponent()

Fields

| Improve this Doc View Source

bInterpolatePose

Option to ignore interpolation between follow poses

Declaration

public: bool bInterpolatePose= true

Field Value

Type	Description
bool

| Improve this Doc View Source

DefaultPlacementDistance

Distance to place the object at if no obstructing surface.

Declaration

public: float DefaultPlacementDistance= 150

Field Value

Type	Description
float

| Improve this Doc View Source

KeepOrientationVertical

Whether the orientation of the object should pitch or roll.

Declaration

public: bool KeepOrientationVertical= false

Field Value

Type	Description
bool

| Improve this Doc View Source

LerpTime

Rate at which its owner will move toward default distance when angular leashing

Declaration

public: float LerpTime= 0.1f

Field Value

Type	Description
float

| Improve this Doc View Source

MaxRaycastDistance

Max distance to cast to when checking for obstructing surfaces.

Declaration

public: float MaxRaycastDistance= 2000

Field Value

Type	Description
float

| Improve this Doc View Source

OnBeginFocus

Event raised when a pointer starts focusing the placeable object. bWasAlreadyFocused indicates if the object was already focused by another pointer.

Declaration

public: FUxtTapToPlaceBeginFocusDelegate OnBeginFocus

Field Value

Type	Description
FUxtTapToPlaceBeginFocusDelegate

| Improve this Doc View Source

OnBeginPlacing

Event raised when a placeable object is selected.

Declaration

public: FUxtTapToPlaceBeginPlacingDelegate OnBeginPlacing

Field Value

Type	Description
FUxtTapToPlaceBeginPlacingDelegate

| Improve this Doc View Source

OnEndFocus

Event raised when a pointer ends focusing the placeable object. bIsStillFocused indicates if the object is still focused by another pointer.

Declaration

public: FUxtTapToPlaceEndFocusDelegate OnEndFocus

Field Value

Type	Description
FUxtTapToPlaceEndFocusDelegate

| Improve this Doc View Source

OnEndPlacing

Event raised when a placeable object is deselected and placed.

Declaration

public: FUxtTapToPlaceEndPlacingDelegate OnEndPlacing

Field Value

Type	Description
FUxtTapToPlaceEndPlacingDelegate

| Improve this Doc View Source

OnUpdateFocus

Event raised when a focusing pointer updates.

Declaration

public: FUxtTapToPlaceUpdateFocusDelegate OnUpdateFocus

Field Value

Type	Description
FUxtTapToPlaceUpdateFocusDelegate

| Improve this Doc View Source

OrientationType

How the object is oriented against hit surfaces.

Declaration

public: TEnumAsByte<EUxtTapToPlaceOrientBehavior> OrientationType= EUxtTapToPlaceOrientBehavior::AlignToSurface

Field Value

Type	Description
TEnumAsByte<EUxtTapToPlaceOrientBehavior>

| Improve this Doc View Source

PlacementType

How the target should be placed, using head or far pointer.

Declaration

public: TEnumAsByte<EUxtTapToPlaceMode> PlacementType= EUxtTapToPlaceMode::Head

Field Value

Type	Description
TEnumAsByte<EUxtTapToPlaceMode>

| Improve this Doc View Source

TraceChannel

Trace channel for raycast.

Declaration

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

Field Value

Type	Description
TEnumAsByte<ECollisionChannel>

Methods

| Improve this Doc View Source

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

| Improve this Doc View Source

CanHandleFar_Implementation(UPrimitiveComponent *Primitive)

Declaration

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

Parameters

Type	Name	Description
UPrimitiveComponent *	Primitive

Returns

Type	Description
bool

| Improve this Doc View Source

EndPlacement()

End placement of the target component.

Declaration

public: void EndPlacement()

| Improve this Doc View Source

EndPlay(const EEndPlayReason::Type EndPlayReason)

Declaration

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

Parameters

Type	Name	Description
const EEndPlayReason::Type	EndPlayReason

| Improve this Doc View Source

GetTargetComponent()

Get the component to transform.

Declaration

public: UPrimitiveComponent * GetTargetComponent() const

Returns

Type	Description
UPrimitiveComponent *

| Improve this Doc View Source

IsFarFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration

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

Parameters

Type	Name	Description
const UPrimitiveComponent *	Primitive

Returns

Type	Description
bool

| Improve this Doc View Source

OnEnterFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnEnterFarFocus_Implementation(UUxtFarPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

OnExitFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnExitFarFocus_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

OnUpdatedFarFocus_Implementation(UUxtFarPointerComponent *Pointer)

Declaration

protected: virtual void OnUpdatedFarFocus_Implementation(UUxtFarPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtFarPointerComponent *	Pointer

| Improve this Doc View Source

SetTargetComponent(UPrimitiveComponent *Target)

Set the component to transform.

Declaration

public: void SetTargetComponent(UPrimitiveComponent *Target)

Parameters

Type	Name	Description
UPrimitiveComponent *	Target

| Improve this Doc View Source

StartPlacement()

Start placement of the target component.

Declaration

public: void StartPlacement()

| Improve this Doc View Source

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

Declaration

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

Parameters

Type	Name	Description
float	DeltaTime
ELevelTick	TickType
FActorComponentTickFunction *	ThisTickFunction