mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Interface ICursorModifier

    Interface for cursor modifiers that can modify a GameObject's properties.

    Inherited Members
    IMixedRealityFocusChangedHandler.OnBeforeFocusChange(FocusEventData)
    IMixedRealityFocusChangedHandler.OnFocusChanged(FocusEventData)
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public interface ICursorModifier : IMixedRealityFocusChangedHandler, IEventSystemHandler

    Properties

    CursorNormalOffset

    Direction of the IMixedRealityCursor offset.

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

    CursorNormalOffset

    Direction of the IMixedRealityCursor offset.

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

    CursorParameters

    IMixedRealityCursor animation parameters to set when this GameObject is focused. Leave empty for none.

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

    CursorParameters

    IMixedRealityCursor animation parameters to set when this GameObject is focused. Leave empty for none.

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

    CursorPositionOffset

    How much a IMixedRealityCursor's position should be offset from the surface of the GameObject when overlapping.

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

    CursorPositionOffset

    How much a IMixedRealityCursor's position should be offset from the surface of the GameObject when overlapping.

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

    CursorScaleOffset

    Scale of the IMixedRealityCursor when looking at this GameObject.

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

    CursorScaleOffset

    Scale of the IMixedRealityCursor when looking at this GameObject.

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

    HideCursorOnFocus

    Should the IMixedRealityCursor be hidden when this GameObject is focused?

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

    HideCursorOnFocus

    Should the IMixedRealityCursor be hidden when this GameObject is focused?

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

    HostTransform

    Transform for which this IMixedRealityCursor modifies applies its various properties.

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

    HostTransform

    Transform for which this IMixedRealityCursor modifies applies its various properties.

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

    SnapCursorPosition

    Should the IMixedRealityCursor snap to the GameObject's position?

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

    SnapCursorPosition

    Should the IMixedRealityCursor snap to the GameObject's position?

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

    UseGazeBasedNormal

    If true, the normal from the pointing vector will be used to orient the IMixedRealityCursor instead of the targeted GameObject's normal at point of contact.

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

    UseGazeBasedNormal

    If true, the normal from the pointing vector will be used to orient the IMixedRealityCursor instead of the targeted GameObject's normal at point of contact.

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

    Methods

    GetCursorVisibility()

    Indicates whether the IMixedRealityCursor should be visible or not.

    Declaration
    bool GetCursorVisibility()
    Returns
    Type Description
    Boolean

    True if IMixedRealityCursor should be visible, false if not.

    GetCursorVisibility()

    Indicates whether the IMixedRealityCursor should be visible or not.

    Declaration
    bool GetCursorVisibility()
    Returns
    Type Description
    Boolean

    True if IMixedRealityCursor should be visible, false if not.

    GetModifiedPosition(IMixedRealityCursor)

    Returns the IMixedRealityCursor position after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Vector3

    New position for the IMixedRealityCursor

    GetModifiedPosition(IMixedRealityCursor)

    Returns the IMixedRealityCursor position after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Vector3

    New position for the IMixedRealityCursor

    GetModifiedRotation(IMixedRealityCursor)

    Returns the IMixedRealityCursor rotation after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Quaternion

    New rotation for the IMixedRealityCursor

    GetModifiedRotation(IMixedRealityCursor)

    Returns the IMixedRealityCursor rotation after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Quaternion

    New rotation for the IMixedRealityCursor

    GetModifiedScale(IMixedRealityCursor)

    Returns the IMixedRealityCursor's local scale after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Vector3

    New local scale for the IMixedRealityCursor

    GetModifiedScale(IMixedRealityCursor)

    Returns the IMixedRealityCursor's local scale after considering this modifier.

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

    IMixedRealityCursor that is being modified.

    Returns
    Type Description
    Vector3

    New local scale for the IMixedRealityCursor

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

    Returns the modified Transform for the IMixedRealityCursor after considering this modifier.

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

    Cursor that is being modified.

    Vector3 position

    Modified position.

    Quaternion rotation

    Modified rotation.

    Vector3 scale

    Modified scale.

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

    Returns the modified Transform for the IMixedRealityCursor after considering this modifier.

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

    Cursor that is being modified.

    Vector3 position

    Modified position.

    Quaternion rotation

    Modified rotation.

    Vector3 scale

    Modified scale.

    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)
    Back to top Generated by DocFX