godot-docs/classes/class_plane.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_Plane:

Plane
=====

**Category:** Built-In Types

Brief Description
-----------------

Plane in hessian form.

Member Functions
----------------

+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Plane<class_plane>`      | :ref:`Plane<class_Plane_Plane>`  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b, :ref:`float<class_float>` c, :ref:`float<class_float>` d  **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Plane<class_plane>`      | :ref:`Plane<class_Plane_Plane>`  **(** :ref:`Vector3<class_vector3>` v1, :ref:`Vector3<class_vector3>` v2, :ref:`Vector3<class_vector3>` v3  **)**               |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Plane<class_plane>`      | :ref:`Plane<class_Plane_Plane>`  **(** :ref:`Vector3<class_vector3>` normal, :ref:`float<class_float>` d  **)**                                                  |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`center<class_Plane_center>`  **(** **)**                                                                                                                   |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`distance_to<class_Plane_distance_to>`  **(** :ref:`Vector3<class_vector3>` point  **)**                                                                    |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`get_any_point<class_Plane_get_any_point>`  **(** **)**                                                                                                     |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`has_point<class_Plane_has_point>`  **(** :ref:`Vector3<class_vector3>` point, :ref:`float<class_float>` epsilon=0.00001  **)**                             |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`intersect_3<class_Plane_intersect_3>`  **(** :ref:`Plane<class_plane>` b, :ref:`Plane<class_plane>` c  **)**                                               |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`intersects_ray<class_Plane_intersects_ray>`  **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir  **)**                            |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`intersects_segment<class_Plane_intersects_segment>`  **(** :ref:`Vector3<class_vector3>` begin, :ref:`Vector3<class_vector3>` end  **)**                   |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_point_over<class_Plane_is_point_over>`  **(** :ref:`Vector3<class_vector3>` point  **)**                                                                |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Plane<class_plane>`      | :ref:`normalized<class_Plane_normalized>`  **(** **)**                                                                                                           |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`project<class_Plane_project>`  **(** :ref:`Vector3<class_vector3>` point  **)**                                                                            |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **d**
- :ref:`Vector3<class_vector3>` **normal**
- :ref:`float<class_float>` **x**
- :ref:`float<class_float>` **y**
- :ref:`float<class_float>` **z**

Description
-----------

Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.

Member Function Description
---------------------------

.. _class_Plane_Plane:

- :ref:`Plane<class_plane>`  **Plane**  **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b, :ref:`float<class_float>` c, :ref:`float<class_float>` d  **)**

Creates a plane from the three parameters "a", "b", "c" and "d".

.. _class_Plane_Plane:

- :ref:`Plane<class_plane>`  **Plane**  **(** :ref:`Vector3<class_vector3>` v1, :ref:`Vector3<class_vector3>` v2, :ref:`Vector3<class_vector3>` v3  **)**

Creates a plane from three points.

.. _class_Plane_Plane:

- :ref:`Plane<class_plane>`  **Plane**  **(** :ref:`Vector3<class_vector3>` normal, :ref:`float<class_float>` d  **)**

Creates a plane from the normal and the plane's distance to the origin.

.. _class_Plane_center:

- :ref:`Vector3<class_vector3>`  **center**  **(** **)**

Returns the center of the plane.

.. _class_Plane_distance_to:

- :ref:`float<class_float>`  **distance_to**  **(** :ref:`Vector3<class_vector3>` point  **)**

Returns the shortest distance from the plane to the position "point".

.. _class_Plane_get_any_point:

- :ref:`Vector3<class_vector3>`  **get_any_point**  **(** **)**

Returns a point on the plane.

.. _class_Plane_has_point:

- :ref:`bool<class_bool>`  **has_point**  **(** :ref:`Vector3<class_vector3>` point, :ref:`float<class_float>` epsilon=0.00001  **)**

Returns true if "point" is inside the plane (by a very minimum threshold).

.. _class_Plane_intersect_3:

- :ref:`Vector3<class_vector3>`  **intersect_3**  **(** :ref:`Plane<class_plane>` b, :ref:`Plane<class_plane>` c  **)**

Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned.

.. _class_Plane_intersects_ray:

- :ref:`Vector3<class_vector3>`  **intersects_ray**  **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir  **)**

Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned.

.. _class_Plane_intersects_segment:

- :ref:`Vector3<class_vector3>`  **intersects_segment**  **(** :ref:`Vector3<class_vector3>` begin, :ref:`Vector3<class_vector3>` end  **)**

Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned.

.. _class_Plane_is_point_over:

- :ref:`bool<class_bool>`  **is_point_over**  **(** :ref:`Vector3<class_vector3>` point  **)**

Returns true if "point" is located above the plane.

.. _class_Plane_normalized:

- :ref:`Plane<class_plane>`  **normalized**  **(** **)**

Returns a copy of the plane, normalized.

.. _class_Plane_project:

- :ref:`Vector3<class_vector3>`  **project**  **(** :ref:`Vector3<class_vector3>` point  **)**

Returns the orthogonal projection of point "p" into a point in the plane.