mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class MouseRotationProvider

    Utility class to manage toggling of mouse rotation and associated features, such as cursor visibility/locking

    Inheritance
    Object
    MouseRotationProvider
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class MouseRotationProvider

    Properties

    IsRotating

    True when rotation is currently active.

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

    IsRotating

    True when rotation is currently active.

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

    Methods

    Update(KeyBinding, KeyBinding, Boolean)

    Start or stop rotation based on the key binding.

    Declaration
    public void Update(KeyBinding rotationKey, KeyBinding cancelRotationKey, bool toggle)
    Parameters
    Type Name Description
    KeyBinding rotationKey
    KeyBinding cancelRotationKey
    Boolean toggle
    Remarks

    Also manages shared features such as cursor visibility that can be activated by different rotation providers.

    Update(KeyBinding, KeyBinding, Boolean)

    Start or stop rotation based on the key binding.

    Declaration
    public void Update(KeyBinding rotationKey, KeyBinding cancelRotationKey, bool toggle)
    Parameters
    Type Name Description
    KeyBinding rotationKey
    KeyBinding cancelRotationKey
    Boolean toggle
    Remarks

    Also manages shared features such as cursor visibility that can be activated by different rotation providers.

    In This Article
    • Properties
      • IsRotating
      • IsRotating
    • Methods
      • Update(KeyBinding, KeyBinding, Boolean)
      • Update(KeyBinding, KeyBinding, Boolean)
    Back to top Generated by DocFX