UUxtTouchableVolumeComponent
Component that turns the actor it is attached to into a touchable volume.
class UUxtTouchableVolumeComponent;
Header
#include <Controls/UxtTouchableVolumeComponent.h>
Inheritance
Inherits from UUxtUIElementComponent, IUxtPokeTarget, IUxtPokeHandler, IUxtFarTarget, IUxtFarHandler, USceneComponent
Public Functions
| Name | |
|---|---|
| void | SetEnabled(bool Enabled) |
Protected Functions
| Name | |
|---|---|
| virtual void | BeginPlay() override |
| virtual bool | IsPokeFocusable_Implementation(const UPrimitiveComponent * Primitive) const override |
| virtual EUxtPokeBehaviour | GetPokeBehaviour_Implementation() const override |
| virtual bool | GetClosestPoint_Implementation(const UPrimitiveComponent * Primitive, const FVector & Point, FVector & OutClosestPoint, FVector & OutNormal) const override |
| virtual bool | CanHandlePoke_Implementation(UPrimitiveComponent * Primitive) const override |
| virtual void | OnEnterPokeFocus_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual void | OnUpdatePokeFocus_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual void | OnExitPokeFocus_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual void | OnBeginPoke_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual void | OnUpdatePoke_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual void | OnEndPoke_Implementation(UUxtNearPointerComponent * Pointer) override |
| virtual bool | IsFarFocusable_Implementation(const UPrimitiveComponent * Primitive) const override |
| virtual bool | CanHandleFar_Implementation(UPrimitiveComponent * Primitive) const override |
| virtual void | OnEnterFarFocus_Implementation(UUxtFarPointerComponent * Pointer) override |
| virtual void | OnUpdatedFarFocus_Implementation(UUxtFarPointerComponent * Pointer) override |
| virtual void | OnExitFarFocus_Implementation(UUxtFarPointerComponent * Pointer) override |
| virtual void | OnFarPressed_Implementation(UUxtFarPointerComponent * Pointer) override |
| virtual void | OnFarReleased_Implementation(UUxtFarPointerComponent * Pointer) override |
| void | OnInputTouchBeginHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent * TouchedComponent) |
| void | OnInputTouchEndHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent * TouchedComponent) |
| void | OnInputTouchLeaveHandler(ETouchIndex::Type FingerIndex, UPrimitiveComponent * TouchedComponent) |
Public Attributes
| Name | |
|---|---|
| int32 | InteractionMode |
| bool | bLockFocus |
| TSet< UPrimitiveComponent * > | TouchablePrimitives |
| FUxtVolumeBeginFocusDelegate | OnBeginFocus |
| FUxtVolumeUpdateFocusDelegate | OnUpdateFocus |
| FUxtVolumeEndFocusDelegate | OnEndFocus |
| FUxtVolumeBeginPokeDelegate | OnBeginPoke |
| FUxtVolumeUpdatePokeDelegate | OnUpdatePoke |
| FUxtVolumeEndPokeDelegate | OnEndPoke |
| FUxtVolumeEnabledDelegate | OnVolumeEnabled |
| FUxtVolumeDisabledDelegate | OnVolumeDisabled |
Additional inherited members
Public Functions inherited from UUxtUIElementComponent
| Name | |
|---|---|
| UUxtUIElementComponent() =default | |
| EUxtUIElementVisibility | GetUIVisibilitySelf() const |
| EUxtUIElementVisibility | GetUIVisibilityInHierarchy() const |
| void | SetUIVisibility(EUxtUIElementVisibility NewVisibility) |
| void | RefreshUIElement() |
Protected Functions inherited from UUxtUIElementComponent
| Name | |
|---|---|
| virtual void | OnAttachmentChanged() override |
Public Attributes inherited from UUxtUIElementComponent
| Name | |
|---|---|
| FUxtUIElementShowDelegate | OnShowElement |
| FUxtUIElementHideDelegate | OnHideElement |
Public Functions inherited from IUxtPokeTarget
| Name | |
|---|---|
| bool | IsPokeFocusable(const UPrimitiveComponent * Primitive) const |
| EUxtPokeBehaviour | GetPokeBehaviour() const |
| bool | GetClosestPoint(const UPrimitiveComponent * Primitive, const FVector & Point, FVector & OutClosestPoint, FVector & OutNormal) const |
Public Functions inherited from IUxtPokeHandler
| Name | |
|---|---|
| bool | CanHandlePoke(UPrimitiveComponent * Primitive) const |
| void | OnEnterPokeFocus(UUxtNearPointerComponent * Pointer) |
| void | OnUpdatePokeFocus(UUxtNearPointerComponent * Pointer) |
| void | OnExitPokeFocus(UUxtNearPointerComponent * Pointer) |
Public Functions inherited from IUxtFarTarget
| Name | |
|---|---|
| bool | IsFarFocusable(const UPrimitiveComponent * Primitive) const |
Public Functions inherited from IUxtFarHandler
| Name | |
|---|---|
| bool | CanHandleFar(UPrimitiveComponent * Primitive) const |
| void | OnEnterFarFocus(UUxtFarPointerComponent * Pointer) |
| void | OnUpdatedFarFocus(UUxtFarPointerComponent * Pointer) |
| void | OnExitFarFocus(UUxtFarPointerComponent * Pointer) |
| void | OnFarPressed(UUxtFarPointerComponent * Pointer) |
| void | OnFarDragged(UUxtFarPointerComponent * Pointer) |
| void | OnFarReleased(UUxtFarPointerComponent * Pointer) |
Public Functions Documentation
function SetEnabled
void SetEnabled(
bool Enabled
)
Set if the touchable volume is enabled
Protected Functions Documentation
function BeginPlay
virtual void BeginPlay() override
Reimplements: UUxtUIElementComponent::BeginPlay
function IsPokeFocusable_Implementation
virtual bool IsPokeFocusable_Implementation(
const UPrimitiveComponent * Primitive
) const override
function GetPokeBehaviour_Implementation
virtual EUxtPokeBehaviour GetPokeBehaviour_Implementation() const override
function GetClosestPoint_Implementation
virtual bool GetClosestPoint_Implementation(
const UPrimitiveComponent * Primitive,
const FVector & Point,
FVector & OutClosestPoint,
FVector & OutNormal
) const override
function CanHandlePoke_Implementation
virtual bool CanHandlePoke_Implementation(
UPrimitiveComponent * Primitive
) const override
function OnEnterPokeFocus_Implementation
virtual void OnEnterPokeFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnUpdatePokeFocus_Implementation
virtual void OnUpdatePokeFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnExitPokeFocus_Implementation
virtual void OnExitPokeFocus_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnBeginPoke_Implementation
virtual void OnBeginPoke_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnUpdatePoke_Implementation
virtual void OnUpdatePoke_Implementation(
UUxtNearPointerComponent * Pointer
) override
function OnEndPoke_Implementation
virtual void OnEndPoke_Implementation(
UUxtNearPointerComponent * Pointer
) override
function IsFarFocusable_Implementation
virtual bool IsFarFocusable_Implementation(
const UPrimitiveComponent * Primitive
) const override
function CanHandleFar_Implementation
virtual bool CanHandleFar_Implementation(
UPrimitiveComponent * Primitive
) const override
function OnEnterFarFocus_Implementation
virtual void OnEnterFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnUpdatedFarFocus_Implementation
virtual void OnUpdatedFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnExitFarFocus_Implementation
virtual void OnExitFarFocus_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnFarPressed_Implementation
virtual void OnFarPressed_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnFarReleased_Implementation
virtual void OnFarReleased_Implementation(
UUxtFarPointerComponent * Pointer
) override
function OnInputTouchBeginHandler
void OnInputTouchBeginHandler(
ETouchIndex::Type FingerIndex,
UPrimitiveComponent * TouchedComponent
)
function OnInputTouchEndHandler
void OnInputTouchEndHandler(
ETouchIndex::Type FingerIndex,
UPrimitiveComponent * TouchedComponent
)
function OnInputTouchLeaveHandler
void OnInputTouchLeaveHandler(
ETouchIndex::Type FingerIndex,
UPrimitiveComponent * TouchedComponent
)
Public Attributes Documentation
variable InteractionMode
int32 InteractionMode = static_cast<int32>(EUxtInteractionMode::Near | EUxtInteractionMode::Far);
Types of interaction the volume should respond to.
variable bLockFocus
bool bLockFocus = true;
Should the volume lock the pointer's focus when poked.
variable TouchablePrimitives
TSet< UPrimitiveComponent * > TouchablePrimitives;
List of primitives used as touchable targets. If the list is empty then all primitives of the actor are used.
variable OnBeginFocus
FUxtVolumeBeginFocusDelegate OnBeginFocus;
Event raised when a pointer starts focusing the touchable volume. WasFocused indicates if the volume was already focused by another pointer.
variable OnUpdateFocus
FUxtVolumeUpdateFocusDelegate OnUpdateFocus;
Event raised when a focusing pointer updates.
variable OnEndFocus
FUxtVolumeEndFocusDelegate OnEndFocus;
Event raised when a pointer ends focusing the touchable volume. IsFocused indicates if the volume is still focused by another pointer.
variable OnBeginPoke
FUxtVolumeBeginPokeDelegate OnBeginPoke;
Event raised when a pointer starts poking the touchable volume.
variable OnUpdatePoke
FUxtVolumeUpdatePokeDelegate OnUpdatePoke;
Event raised while a pointer is poking the touchable volume.
variable OnEndPoke
FUxtVolumeEndPokeDelegate OnEndPoke;
Event raised when a pointer ends poking the touchable volume.
variable OnVolumeEnabled
FUxtVolumeEnabledDelegate OnVolumeEnabled;
Event raised when the volume is enabled.
variable OnVolumeDisabled
FUxtVolumeDisabledDelegate OnVolumeDisabled;
Event raised when the volume is disabled.
Updated on 2 November 2021 at 11:40:26 Coordinated Universal Time