mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
184 lines
6.9 KiB
ReStructuredText
184 lines
6.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/PlaneMesh.xml.
|
|
|
|
.. _class_PlaneMesh:
|
|
|
|
PlaneMesh
|
|
=========
|
|
|
|
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`QuadMesh<class_QuadMesh>`
|
|
|
|
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, change :ref:`orientation<class_PlaneMesh_property_orientation>` to :ref:`FACE_Z<class_PlaneMesh_constant_FACE_Z>`.
|
|
|
|
\ **Note:** When using a large textured **PlaneMesh** (e.g. as a floor), you may stumble upon UV jittering issues depending on the camera angle. To solve this, increase :ref:`subdivide_depth<class_PlaneMesh_property_subdivide_depth>` and :ref:`subdivide_width<class_PlaneMesh_property_subdivide_width>` until you no longer notice UV jittering.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`center_offset<class_PlaneMesh_property_center_offset>` | ``Vector3(0, 0, 0)`` |
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
| :ref:`Orientation<enum_PlaneMesh_Orientation>` | :ref:`orientation<class_PlaneMesh_property_orientation>` | ``1`` |
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_PlaneMesh_property_size>` | ``Vector2(2, 2)`` |
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
| :ref:`int<class_int>` | :ref:`subdivide_depth<class_PlaneMesh_property_subdivide_depth>` | ``0`` |
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
| :ref:`int<class_int>` | :ref:`subdivide_width<class_PlaneMesh_property_subdivide_width>` | ``0`` |
|
|
+------------------------------------------------+------------------------------------------------------------------+----------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_PlaneMesh_Orientation:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Orientation**:
|
|
|
|
.. _class_PlaneMesh_constant_FACE_X:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Orientation<enum_PlaneMesh_Orientation>` **FACE_X** = ``0``
|
|
|
|
**PlaneMesh** will face the positive X-axis.
|
|
|
|
.. _class_PlaneMesh_constant_FACE_Y:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Orientation<enum_PlaneMesh_Orientation>` **FACE_Y** = ``1``
|
|
|
|
**PlaneMesh** will face the positive Y-axis. This matches the behavior of the **PlaneMesh** in Godot 3.x.
|
|
|
|
.. _class_PlaneMesh_constant_FACE_Z:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Orientation<enum_PlaneMesh_Orientation>` **FACE_Z** = ``2``
|
|
|
|
**PlaneMesh** will face the positive Z-axis. This matches the behavior of the QuadMesh in Godot 3.x.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PlaneMesh_property_center_offset:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector3<class_Vector3>` **center_offset** = ``Vector3(0, 0, 0)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_center_offset** **(** :ref:`Vector3<class_Vector3>` value **)**
|
|
- :ref:`Vector3<class_Vector3>` **get_center_offset** **(** **)**
|
|
|
|
Offset of the generated plane. Useful for particles.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PlaneMesh_property_orientation:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Orientation<enum_PlaneMesh_Orientation>` **orientation** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_orientation** **(** :ref:`Orientation<enum_PlaneMesh_Orientation>` value **)**
|
|
- :ref:`Orientation<enum_PlaneMesh_Orientation>` **get_orientation** **(** **)**
|
|
|
|
Direction that the **PlaneMesh** is facing. See :ref:`Orientation<enum_PlaneMesh_Orientation>` for options.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PlaneMesh_property_size:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **size** = ``Vector2(2, 2)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_size** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **get_size** **(** **)**
|
|
|
|
Size of the generated plane.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PlaneMesh_property_subdivide_depth:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **subdivide_depth** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_subdivide_depth** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)**
|
|
|
|
Number of subdivision along the Z axis.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PlaneMesh_property_subdivide_width:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **subdivide_width** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_subdivide_width** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_subdivide_width** **(** **)**
|
|
|
|
Number of subdivision along the X axis.
|
|
|
|
.. |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.)`
|