godot-docs/classes/class_csgsphere.rst

:github_url: hide

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

.. _class_CSGSphere:

CSGSphere
=========

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

**Category:** Core

Brief Description
-----------------

A CSG Sphere shape.

Properties
----------

+---------------------------------+------------------------------------------------------------------+------+
| :ref:`Material<class_Material>` | :ref:`material<class_CSGSphere_property_material>`               |      |
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`int<class_int>`           | :ref:`radial_segments<class_CSGSphere_property_radial_segments>` | 12   |
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`float<class_float>`       | :ref:`radius<class_CSGSphere_property_radius>`                   | 1.0  |
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`int<class_int>`           | :ref:`rings<class_CSGSphere_property_rings>`                     | 6    |
+---------------------------------+------------------------------------------------------------------+------+
| :ref:`bool<class_bool>`         | :ref:`smooth_faces<class_CSGSphere_property_smooth_faces>`       | true |
+---------------------------------+------------------------------------------------------------------+------+

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

This node allows you to create a sphere for use with the CSG system.

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

.. _class_CSGSphere_property_material:

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

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

The material used to render the sphere.

.. _class_CSGSphere_property_radial_segments:

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

+-----------+----------------------------+
| *Default* | 12                         |
+-----------+----------------------------+
| *Setter*  | set_radial_segments(value) |
+-----------+----------------------------+
| *Getter*  | get_radial_segments()      |
+-----------+----------------------------+

Number of vertical slices for the sphere.

.. _class_CSGSphere_property_radius:

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

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

Radius of the sphere.

.. _class_CSGSphere_property_rings:

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

+-----------+------------------+
| *Default* | 6                |
+-----------+------------------+
| *Setter*  | set_rings(value) |
+-----------+------------------+
| *Getter*  | get_rings()      |
+-----------+------------------+

Number of horizontal slices for the sphere.

.. _class_CSGSphere_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 sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look.