Class SnapTurnProvider | XR Interaction Toolkit | 0.0.6-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class SnapTurnProvider

    Inheritance
    Object
    LocomotionProvider
    SnapTurnProvider
    Inherited Members
    LocomotionProvider.system
    LocomotionProvider.CanBeginLocomotion()
    LocomotionProvider.BeginLocomotion()
    LocomotionProvider.EndLocomotion()
    LocomotionProvider.startLocomotion
    LocomotionProvider.endLocomotion
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public sealed class SnapTurnProvider : LocomotionProvider

    Properties

    deadZone

    The deadzone that the controller movement will have to be above to trigger a snap turn.

    Declaration
    public float deadZone { get; set; }
    Property Value
    Type Description
    Single

    debounceTime

    The amount of time that the system will wait before starting another snap turn.

    Declaration
    public float debounceTime { get; set; }
    Property Value
    Type Description
    Single

    enablePrimaryDevice

    If this is enabled, we will attempt to read data from the selected primary device.

    Declaration
    public bool enablePrimaryDevice { get; set; }
    Property Value
    Type Description
    Boolean

    enableSecondaryDevice

    If this is enabled, we will attempt to read data from the selected secondary device.

    Declaration
    public bool enableSecondaryDevice { get; set; }
    Property Value
    Type Description
    Boolean

    PrimaryDeviceNode

    The device node that will be used to locate the "Primary" controller device to use for snap turning.

    Declaration
    public XRNode PrimaryDeviceNode { get; set; }
    Property Value
    Type Description
    XRNode

    PrimaryDeviceTurnAxis

    The 2D Input Axis on the primary device that will be used to trigger a snap turn.

    Declaration
    public SnapTurnProvider.InputAxes PrimaryDeviceTurnAxis { get; set; }
    Property Value
    Type Description
    SnapTurnProvider.InputAxes

    SecondaryDeviceNode

    The device node that will be used to locate the "Secondary" controller device to use for snap turning.

    Declaration
    public XRNode SecondaryDeviceNode { get; set; }
    Property Value
    Type Description
    XRNode

    SecondaryDeviceTurnAxis

    The 2D Input Axis on the secondary device that will be used to trigger a snap turn.

    Declaration
    public SnapTurnProvider.InputAxes SecondaryDeviceTurnAxis { get; set; }
    Property Value
    Type Description
    SnapTurnProvider.InputAxes

    turnAmount

    The number of degrees clockwise to rotate when snap turning clockwise.

    Declaration
    public float turnAmount { get; set; }
    Property Value
    Type Description
    Single

    Methods

    Awake()

    Declaration
    protected override void Awake()
    Overrides
    LocomotionProvider.Awake()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023