Class UUxtTouchableVolumeComponent

Component that turns the actor it is attached to into a touchable volume.

Inheritance

System::Object

USceneComponent

UUxtTouchableVolumeComponent

Inherited Members

IUxtPokeTarget::GetPokeBehaviour()

IUxtFarTarget::IsFarFocusable(const UPrimitiveComponent *Primitive)

IUxtPokeTarget::IsPokeFocusable(const UPrimitiveComponent *Primitive)

IUxtPokeTarget::OnBeginPoke(UUxtNearPointerComponent *Pointer)

IUxtPokeTarget::OnEndPoke(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnEnterFarFocus(UUxtFarPointerComponent *Pointer)

IUxtPokeTarget::OnEnterPokeFocus(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnExitFarFocus(UUxtFarPointerComponent *Pointer)

IUxtPokeTarget::OnExitPokeFocus(UUxtNearPointerComponent *Pointer)

IUxtFarTarget::OnFarDragged(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnFarPressed(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnFarReleased(UUxtFarPointerComponent *Pointer)

IUxtFarTarget::OnUpdatedFarFocus(UUxtFarPointerComponent *Pointer)

IUxtPokeTarget::OnUpdatePoke(UUxtNearPointerComponent *Pointer)

IUxtPokeTarget::OnUpdatePokeFocus(UUxtNearPointerComponent *Pointer)

Namespace:

Assembly: .dll

Syntax

public: class UUxtTouchableVolumeComponent : public xtPokeTarget, public xtFarTarget

Fields

| Improve this Doc View Source

OnBeginFocus

Event raised when a pointer starts focusing the touchable volume. WasFocused indicates if the volume was already focused by another pointer.

Declaration

public: FUxtVolumeBeginFocusDelegate OnBeginFocus

Field Value

Type	Description
FUxtVolumeBeginFocusDelegate

| Improve this Doc View Source

OnBeginPoke

Event raised when a pointer starts poking the touchable volume.

Declaration

public: FUxtVolumeBeginPokeDelegate OnBeginPoke

Field Value

Type	Description
FUxtVolumeBeginPokeDelegate

| Improve this Doc View Source

OnEndFocus

Event raised when a pointer ends focusing the touchable volume. IsFocused indicates if the volume is still focused by another pointer.

Declaration

public: FUxtVolumeEndFocusDelegate OnEndFocus

Field Value

Type	Description
FUxtVolumeEndFocusDelegate

| Improve this Doc View Source

OnEndPoke

Event raised when a pointer ends poking the touchable volume.

Declaration

public: FUxtVolumeEndPokeDelegate OnEndPoke

Field Value

Type	Description
FUxtVolumeEndPokeDelegate

| Improve this Doc View Source

OnUpdateFocus

Event raised when a focusing pointer updates.

Declaration

public: FUxtVolumeUpdateFocusDelegate OnUpdateFocus

Field Value

Type	Description
FUxtVolumeUpdateFocusDelegate

| Improve this Doc View Source

OnUpdatePoke

Event raised while a pointer is poking the touchable volume.

Declaration

public: FUxtVolumeUpdatePokeDelegate OnUpdatePoke

Field Value

Type	Description
FUxtVolumeUpdatePokeDelegate

| Improve this Doc View Source

OnVolumeDisabled

Event raised when the volume is disabled.

Declaration

public: FUxtVolumeDisabledDelegate OnVolumeDisabled

Field Value

Type	Description
FUxtVolumeDisabledDelegate

| Improve this Doc View Source

OnVolumeEnabled

Event raised when the volume is enabled.

Declaration

public: FUxtVolumeEnabledDelegate OnVolumeEnabled

Field Value

Type	Description
FUxtVolumeEnabledDelegate

| Improve this Doc View Source

TouchablePrimitives

List of primitives used as touchable targets. If the list is empty then all primitives of the actor are used.

Declaration

public: TSet<UPrimitiveComponent *> TouchablePrimitives

Field Value

Type	Description
TSet<UPrimitiveComponent *>

Methods

| Improve this Doc View Source

BeginPlay()

Declaration

protected: virtual void BeginPlay() override

| Improve this Doc View Source

GetPokeBehaviour_Implementation()

Declaration

protected: virtual EUxtPokeBehaviour GetPokeBehaviour_Implementation() const override

Returns

Type	Description
EUxtPokeBehaviour

| 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

IsPokeFocusable_Implementation(const UPrimitiveComponent *Primitive)

Declaration

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

Parameters

Type	Name	Description
const UPrimitiveComponent *	Primitive

Returns

Type	Description
bool

| Improve this Doc View Source

OnBeginPoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnBeginPoke_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnEndPoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnEndPoke_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| 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

OnEnterPokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnEnterPokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	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

OnExitPokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnExitPokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	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

OnInputTouchBeginHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Declaration

protected: void OnInputTouchBeginHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Parameters

Type	Name	Description
ETouchIndex::Type	FingerIndex
UPrimitiveComponent *	TouchedComponent

| Improve this Doc View Source

OnInputTouchEndHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Declaration

protected: void OnInputTouchEndHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Parameters

Type	Name	Description
ETouchIndex::Type	FingerIndex
UPrimitiveComponent *	TouchedComponent

| Improve this Doc View Source

OnInputTouchLeaveHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Declaration

protected: void OnInputTouchLeaveHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent *TouchedComponent)

Parameters

Type	Name	Description
ETouchIndex::Type	FingerIndex
UPrimitiveComponent *	TouchedComponent

| 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

OnUpdatePoke_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnUpdatePoke_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

OnUpdatePokeFocus_Implementation(UUxtNearPointerComponent *Pointer)

Declaration

protected: virtual void OnUpdatePokeFocus_Implementation(UUxtNearPointerComponent *Pointer) override

Parameters

Type	Name	Description
UUxtNearPointerComponent *	Pointer

| Improve this Doc View Source

SetEnabled(bool Enabled)

Set if the touchable volume is enabled

Declaration

public: void SetEnabled(bool Enabled)

Parameters

Type	Name	Description
bool	Enabled