mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (2e7fc81)
This commit is contained in:
@@ -54,21 +54,21 @@ Constructors
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>` **(** **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>` **(** :ref:`Plane<class_Plane>` from **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_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_constructor_Plane>` **(** :ref:`Vector3<class_Vector3>` normal **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>` **(** :ref:`Vector3<class_Vector3>` normal, :ref:`float<class_float>` d **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>` **(** :ref:`Vector3<class_Vector3>` normal, :ref:`Vector3<class_Vector3>` point **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>` **(** :ref:`Vector3<class_Vector3>` point1, :ref:`Vector3<class_Vector3>` point2, :ref:`Vector3<class_Vector3>` point3 **)** |
|
||||
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ from\: :ref:`Plane<class_Plane>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ a\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`, c\: :ref:`float<class_float>`, d\: :ref:`float<class_float>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ normal\: :ref:`Vector3<class_Vector3>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ normal\: :ref:`Vector3<class_Vector3>`, d\: :ref:`float<class_float>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ normal\: :ref:`Vector3<class_Vector3>`, point\: :ref:`Vector3<class_Vector3>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`Plane<class_Plane_constructor_Plane>`\ (\ point1\: :ref:`Vector3<class_Vector3>`, point2\: :ref:`Vector3<class_Vector3>`, point3\: :ref:`Vector3<class_Vector3>`\ ) |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
@@ -78,29 +78,29 @@ Methods
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`distance_to<class_Plane_method_distance_to>` **(** :ref:`Vector3<class_Vector3>` point **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_center<class_Plane_method_get_center>` **(** **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_Plane_method_has_point>` **(** :ref:`Vector3<class_Vector3>` point, :ref:`float<class_float>` tolerance=1e-05 **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersect_3<class_Plane_method_intersect_3>` **(** :ref:`Plane<class_Plane>` b, :ref:`Plane<class_Plane>` c **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersects_ray<class_Plane_method_intersects_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` dir **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersects_segment<class_Plane_method_intersects_segment>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Plane_method_is_equal_approx>` **(** :ref:`Plane<class_Plane>` to_plane **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_finite<class_Plane_method_is_finite>` **(** **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_over<class_Plane_method_is_point_over>` **(** :ref:`Vector3<class_Vector3>` point **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`normalized<class_Plane_method_normalized>` **(** **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project<class_Plane_method_project>` **(** :ref:`Vector3<class_Vector3>` point **)** |const| |
|
||||
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`distance_to<class_Plane_method_distance_to>`\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`get_center<class_Plane_method_get_center>`\ (\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_Plane_method_has_point>`\ (\ point\: :ref:`Vector3<class_Vector3>`, tolerance\: :ref:`float<class_float>` = 1e-05\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersect_3<class_Plane_method_intersect_3>`\ (\ b\: :ref:`Plane<class_Plane>`, c\: :ref:`Plane<class_Plane>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersects_ray<class_Plane_method_intersects_ray>`\ (\ from\: :ref:`Vector3<class_Vector3>`, dir\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_Variant>` | :ref:`intersects_segment<class_Plane_method_intersects_segment>`\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Plane_method_is_equal_approx>`\ (\ to_plane\: :ref:`Plane<class_Plane>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_finite<class_Plane_method_is_finite>`\ (\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_point_over<class_Plane_method_is_point_over>`\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`normalized<class_Plane_method_normalized>`\ (\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`project<class_Plane_method_project>`\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||||
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
@@ -110,17 +110,17 @@ Operators
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Plane_operator_neq_Plane>` **(** :ref:`Plane<class_Plane>` right **)** |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator *<class_Plane_operator_mul_Transform3D>` **(** :ref:`Transform3D<class_Transform3D>` right **)** |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Plane_operator_eq_Plane>` **(** :ref:`Plane<class_Plane>` right **)** |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator unary+<class_Plane_operator_unplus>` **(** **)** |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator unary-<class_Plane_operator_unminus>` **(** **)** |
|
||||
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Plane_operator_neq_Plane>`\ (\ right\: :ref:`Plane<class_Plane>`\ ) |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator *<class_Plane_operator_mul_Transform3D>`\ (\ right\: :ref:`Transform3D<class_Transform3D>`\ ) |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Plane_operator_eq_Plane>`\ (\ right\: :ref:`Plane<class_Plane>`\ ) |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator unary+<class_Plane_operator_unplus>`\ (\ ) |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Plane<class_Plane>` | :ref:`operator unary-<class_Plane_operator_unminus>`\ (\ ) |
|
||||
+---------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
@@ -237,7 +237,7 @@ Constructor Descriptions
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ )
|
||||
|
||||
Constructs a default-initialized **Plane** with all components set to ``0``.
|
||||
|
||||
@@ -247,7 +247,7 @@ Constructs a default-initialized **Plane** with all components set to ``0``.
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** :ref:`Plane<class_Plane>` from **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ from\: :ref:`Plane<class_Plane>`\ )
|
||||
|
||||
Constructs a **Plane** as a copy of the given **Plane**.
|
||||
|
||||
@@ -257,7 +257,7 @@ Constructs a **Plane** as a copy of the given **Plane**.
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
: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>` **Plane**\ (\ a\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`, c\: :ref:`float<class_float>`, d\: :ref:`float<class_float>`\ )
|
||||
|
||||
Creates a plane from the four parameters. The three components of the resulting plane's :ref:`normal<class_Plane_property_normal>` are ``a``, ``b`` and ``c``, and the plane has a distance of ``d`` from the origin.
|
||||
|
||||
@@ -267,7 +267,7 @@ Creates a plane from the four parameters. The three components of the resulting
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** :ref:`Vector3<class_Vector3>` normal **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ normal\: :ref:`Vector3<class_Vector3>`\ )
|
||||
|
||||
Creates a plane from the normal vector. The plane will intersect the origin.
|
||||
|
||||
@@ -279,7 +279,7 @@ The ``normal`` of the plane must be a unit vector.
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** :ref:`Vector3<class_Vector3>` normal, :ref:`float<class_float>` d **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ normal\: :ref:`Vector3<class_Vector3>`, d\: :ref:`float<class_float>`\ )
|
||||
|
||||
Creates a plane from the normal vector and the plane's distance from the origin.
|
||||
|
||||
@@ -291,7 +291,7 @@ The ``normal`` of the plane must be a unit vector.
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** :ref:`Vector3<class_Vector3>` normal, :ref:`Vector3<class_Vector3>` point **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ normal\: :ref:`Vector3<class_Vector3>`, point\: :ref:`Vector3<class_Vector3>`\ )
|
||||
|
||||
Creates a plane from the normal vector and a point on the plane.
|
||||
|
||||
@@ -303,7 +303,7 @@ The ``normal`` of the plane must be a unit vector.
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`Plane<class_Plane>` **Plane** **(** :ref:`Vector3<class_Vector3>` point1, :ref:`Vector3<class_Vector3>` point2, :ref:`Vector3<class_Vector3>` point3 **)**
|
||||
:ref:`Plane<class_Plane>` **Plane**\ (\ point1\: :ref:`Vector3<class_Vector3>`, point2\: :ref:`Vector3<class_Vector3>`, point3\: :ref:`Vector3<class_Vector3>`\ )
|
||||
|
||||
Creates a plane from the three points, given in clockwise order.
|
||||
|
||||
@@ -320,7 +320,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`float<class_float>` **distance_to** **(** :ref:`Vector3<class_Vector3>` point **)** |const|
|
||||
:ref:`float<class_float>` **distance_to**\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
|
||||
Returns the shortest distance from the plane to the position ``point``. If the point is above the plane, the distance will be positive. If below, the distance will be negative.
|
||||
|
||||
@@ -332,7 +332,7 @@ Returns the shortest distance from the plane to the position ``point``. If the p
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Vector3<class_Vector3>` **get_center** **(** **)** |const|
|
||||
:ref:`Vector3<class_Vector3>` **get_center**\ (\ ) |const|
|
||||
|
||||
Returns the center of the plane.
|
||||
|
||||
@@ -344,7 +344,7 @@ Returns the center of the plane.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_Vector3>` point, :ref:`float<class_float>` tolerance=1e-05 **)** |const|
|
||||
:ref:`bool<class_bool>` **has_point**\ (\ point\: :ref:`Vector3<class_Vector3>`, tolerance\: :ref:`float<class_float>` = 1e-05\ ) |const|
|
||||
|
||||
Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom minimum ``tolerance`` threshold.
|
||||
|
||||
@@ -356,7 +356,7 @@ Returns ``true`` if ``point`` is inside the plane. Comparison uses a custom mini
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Variant<class_Variant>` **intersect_3** **(** :ref:`Plane<class_Plane>` b, :ref:`Plane<class_Plane>` c **)** |const|
|
||||
:ref:`Variant<class_Variant>` **intersect_3**\ (\ b\: :ref:`Plane<class_Plane>`, c\: :ref:`Plane<class_Plane>`\ ) |const|
|
||||
|
||||
Returns the intersection point of the three planes ``b``, ``c`` and this plane. If no intersection is found, ``null`` is returned.
|
||||
|
||||
@@ -368,7 +368,7 @@ Returns the intersection point of the three planes ``b``, ``c`` and this plane.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Variant<class_Variant>` **intersects_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` dir **)** |const|
|
||||
:ref:`Variant<class_Variant>` **intersects_ray**\ (\ from\: :ref:`Vector3<class_Vector3>`, dir\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
|
||||
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.
|
||||
|
||||
@@ -380,7 +380,7 @@ Returns the intersection point of a ray consisting of the position ``from`` and
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Variant<class_Variant>` **intersects_segment** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to **)** |const|
|
||||
:ref:`Variant<class_Variant>` **intersects_segment**\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
|
||||
Returns the intersection point of a segment from position ``from`` to position ``to`` with this plane. If no intersection is found, ``null`` is returned.
|
||||
|
||||
@@ -392,7 +392,7 @@ Returns the intersection point of a segment from position ``from`` to position `
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Plane<class_Plane>` to_plane **)** |const|
|
||||
:ref:`bool<class_bool>` **is_equal_approx**\ (\ to_plane\: :ref:`Plane<class_Plane>`\ ) |const|
|
||||
|
||||
Returns ``true`` if this plane and ``to_plane`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx<class_@GlobalScope_method_is_equal_approx>` on each component.
|
||||
|
||||
@@ -404,7 +404,7 @@ Returns ``true`` if this plane and ``to_plane`` are approximately equal, by runn
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_finite** **(** **)** |const|
|
||||
:ref:`bool<class_bool>` **is_finite**\ (\ ) |const|
|
||||
|
||||
Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finite<class_@GlobalScope_method_is_finite>` on each component.
|
||||
|
||||
@@ -416,7 +416,7 @@ Returns ``true`` if this plane is finite, by calling :ref:`@GlobalScope.is_finit
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_point_over** **(** :ref:`Vector3<class_Vector3>` point **)** |const|
|
||||
:ref:`bool<class_bool>` **is_point_over**\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
|
||||
Returns ``true`` if ``point`` is located above the plane.
|
||||
|
||||
@@ -428,7 +428,7 @@ Returns ``true`` if ``point`` is located above the plane.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Plane<class_Plane>` **normalized** **(** **)** |const|
|
||||
:ref:`Plane<class_Plane>` **normalized**\ (\ ) |const|
|
||||
|
||||
Returns a copy of the plane, with normalized :ref:`normal<class_Plane_property_normal>` (so it's a unit vector). Returns ``Plane(0, 0, 0, 0)`` if :ref:`normal<class_Plane_property_normal>` can't be normalized (it has zero length).
|
||||
|
||||
@@ -440,7 +440,7 @@ Returns a copy of the plane, with normalized :ref:`normal<class_Plane_property_n
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`Vector3<class_Vector3>` **project** **(** :ref:`Vector3<class_Vector3>` point **)** |const|
|
||||
:ref:`Vector3<class_Vector3>` **project**\ (\ point\: :ref:`Vector3<class_Vector3>`\ ) |const|
|
||||
|
||||
Returns the orthogonal projection of ``point`` into a point in the plane.
|
||||
|
||||
@@ -457,7 +457,7 @@ Operator Descriptions
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`bool<class_bool>` **operator !=** **(** :ref:`Plane<class_Plane>` right **)**
|
||||
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`Plane<class_Plane>`\ )
|
||||
|
||||
Returns ``true`` if the planes are not equal.
|
||||
|
||||
@@ -471,7 +471,7 @@ Returns ``true`` if the planes are not equal.
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`Plane<class_Plane>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)**
|
||||
:ref:`Plane<class_Plane>` **operator ***\ (\ right\: :ref:`Transform3D<class_Transform3D>`\ )
|
||||
|
||||
Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D<class_Transform3D>` transformation matrix.
|
||||
|
||||
@@ -485,7 +485,7 @@ Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D<c
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`bool<class_bool>` **operator ==** **(** :ref:`Plane<class_Plane>` right **)**
|
||||
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`Plane<class_Plane>`\ )
|
||||
|
||||
Returns ``true`` if the planes are exactly equal.
|
||||
|
||||
@@ -499,7 +499,7 @@ Returns ``true`` if the planes are exactly equal.
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`Plane<class_Plane>` **operator unary+** **(** **)**
|
||||
:ref:`Plane<class_Plane>` **operator unary+**\ (\ )
|
||||
|
||||
Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
|
||||
|
||||
@@ -511,7 +511,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing,
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`Plane<class_Plane>` **operator unary-** **(** **)**
|
||||
:ref:`Plane<class_Plane>` **operator unary-**\ (\ )
|
||||
|
||||
Returns the negative value of the **Plane**. This is the same as writing ``Plane(-p.normal, -p.d)``. This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction.
|
||||
|
||||
@@ -522,3 +522,4 @@ Returns the negative value of the **Plane**. This is the same as writing ``Plane
|
||||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
||||
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
||||
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
||||
.. |void| replace:: :abbr:`void (No return value.)`
|
||||
|
||||
Reference in New Issue
Block a user