mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InputRayUtils

    Utilities for accessing position, rotation of rays.

    Inheritance
    Object
    InputRayUtils
    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 static class InputRayUtils

    Methods

    GetHeadGazeRay()

    Gets the ray representing the position and direction of the user's head.

    Declaration
    public static Ray GetHeadGazeRay()
    Returns
    Type Description
    Ray

    The ray the head gaze

    GetHeadGazeRay()

    Gets the ray representing the position and direction of the user's head.

    Declaration
    public static Ray GetHeadGazeRay()
    Returns
    Type Description
    Ray

    The ray the head gaze

    TryGetEyeGazeRay(out Ray)

    Gets the ray representing the position and direction of the user's eyes.

    Declaration
    public static bool TryGetEyeGazeRay(out Ray ray)
    Parameters
    Type Name Description
    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetEyeGazeRay(out Ray)

    Gets the ray representing the position and direction of the user's eyes.

    Declaration
    public static bool TryGetEyeGazeRay(out Ray ray)
    Parameters
    Type Name Description
    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetHandRay(Handedness, out Ray)

    Gets the ray associated with the user's hand.

    Declaration
    public static bool TryGetHandRay(Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    Handedness hand

    The handedness of the hand

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetHandRay(Handedness, out Ray)

    Gets the ray associated with the user's hand.

    Declaration
    public static bool TryGetHandRay(Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    Handedness hand

    The handedness of the hand

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetMotionControllerRay(Handedness, out Ray)

    Gets the ray associated with the motion controller.

    Declaration
    public static bool TryGetMotionControllerRay(Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    Handedness hand

    The handedness of the motion controller

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetMotionControllerRay(Handedness, out Ray)

    Gets the ray associated with the motion controller.

    Declaration
    public static bool TryGetMotionControllerRay(Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    Handedness hand

    The handedness of the motion controller

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetRay(InputSourceType, Handedness, out Ray)

    Gets the ray associated with the desired input source type and hand.

    Declaration
    public static bool TryGetRay(InputSourceType sourceType, Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    InputSourceType sourceType

    The type of input source

    Handedness hand

    The handedness of the input source

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    TryGetRay(InputSourceType, Handedness, out Ray)

    Gets the ray associated with the desired input source type and hand.

    Declaration
    public static bool TryGetRay(InputSourceType sourceType, Handedness hand, out Ray ray)
    Parameters
    Type Name Description
    InputSourceType sourceType

    The type of input source

    Handedness hand

    The handedness of the input source

    Ray ray

    The ray being returned

    Returns
    Type Description
    Boolean

    True if the ray is being returned, false otherwise.

    In This Article
    • Methods
      • GetHeadGazeRay()
      • GetHeadGazeRay()
      • TryGetEyeGazeRay(out Ray)
      • TryGetEyeGazeRay(out Ray)
      • TryGetHandRay(Handedness, out Ray)
      • TryGetHandRay(Handedness, out Ray)
      • TryGetMotionControllerRay(Handedness, out Ray)
      • TryGetMotionControllerRay(Handedness, out Ray)
      • TryGetRay(InputSourceType, Handedness, out Ray)
      • TryGetRay(InputSourceType, Handedness, out Ray)
    Back to top Generated by DocFX