137 lines
5.4 KiB
ReStructuredText
137 lines
5.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CylinderMesh.xml.
|
|
|
|
.. _class_CylinderMesh:
|
|
|
|
CylinderMesh
|
|
============
|
|
|
|
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This class can be used to create cones by setting either the :ref:`top_radius<class_CylinderMesh_property_top_radius>` or :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` properties to ``0.0``.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` | ``1.0`` |
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`height<class_CylinderMesh_property_height>` | ``2.0`` |
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
| :ref:`int<class_int>` | :ref:`radial_segments<class_CylinderMesh_property_radial_segments>` | ``64`` |
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
| :ref:`int<class_int>` | :ref:`rings<class_CylinderMesh_property_rings>` | ``4`` |
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`top_radius<class_CylinderMesh_property_top_radius>` | ``1.0`` |
|
|
+---------------------------+---------------------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CylinderMesh_property_bottom_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **bottom_radius** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_bottom_radius** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_bottom_radius** **(** **)**
|
|
|
|
Bottom radius of the cylinder. If set to ``0.0``, the bottom faces will not be generated, resulting in a conic shape.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CylinderMesh_property_height:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **height** = ``2.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_height** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_height** **(** **)**
|
|
|
|
Full height of the cylinder.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CylinderMesh_property_radial_segments:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **radial_segments** = ``64``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_radial_segments** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_radial_segments** **(** **)**
|
|
|
|
Number of radial segments on the cylinder. Higher values result in a more detailed cylinder/cone at the cost of performance.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CylinderMesh_property_rings:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **rings** = ``4``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_rings** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_rings** **(** **)**
|
|
|
|
Number of edge rings along the height of the cylinder. Changing :ref:`rings<class_CylinderMesh_property_rings>` does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, :ref:`rings<class_CylinderMesh_property_rings>` should be kept to its default value.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_CylinderMesh_property_top_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **top_radius** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_top_radius** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_top_radius** **(** **)**
|
|
|
|
Top radius of the cylinder. If set to ``0.0``, the top faces will not be generated, resulting in a conic shape.
|
|
|
|
.. |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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|