mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class CursorModifier

    Component that can be added to any GameObject with a Collider to modify the IMixedRealityCursor reacts when focused by a IMixedRealityPointer.

    Inheritance
    Object
    CursorModifier
    Implements
    ICursorModifier
    IMixedRealityFocusChangedHandler
    IEventSystemHandler
    MonoBehaviour
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class CursorModifier : MonoBehaviour, ICursorModifier, IMixedRealityFocusChangedHandler, IEventSystemHandler, MonoBehaviour

    Properties

    CursorNormalOffset

    Declaration
    public Vector3 CursorNormalOffset { get; set; }
    Property Value
    Type Description
    Vector3

    CursorNormalOffset

    Declaration
    public Vector3 CursorNormalOffset { get; set; }
    Property Value
    Type Description
    Vector3

    CursorParameters

    Declaration
    public AnimatorParameter[] CursorParameters { get; }
    Property Value
    Type Description
    AnimatorParameter[]

    CursorParameters

    Declaration
    public AnimatorParameter[] CursorParameters { get; }
    Property Value
    Type Description
    AnimatorParameter[]

    CursorPositionOffset

    Declaration
    public Vector3 CursorPositionOffset { get; set; }
    Property Value
    Type Description
    Vector3

    CursorPositionOffset

    Declaration
    public Vector3 CursorPositionOffset { get; set; }
    Property Value
    Type Description
    Vector3

    CursorScaleOffset

    Declaration
    public Vector3 CursorScaleOffset { get; set; }
    Property Value
    Type Description
    Vector3

    CursorScaleOffset

    Declaration
    public Vector3 CursorScaleOffset { get; set; }
    Property Value
    Type Description
    Vector3

    HideCursorOnFocus

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

    HideCursorOnFocus

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

    HostTransform

    Declaration
    public Transform HostTransform { get; set; }
    Property Value
    Type Description
    Transform

    HostTransform

    Declaration
    public Transform HostTransform { get; set; }
    Property Value
    Type Description
    Transform

    SnapCursorPosition

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

    SnapCursorPosition

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

    UseGazeBasedNormal

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

    UseGazeBasedNormal

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

    Methods

    GetCursorVisibility()

    Declaration
    public bool GetCursorVisibility()
    Returns
    Type Description
    Boolean

    GetCursorVisibility()

    Declaration
    public bool GetCursorVisibility()
    Returns
    Type Description
    Boolean

    GetModifiedPosition(IMixedRealityCursor)

    Declaration
    public Vector3 GetModifiedPosition(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Vector3

    GetModifiedPosition(IMixedRealityCursor)

    Declaration
    public Vector3 GetModifiedPosition(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Vector3

    GetModifiedRotation(IMixedRealityCursor)

    Declaration
    public Quaternion GetModifiedRotation(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Quaternion

    GetModifiedRotation(IMixedRealityCursor)

    Declaration
    public Quaternion GetModifiedRotation(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Quaternion

    GetModifiedScale(IMixedRealityCursor)

    Declaration
    public Vector3 GetModifiedScale(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Vector3

    GetModifiedScale(IMixedRealityCursor)

    Declaration
    public Vector3 GetModifiedScale(IMixedRealityCursor cursor)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Returns
    Type Description
    Vector3

    GetModifiedTransform(IMixedRealityCursor, out Vector3, out Quaternion, out Vector3)

    Declaration
    public void GetModifiedTransform(IMixedRealityCursor cursor, out Vector3 position, out Quaternion rotation, out Vector3 scale)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Vector3 position
    Quaternion rotation
    Vector3 scale

    GetModifiedTransform(IMixedRealityCursor, out Vector3, out Quaternion, out Vector3)

    Declaration
    public void GetModifiedTransform(IMixedRealityCursor cursor, out Vector3 position, out Quaternion rotation, out Vector3 scale)
    Parameters
    Type Name Description
    IMixedRealityCursor cursor
    Vector3 position
    Quaternion rotation
    Vector3 scale

    Explicit Interface Implementations

    IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData)

    Declaration
    void IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData eventData)
    Parameters
    Type Name Description
    FocusEventData eventData

    IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData)

    Declaration
    void IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData eventData)
    Parameters
    Type Name Description
    FocusEventData eventData

    IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData)

    Declaration
    void IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData eventData)
    Parameters
    Type Name Description
    FocusEventData eventData

    IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData)

    Declaration
    void IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData eventData)
    Parameters
    Type Name Description
    FocusEventData eventData

    Implements

    ICursorModifier
    IMixedRealityFocusChangedHandler
    IEventSystemHandler
    MonoBehaviour
    In This Article
    • Properties
      • CursorNormalOffset
      • CursorNormalOffset
      • CursorParameters
      • CursorParameters
      • CursorPositionOffset
      • CursorPositionOffset
      • CursorScaleOffset
      • CursorScaleOffset
      • HideCursorOnFocus
      • HideCursorOnFocus
      • HostTransform
      • HostTransform
      • SnapCursorPosition
      • SnapCursorPosition
      • UseGazeBasedNormal
      • UseGazeBasedNormal
    • Methods
      • GetCursorVisibility()
      • GetCursorVisibility()
      • GetModifiedPosition(IMixedRealityCursor)
      • GetModifiedPosition(IMixedRealityCursor)
      • GetModifiedRotation(IMixedRealityCursor)
      • GetModifiedRotation(IMixedRealityCursor)
      • GetModifiedScale(IMixedRealityCursor)
      • GetModifiedScale(IMixedRealityCursor)
      • GetModifiedTransform(IMixedRealityCursor, out Vector3, out Quaternion, out Vector3)
      • GetModifiedTransform(IMixedRealityCursor, out Vector3, out Quaternion, out Vector3)
    • Explicit Interface Implementations
      • IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData)
      • IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData)
      • IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData)
      • IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData)
    • Implements
    Back to top Generated by DocFX