Intersects a ray with the plane.
This function sets enter
to the distance along the ray, where it intersects the plane.
If the ray is parallel to the plane, function returns false
and sets enter
to zero.
If the ray is pointing in the opposite direction than the plane, function returns false/
and sets enter
to the distance along the ray (negative value).
//This script detects mouse clicks on a plane using Plane.Raycast. //In this example, the plane is set to the Camera's x and y position, but you can set the z position so the plane is in front of your Camera. //The normal of the plane is set to facing forward so it is facing the Camera, but you can change this to suit your own needs.
//In your GameObject's Inspector, set your clickable distance and attach a cube GameObject in the appropriate fields
using UnityEngine;
public class PlaneRayExample : MonoBehaviour { //Attach a cube GameObject in the Inspector before entering Play Mode public GameObject m_Cube;
//This is the distance the clickable plane is from the camera. Set it in the Inspector before running. public float m_DistanceZ;
Plane m_Plane; Vector3 m_DistanceFromCamera;
void Start() { //This is how far away from the Camera the plane is placed m_DistanceFromCamera = new Vector3(Camera.main.transform.position.x, Camera.main.transform.position.y, Camera.main.transform.position.z - m_DistanceZ);
//Create a new plane with normal (0,0,1) at the position away from the camera you define in the Inspector. This is the plane that you can click so make sure it is reachable. m_Plane = new Plane(Vector3.forward, m_DistanceFromCamera); }
void Update() { //Detect when there is a mouse click if (Input.GetMouseButton(0)) { //Create a ray from the Mouse click position Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition);
//Initialise the enter variable float enter = 0.0f;
if (m_Plane.Raycast(ray, out enter)) { //Get the point that is clicked Vector3 hitPoint = ray.GetPoint(enter);
//Move your cube GameObject to the point where you clicked m_Cube.transform.position = hitPoint; } } } }
See Also: Physics.Raycast.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.