Show / Hide Table of Contents

    UUxtWidgetComponent

    Widget Component that is interactable with near and far interaction.

    class UUxtWidgetComponent;
    

    Header

    #include <Controls/UxtWidgetComponent.h>

    Inheritance

    Inherits from UActorComponent, IUxtPokeTarget, IUxtPokeHandler, IUxtFarTarget, IUxtFarHandler

    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 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

    Public Attributes

    Name
    int32 VirtualUserIndex

    Additional inherited members

    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)
    void OnBeginPoke(UUxtNearPointerComponent * Pointer)
    void OnUpdatePoke(UUxtNearPointerComponent * Pointer)
    void OnEndPoke(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)

    Protected Functions Documentation

    function BeginPlay

    virtual void BeginPlay() override
    

    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 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
    

    Public Attributes Documentation

    variable VirtualUserIndex

    int32 VirtualUserIndex = 0;
    

    Represents the Virtual User Index. Each virtual user should be represented by a different index number, this will maintain separate capture and focus states for them. Each controller or finger-tip should get a unique PointerIndex.


    Updated on 2 November 2021 at 11:40:26 Coordinated Universal Time

    • Improve this Doc
    Back to top Generated by DocFX