.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Plane.xml. .. _class_Plane: Plane ===== .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+--------------------------------------------+----------------------+ | :ref:`float` | :ref:`d` | ``0.0`` | +-------------------------------+--------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`normal` | ``Vector3(0, 0, 0)`` | +-------------------------------+--------------------------------------------+----------------------+ | :ref:`float` | :ref:`x` | ``0.0`` | +-------------------------------+--------------------------------------------+----------------------+ | :ref:`float` | :ref:`y` | ``0.0`` | +-------------------------------+--------------------------------------------+----------------------+ | :ref:`float` | :ref:`z` | ``0.0`` | +-------------------------------+--------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`Plane` from **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`float` d **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` normal, :ref:`Vector3` point **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`Plane` **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** | +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_center` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point, :ref:`float` tolerance=1e-05 **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`intersect_3` **(** :ref:`Plane` b, :ref:`Plane` c **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`intersects_ray` **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`intersects_segment` **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Plane` to_plane **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_point_over` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`normalized` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`project` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Plane` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`operator *` **(** :ref:`Transform3D` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Plane` right **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`operator unary+` **(** **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`operator unary-` **(** **)** | +---------------------------+-----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_Plane_constant_PLANE_YZ: .. rst-class:: classref-constant **PLANE_YZ** = ``Plane(1, 0, 0, 0)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_Plane_constant_PLANE_XZ: .. rst-class:: classref-constant **PLANE_XZ** = ``Plane(0, 1, 0, 0)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_Plane_constant_PLANE_XY: .. rst-class:: classref-constant **PLANE_XY** = ``Plane(0, 0, 1, 0)`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Plane_property_d: .. rst-class:: classref-property :ref:`float` **d** = ``0.0`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_property_normal: .. rst-class:: classref-property :ref:`Vector3` **normal** = ``Vector3(0, 0, 0)`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_property_x: .. rst-class:: classref-property :ref:`float` **x** = ``0.0`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_property_y: .. rst-class:: classref-property :ref:`float` **y** = ``0.0`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_property_z: .. rst-class:: classref-property :ref:`float` **z** = ``0.0`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Plane_constructor_Plane: .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`Plane` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`float` a, :ref:`float` b, :ref:`float` c, :ref:`float` d **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`Vector3` normal **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`float` d **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`Vector3` normal, :ref:`Vector3` point **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Plane` **Plane** **(** :ref:`Vector3` point1, :ref:`Vector3` point2, :ref:`Vector3` point3 **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Plane_method_distance_to: .. rst-class:: classref-method :ref:`float` **distance_to** **(** :ref:`Vector3` point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_get_center: .. rst-class:: classref-method :ref:`Vector3` **get_center** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_has_point: .. rst-class:: classref-method :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` tolerance=1e-05 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_intersect_3: .. rst-class:: classref-method :ref:`Variant` **intersect_3** **(** :ref:`Plane` b, :ref:`Plane` c **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_intersects_ray: .. rst-class:: classref-method :ref:`Variant` **intersects_ray** **(** :ref:`Vector3` from, :ref:`Vector3` dir **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_intersects_segment: .. rst-class:: classref-method :ref:`Variant` **intersects_segment** **(** :ref:`Vector3` from, :ref:`Vector3` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`Plane` to_plane **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_is_point_over: .. rst-class:: classref-method :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_normalized: .. rst-class:: classref-method :ref:`Plane` **normalized** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_method_project: .. rst-class:: classref-method :ref:`Vector3` **project** **(** :ref:`Vector3` point **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Plane_operator_neq_Plane: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`Plane` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_operator_mul_Transform3D: .. rst-class:: classref-operator :ref:`Plane` **operator *** **(** :ref:`Transform3D` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_operator_eq_Plane: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`Plane` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_operator_unplus: .. rst-class:: classref-operator :ref:`Plane` **operator unary+** **(** **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Plane_operator_unminus: .. rst-class:: classref-operator :ref:`Plane` **operator unary-** **(** **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |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.)`