mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
117 lines
5.6 KiB
ReStructuredText
117 lines
5.6 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.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>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Class representing a spherical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_height<class_SphereMesh_get_height>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_is_hemisphere<class_SphereMesh_get_is_hemisphere>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_SphereMesh_get_radial_segments>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_radius<class_SphereMesh_get_radius>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_rings<class_SphereMesh_get_rings>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_height<class_SphereMesh_set_height>` **(** :ref:`float<class_float>` height **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_is_hemisphere<class_SphereMesh_set_is_hemisphere>` **(** :ref:`bool<class_bool>` is_hemisphere **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_radial_segments<class_SphereMesh_set_radial_segments>` **(** :ref:`int<class_int>` radial_segments **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_radius<class_SphereMesh_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_rings<class_SphereMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_SphereMesh_height:
|
|
|
|
- :ref:`float<class_float>` **height** - Full height of the sphere. Defaults to 2.0.
|
|
|
|
.. _class_SphereMesh_is_hemisphere:
|
|
|
|
- :ref:`bool<class_bool>` **is_hemisphere** - Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to false.
|
|
|
|
.. _class_SphereMesh_radial_segments:
|
|
|
|
- :ref:`int<class_int>` **radial_segments** - Number of radial segments on the sphere. Defaults to 64.
|
|
|
|
.. _class_SphereMesh_radius:
|
|
|
|
- :ref:`float<class_float>` **radius** - Radius of sphere. Defaults to 1.0.
|
|
|
|
.. _class_SphereMesh_rings:
|
|
|
|
- :ref:`int<class_int>` **rings** - Number of segments along the height of the sphere. Defaults to 32.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a spherical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_SphereMesh_get_height:
|
|
|
|
- :ref:`float<class_float>` **get_height** **(** **)** const
|
|
|
|
.. _class_SphereMesh_get_is_hemisphere:
|
|
|
|
- :ref:`bool<class_bool>` **get_is_hemisphere** **(** **)** const
|
|
|
|
.. _class_SphereMesh_get_radial_segments:
|
|
|
|
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
|
|
|
.. _class_SphereMesh_get_radius:
|
|
|
|
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
|
|
|
.. _class_SphereMesh_get_rings:
|
|
|
|
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
|
|
|
.. _class_SphereMesh_set_height:
|
|
|
|
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
|
|
|
.. _class_SphereMesh_set_is_hemisphere:
|
|
|
|
- void **set_is_hemisphere** **(** :ref:`bool<class_bool>` is_hemisphere **)**
|
|
|
|
.. _class_SphereMesh_set_radial_segments:
|
|
|
|
- void **set_radial_segments** **(** :ref:`int<class_int>` radial_segments **)**
|
|
|
|
.. _class_SphereMesh_set_radius:
|
|
|
|
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
|
|
|
.. _class_SphereMesh_set_rings:
|
|
|
|
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
|
|
|
|