| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the BoxMesh.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_BoxMesh:
- BoxMesh
- =======
- **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Generate an axis-aligned box :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
- Description
- -----------
- Generate an axis-aligned box :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
- The box's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to ``Vector3(3, 2, 1)``.
- \ **Note:** When using a large textured ``BoxMesh`` (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_BoxMesh_property_subdivide_depth>`, :ref:`subdivide_height<class_BoxMesh_property_subdivide_height>` and :ref:`subdivide_width<class_BoxMesh_property_subdivide_width>` until you no longer notice UV jittering.
- Properties
- ----------
- +-------------------------------+------------------------------------------------------------------+----------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`size<class_BoxMesh_property_size>` | ``Vector3(1, 1, 1)`` |
- +-------------------------------+------------------------------------------------------------------+----------------------+
- | :ref:`int<class_int>` | :ref:`subdivide_depth<class_BoxMesh_property_subdivide_depth>` | ``0`` |
- +-------------------------------+------------------------------------------------------------------+----------------------+
- | :ref:`int<class_int>` | :ref:`subdivide_height<class_BoxMesh_property_subdivide_height>` | ``0`` |
- +-------------------------------+------------------------------------------------------------------+----------------------+
- | :ref:`int<class_int>` | :ref:`subdivide_width<class_BoxMesh_property_subdivide_width>` | ``0`` |
- +-------------------------------+------------------------------------------------------------------+----------------------+
- Property Descriptions
- ---------------------
- .. _class_BoxMesh_property_size:
- - :ref:`Vector3<class_Vector3>` **size**
- +-----------+----------------------+
- | *Default* | ``Vector3(1, 1, 1)`` |
- +-----------+----------------------+
- | *Setter* | set_size(value) |
- +-----------+----------------------+
- | *Getter* | get_size() |
- +-----------+----------------------+
- The box's width, height and depth.
- ----
- .. _class_BoxMesh_property_subdivide_depth:
- - :ref:`int<class_int>` **subdivide_depth**
- +-----------+----------------------------+
- | *Default* | ``0`` |
- +-----------+----------------------------+
- | *Setter* | set_subdivide_depth(value) |
- +-----------+----------------------------+
- | *Getter* | get_subdivide_depth() |
- +-----------+----------------------------+
- Number of extra edge loops inserted along the Z axis.
- ----
- .. _class_BoxMesh_property_subdivide_height:
- - :ref:`int<class_int>` **subdivide_height**
- +-----------+-----------------------------+
- | *Default* | ``0`` |
- +-----------+-----------------------------+
- | *Setter* | set_subdivide_height(value) |
- +-----------+-----------------------------+
- | *Getter* | get_subdivide_height() |
- +-----------+-----------------------------+
- Number of extra edge loops inserted along the Y axis.
- ----
- .. _class_BoxMesh_property_subdivide_width:
- - :ref:`int<class_int>` **subdivide_width**
- +-----------+----------------------------+
- | *Default* | ``0`` |
- +-----------+----------------------------+
- | *Setter* | set_subdivide_width(value) |
- +-----------+----------------------------+
- | *Getter* | get_subdivide_width() |
- +-----------+----------------------------+
- Number of extra edge loops inserted 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.)`
|
