mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class MixedRealityRaycaster

    Inheritance
    Object
    MixedRealityRaycaster
    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.Physics
    Assembly: cs.temp.dll.dll
    Syntax
    public static class MixedRealityRaycaster

    Fields

    DebugEnabled

    Declaration
    public static bool DebugEnabled
    Field Value
    Type Description
    Boolean

    DebugEnabled

    Declaration
    public static bool DebugEnabled
    Field Value
    Type Description
    Boolean

    MaxRaycastHitCount

    Declaration
    public const int MaxRaycastHitCount = 32
    Field Value
    Type Description
    Int32

    MaxSphereCastHitCount

    Declaration
    public const int MaxSphereCastHitCount = 32
    Field Value
    Type Description
    Int32

    Methods

    RaycastBoxPhysicsStep(RayStep, Vector3, Vector3, Matrix4x4, Single, LayerMask[], Int32, Boolean, Boolean, out Vector3[], out Vector3[], out Boolean[])

    Box raycasts each physics RayStep.

    Declaration
    public static bool RaycastBoxPhysicsStep(RayStep step, Vector3 extents, Vector3 targetPosition, Matrix4x4 matrix, float maxDistance, LayerMask[] prioritizedLayerMasks, int raysPerEdge, bool isOrthographic, bool focusIndividualCompoundCollider, out Vector3[] points, out Vector3[] normals, out bool[] hits)
    Parameters
    Type Name Description
    RayStep step
    Vector3 extents
    Vector3 targetPosition
    Matrix4x4 matrix
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Int32 raysPerEdge
    Boolean isOrthographic
    Boolean focusIndividualCompoundCollider
    Vector3[] points
    Vector3[] normals
    Boolean[] hits
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastBoxPhysicsStep(RayStep, Vector3, Vector3, Matrix4x4, Single, LayerMask[], Int32, Boolean, Boolean, out Vector3[], out Vector3[], out Boolean[])

    Box raycasts each physics RayStep.

    Declaration
    public static bool RaycastBoxPhysicsStep(RayStep step, Vector3 extents, Vector3 targetPosition, Matrix4x4 matrix, float maxDistance, LayerMask[] prioritizedLayerMasks, int raysPerEdge, bool isOrthographic, bool focusIndividualCompoundCollider, out Vector3[] points, out Vector3[] normals, out bool[] hits)
    Parameters
    Type Name Description
    RayStep step
    Vector3 extents
    Vector3 targetPosition
    Matrix4x4 matrix
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Int32 raysPerEdge
    Boolean isOrthographic
    Boolean focusIndividualCompoundCollider
    Vector3[] points
    Vector3[] normals
    Boolean[] hits
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastPlanePhysicsStep(RayStep, Plane, out Vector3)

    Intersection test of ray step with given plane.

    Declaration
    public static bool RaycastPlanePhysicsStep(RayStep step, Plane plane, out Vector3 hitPoint)
    Parameters
    Type Name Description
    RayStep step
    Plane plane
    Vector3 hitPoint
    Returns
    Type Description
    Boolean

    Whether the ray step intersects the ray step.

    RaycastPlanePhysicsStep(RayStep, Plane, out Vector3)

    Intersection test of ray step with given plane.

    Declaration
    public static bool RaycastPlanePhysicsStep(RayStep step, Plane plane, out Vector3 hitPoint)
    Parameters
    Type Name Description
    RayStep step
    Plane plane
    Vector3 hitPoint
    Returns
    Type Description
    Boolean

    Whether the ray step intersects the ray step.

    RaycastSimplePhysicsStep(RayStep, LayerMask[], Boolean, out RaycastHit)

    Simple raycasts each physics RayStep.

    Declaration
    public static bool RaycastSimplePhysicsStep(RayStep step, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSimplePhysicsStep(RayStep, LayerMask[], Boolean, out RaycastHit)

    Simple raycasts each physics RayStep.

    Declaration
    public static bool RaycastSimplePhysicsStep(RayStep step, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSimplePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)

    Simple raycasts each physics RayStep within a specified maximum distance.

    Declaration
    public static bool RaycastSimplePhysicsStep(RayStep step, float maxDistance, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSimplePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)

    Simple raycasts each physics RayStep within a specified maximum distance.

    Declaration
    public static bool RaycastSimplePhysicsStep(RayStep step, float maxDistance, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSpherePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)

    Sphere raycasts each physics RayStep.

    Declaration
    public static bool RaycastSpherePhysicsStep(RayStep step, float radius, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single radius
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSpherePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)

    Sphere raycasts each physics RayStep.

    Declaration
    public static bool RaycastSpherePhysicsStep(RayStep step, float radius, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single radius
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSpherePhysicsStep(RayStep, Single, Single, LayerMask[], Boolean, out RaycastHit)

    Sphere raycasts each physics RayStep within a specified maximum distance.

    Declaration
    public static bool RaycastSpherePhysicsStep(RayStep step, float radius, float maxDistance, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single radius
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    RaycastSpherePhysicsStep(RayStep, Single, Single, LayerMask[], Boolean, out RaycastHit)

    Sphere raycasts each physics RayStep within a specified maximum distance.

    Declaration
    public static bool RaycastSpherePhysicsStep(RayStep step, float radius, float maxDistance, LayerMask[] prioritizedLayerMasks, bool focusIndividualCompoundCollider, out RaycastHit physicsHit)
    Parameters
    Type Name Description
    RayStep step
    Single radius
    Single maxDistance
    LayerMask[] prioritizedLayerMasks
    Boolean focusIndividualCompoundCollider
    RaycastHit physicsHit
    Returns
    Type Description
    Boolean

    Whether or not the raycast hit something.

    TryGetPrioritizedPhysicsHit(RaycastHit[], LayerMask[], Boolean, out RaycastHit)

    Tries to get the prioritized physics raycast hit based on the prioritized layer masks.

    Declaration
    public static bool TryGetPrioritizedPhysicsHit(RaycastHit[] hits, LayerMask[] priorityLayers, bool focusIndividualCompoundCollider, out RaycastHit raycastHit)
    Parameters
    Type Name Description
    RaycastHit[] hits
    LayerMask[] priorityLayers
    Boolean focusIndividualCompoundCollider
    RaycastHit raycastHit
    Returns
    Type Description
    Boolean

    The minimum distance hit within the first layer that has hits.

    Remarks

    Sorts all hit objects first by layerMask, then by distance.

    TryGetPrioritizedPhysicsHit(RaycastHit[], LayerMask[], Boolean, out RaycastHit)

    Tries to get the prioritized physics raycast hit based on the prioritized layer masks.

    Declaration
    public static bool TryGetPrioritizedPhysicsHit(RaycastHit[] hits, LayerMask[] priorityLayers, bool focusIndividualCompoundCollider, out RaycastHit raycastHit)
    Parameters
    Type Name Description
    RaycastHit[] hits
    LayerMask[] priorityLayers
    Boolean focusIndividualCompoundCollider
    RaycastHit raycastHit
    Returns
    Type Description
    Boolean

    The minimum distance hit within the first layer that has hits.

    Remarks

    Sorts all hit objects first by layerMask, then by distance.

    In This Article
    • Fields
      • DebugEnabled
      • DebugEnabled
      • MaxRaycastHitCount
      • MaxSphereCastHitCount
    • Methods
      • RaycastBoxPhysicsStep(RayStep, Vector3, Vector3, Matrix4x4, Single, LayerMask[], Int32, Boolean, Boolean, out Vector3[], out Vector3[], out Boolean[])
      • RaycastBoxPhysicsStep(RayStep, Vector3, Vector3, Matrix4x4, Single, LayerMask[], Int32, Boolean, Boolean, out Vector3[], out Vector3[], out Boolean[])
      • RaycastPlanePhysicsStep(RayStep, Plane, out Vector3)
      • RaycastPlanePhysicsStep(RayStep, Plane, out Vector3)
      • RaycastSimplePhysicsStep(RayStep, LayerMask[], Boolean, out RaycastHit)
      • RaycastSimplePhysicsStep(RayStep, LayerMask[], Boolean, out RaycastHit)
      • RaycastSimplePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)
      • RaycastSimplePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)
      • RaycastSpherePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)
      • RaycastSpherePhysicsStep(RayStep, Single, LayerMask[], Boolean, out RaycastHit)
      • RaycastSpherePhysicsStep(RayStep, Single, Single, LayerMask[], Boolean, out RaycastHit)
      • RaycastSpherePhysicsStep(RayStep, Single, Single, LayerMask[], Boolean, out RaycastHit)
      • TryGetPrioritizedPhysicsHit(RaycastHit[], LayerMask[], Boolean, out RaycastHit)
      • TryGetPrioritizedPhysicsHit(RaycastHit[], LayerMask[], Boolean, out RaycastHit)
    Back to top Generated by DocFX