godot-docs/classes/class_csgcylinder.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CSGCylinder.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CSGCylinder:

CSGCylinder
===========

**Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`GeometryInstance<class_GeometryInstance>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

A CSG Cylinder shape.

Description
-----------

This node allows you to create a cylinder (or cone) for use with the CSG system.

**Note:** CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a :ref:`MeshInstance<class_MeshInstance>` with a :ref:`PrimitiveMesh<class_PrimitiveMesh>`. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.

Tutorials
---------

- `Prototyping levels with CSG <$DOCS_URL/tutorials/3d/csg_tools.html>`__

Properties
----------

+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`         | :ref:`cone<class_CSGCylinder_property_cone>`                 | ``false`` |
+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`float<class_float>`       | :ref:`height<class_CSGCylinder_property_height>`             | ``1.0``   |
+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>`         |           |
+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`float<class_float>`       | :ref:`radius<class_CSGCylinder_property_radius>`             | ``1.0``   |
+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`int<class_int>`           | :ref:`sides<class_CSGCylinder_property_sides>`               | ``8``     |
+---------------------------------+--------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`         | :ref:`smooth_faces<class_CSGCylinder_property_smooth_faces>` | ``true``  |
+---------------------------------+--------------------------------------------------------------+-----------+

Property Descriptions
---------------------

.. _class_CSGCylinder_property_cone:

- :ref:`bool<class_bool>` **cone**

+-----------+-----------------+
| *Default* | ``false``       |
+-----------+-----------------+
| *Setter*  | set_cone(value) |
+-----------+-----------------+
| *Getter*  | is_cone()       |
+-----------+-----------------+

If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side.

----

.. _class_CSGCylinder_property_height:

- :ref:`float<class_float>` **height**

+-----------+-------------------+
| *Default* | ``1.0``           |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

The height of the cylinder.

----

.. _class_CSGCylinder_property_material:

- :ref:`Material<class_Material>` **material**

+----------+---------------------+
| *Setter* | set_material(value) |
+----------+---------------------+
| *Getter* | get_material()      |
+----------+---------------------+

The material used to render the cylinder.

----

.. _class_CSGCylinder_property_radius:

- :ref:`float<class_float>` **radius**

+-----------+-------------------+
| *Default* | ``1.0``           |
+-----------+-------------------+
| *Setter*  | set_radius(value) |
+-----------+-------------------+
| *Getter*  | get_radius()      |
+-----------+-------------------+

The radius of the cylinder.

----

.. _class_CSGCylinder_property_sides:

- :ref:`int<class_int>` **sides**

+-----------+------------------+
| *Default* | ``8``            |
+-----------+------------------+
| *Setter*  | set_sides(value) |
+-----------+------------------+
| *Getter*  | get_sides()      |
+-----------+------------------+

The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.

----

.. _class_CSGCylinder_property_smooth_faces:

- :ref:`bool<class_bool>` **smooth_faces**

+-----------+-------------------------+
| *Default* | ``true``                |
+-----------+-------------------------+
| *Setter*  | set_smooth_faces(value) |
+-----------+-------------------------+
| *Getter*  | get_smooth_faces()      |
+-----------+-------------------------+

If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look.

.. |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.)`