godot-docs/classes/class_spheremesh.rst

:github_url: hide

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

.. _class_SphereMesh:

SphereMesh
==========

**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Class representing a spherical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.

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

Class representing a spherical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.

Properties
----------

+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`height<class_SphereMesh_property_height>`                   | ``2.0``   |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`is_hemisphere<class_SphereMesh_property_is_hemisphere>`     | ``false`` |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`     | :ref:`radial_segments<class_SphereMesh_property_radial_segments>` | ``64``    |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`radius<class_SphereMesh_property_radius>`                   | ``1.0``   |
+---------------------------+-------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`     | :ref:`rings<class_SphereMesh_property_rings>`                     | ``32``    |
+---------------------------+-------------------------------------------------------------------+-----------+

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

.. _class_SphereMesh_property_height:

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

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

Full height of the sphere.

----

.. _class_SphereMesh_property_is_hemisphere:

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

+-----------+--------------------------+
| *Default* | ``false``                |
+-----------+--------------------------+
| *Setter*  | set_is_hemisphere(value) |
+-----------+--------------------------+
| *Getter*  | get_is_hemisphere()      |
+-----------+--------------------------+

If ``true``, a hemisphere is created rather than a full sphere.

**Note:** To get a regular hemisphere, the height and radius of the sphere must be equal.

----

.. _class_SphereMesh_property_radial_segments:

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

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

Number of radial segments on the sphere.

----

.. _class_SphereMesh_property_radius:

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

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

Radius of sphere.

----

.. _class_SphereMesh_property_rings:

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

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

Number of segments along the height of the sphere.

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