2
0

class_sphereshape.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SphereShape.xml.
  6. .. _class_SphereShape:
  7. SphereShape
  8. ===========
  9. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Sphere shape for 3D collisions.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Sphere shape for 3D collisions, which can be set into a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`. This shape is useful for modeling sphere-like 3D objects.
  15. .. rst-class:: classref-introduction-group
  16. Tutorials
  17. ---------
  18. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +---------------------------+--------------------------------------------------+---------+
  25. | :ref:`float<class_float>` | :ref:`radius<class_SphereShape_property_radius>` | ``1.0`` |
  26. +---------------------------+--------------------------------------------------+---------+
  27. .. rst-class:: classref-section-separator
  28. ----
  29. .. rst-class:: classref-descriptions-group
  30. Property Descriptions
  31. ---------------------
  32. .. _class_SphereShape_property_radius:
  33. .. rst-class:: classref-property
  34. :ref:`float<class_float>` **radius** = ``1.0``
  35. .. rst-class:: classref-property-setget
  36. - void **set_radius** **(** :ref:`float<class_float>` value **)**
  37. - :ref:`float<class_float>` **get_radius** **(** **)**
  38. The sphere's radius. The shape's diameter is double the radius.
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  42. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`