Show / Hide Table of Contents

    UUxtTouchBasedHandTrackerComponent

    Component added automatically by UXT to the player controller to enable driving far interactions via touch input. The hand tracker interface is used just to provide the pointer pose and grab/select states, GetJointState() returns that pointer pose for all joints.

    class UUxtTouchBasedHandTrackerComponent;
    

    Header

    #include <HandTracking/UxtTouchBasedHandTrackerComponent.h>

    Inheritance

    Inherits from UActorComponent, IUxtHandTracker

    Public Functions

    Name
    virtual ETrackingStatus GetTrackingStatus(EControllerHand Hand) const override
    virtual bool IsHandController(EControllerHand Hand) const override
    virtual bool GetJointState(EControllerHand Hand, EHandKeypoint Joint, FQuat & OutOrientation, FVector & OutPosition, float & OutRadius) const override
    virtual bool GetPointerPose(EControllerHand Hand, FQuat & OutOrientation, FVector & OutPosition) const override
    virtual bool GetGripPose(EControllerHand Hand, FQuat & OutOrientation, FVector & OutPosition) const override
    virtual bool GetIsGrabbing(EControllerHand Hand, bool & OutIsGrabbing) const override
    virtual bool GetIsSelectPressed(EControllerHand Hand, bool & OutIsSelectPressed) const override
    virtual void BeginPlay() override
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override

    Additional inherited members

    Public Functions inherited from IUxtHandTracker

    Name
    FName GetModularFeatureName()
    IUxtHandTracker & Get()
    virtual ~IUxtHandTracker()

    Public Functions Documentation

    function GetTrackingStatus

    virtual ETrackingStatus GetTrackingStatus(
        EControllerHand Hand
    ) const override
    

    Reimplements: IUxtHandTracker::GetTrackingStatus

    Get tracking status of the hand or motion controller.

    function IsHandController

    virtual bool IsHandController(
        EControllerHand Hand
    ) const override
    

    Reimplements: IUxtHandTracker::IsHandController

    True if the controller is a hand.

    function GetJointState

    virtual bool GetJointState(
        EControllerHand Hand,
        EHandKeypoint Joint,
        FQuat & OutOrientation,
        FVector & OutPosition,
        float & OutRadius
    ) const override
    

    Reimplements: IUxtHandTracker::GetJointState

    Obtain the state of the given joint. Returns false if the hand is not tracked this frame, in which case the values of the output parameters are unchanged.

    function GetPointerPose

    virtual bool GetPointerPose(
        EControllerHand Hand,
        FQuat & OutOrientation,
        FVector & OutPosition
    ) const override
    

    Reimplements: IUxtHandTracker::GetPointerPose

    Obtain the pointer pose. Returns false if the hand is not tracked this frame, in which case the value of the output parameter is unchanged.

    function GetGripPose

    virtual bool GetGripPose(
        EControllerHand Hand,
        FQuat & OutOrientation,
        FVector & OutPosition
    ) const override
    

    Reimplements: IUxtHandTracker::GetGripPose

    Grip pose following the controller. Returns false if the hand is not tracked this frame, in which case the value of the output parameter is unchanged.

    function GetIsGrabbing

    virtual bool GetIsGrabbing(
        EControllerHand Hand,
        bool & OutIsGrabbing
    ) const override
    

    Reimplements: IUxtHandTracker::GetIsGrabbing

    Obtain current grabbing state. Returns false if the hand is not tracked this frame, in which case the value of the output parameter is unchanged.

    function GetIsSelectPressed

    virtual bool GetIsSelectPressed(
        EControllerHand Hand,
        bool & OutIsSelectPressed
    ) const override
    

    Reimplements: IUxtHandTracker::GetIsSelectPressed

    Obtain current selection state. Returns false if the hand is not tracked this frame, in which case the value of the output parameter is unchanged.

    function BeginPlay

    virtual void BeginPlay() override
    

    function EndPlay

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

    Updated on 19 August 2021 at 17:42:52 Coordinated Universal Time

    • Improve this Doc
    Back to top Generated by DocFX