mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
145 lines
5.2 KiB
ReStructuredText
145 lines
5.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SphereMesh.xml.
|
|
|
|
.. _class_SphereMesh:
|
|
|
|
SphereMesh
|
|
==========
|
|
|
|
**Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Class representing a spherical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Class representing a spherical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+-------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`height<class_SphereMesh_property_height>` | ``1.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>` | ``0.5`` |
|
|
+---------------------------+-------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`rings<class_SphereMesh_property_rings>` | ``32`` |
|
|
+---------------------------+-------------------------------------------------------------------+-----------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_SphereMesh_property_height:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **height** = ``1.0`` :ref:`🔗<class_SphereMesh_property_height>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_height**\ (\ )
|
|
|
|
Full height of the sphere.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SphereMesh_property_is_hemisphere:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **is_hemisphere** = ``false`` :ref:`🔗<class_SphereMesh_property_is_hemisphere>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_is_hemisphere**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SphereMesh_property_radial_segments:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **radial_segments** = ``64`` :ref:`🔗<class_SphereMesh_property_radial_segments>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_radial_segments**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_radial_segments**\ (\ )
|
|
|
|
Number of radial segments on the sphere.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SphereMesh_property_radius:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **radius** = ``0.5`` :ref:`🔗<class_SphereMesh_property_radius>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_radius**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_radius**\ (\ )
|
|
|
|
Radius of sphere.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SphereMesh_property_rings:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **rings** = ``32`` :ref:`🔗<class_SphereMesh_property_rings>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_rings**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **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.)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|