Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

XRRaycastSubsystem.Raycast

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public method Raycast(screenPoint: Vector3, hitResults: List<XRRaycastHit>, trackableTypeMask: Experimental.XR.TrackableType): bool;
public bool Raycast(Vector3 screenPoint, List<XRRaycastHit> hitResults, Experimental.XR.TrackableType trackableTypeMask);

Parameters

screenPointThe screen point from which to cast.
hitResultsThe resulting list of XRRaycastHit.
trackableTypeMaskAn optional mask of TrackableType to raycast against.

Description

Casts a ray from a screen point against selected trackables (e.g., planes and feature points).

Casts a ray from a screen position against selected trackables in the scene. trackableTypeMask defaults to TrackableType.All.

#pragma strict
public class RaycastExample extends MonoBehaviour {
	public var xrRaycast: XRRaycast;
	private var m_RaycastHits: List.<XRRaycastHit> = new List.<XRRaycastHit>();
	function Update() {
		if (Input.GetMouseButton(0)) {
			// Only raycast against feature points and the exact plane boundries
			var hitMask: var = TrackableType.FeaturePoint | TrackableType.PlaneWithinPolygon;
			if (xrRaycast.Raycast(Input.mousePosition, m_RaycastHits, hitMask)) {
				Debug.Log("Hit something!");
			}
		}
	}
}
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Experimental.XR;
public class RaycastExample : MonoBehaviour
{
    public XRRaycast xrRaycast;
    private List<XRRaycastHit> m_RaycastHits = new List<XRRaycastHit>();
    void Update()
    {
        if (Input.GetMouseButton(0))
        {
            // Only raycast against feature points and the exact plane boundries
            var hitMask = TrackableType.FeaturePoint | TrackableType.PlaneWithinPolygon;
            if (xrRaycast.Raycast(Input.mousePosition, m_RaycastHits, hitMask))
            {
                Debug.Log("Hit something!");
            }
        }
    }
}

public static method Raycast(ray: Ray, depthSubsystem: Experimental.XR.XRDepthSubsystem, planeSubsystem: Experimental.XR.XRPlaneSubsystem, hitResults: List<XRRaycastHit>, trackableTypeMask: Experimental.XR.TrackableType, pointCloudRaycastAngleInDegrees: float): void;
public static void Raycast(Ray ray, Experimental.XR.XRDepthSubsystem depthSubsystem, Experimental.XR.XRPlaneSubsystem planeSubsystem, List<XRRaycastHit> hitResults, Experimental.XR.TrackableType trackableTypeMask, float pointCloudRaycastAngleInDegrees);

Parameters

rayThe Ray to use.
depthSubsystemThe XRDepthSubsystem to raycast against. May be null.
planeSubsystemThe XRPlaneSubsystem to raycast against. May be null.
hitResultsThe resulting list of XRRaycastHit.
trackableTypeMaskAn optional mask of TrackableType to raycast against.
pointCloudRaycastAngleInDegreesWhen raycasting against feature points, cast a cone with this angle.

Description

Casts a ray using ray against selected trackables (e.g., planes and feature points).

Use this method to raycast against selected trackables in the scene. trackableTypeMask defaults to TrackableType.All.

When raycasting against TrackableType.FeaturePoint, Unity uses a cone defined by pointCloudRaycastAngleInDegrees. It defaults to 5 degrees.

Did you find this page useful? Please give it a rating: