| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- :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/SphereShape3D.xml.
- .. _class_SphereShape3D:
- SphereShape3D
- =============
- **Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Sphere shape resource for 3D collisions.
- Description
- -----------
- 3D sphere shape to be added as a *direct* child of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`Area3D<class_Area3D>` using a :ref:`CollisionShape3D<class_CollisionShape3D>` node. This shape is useful for modeling sphere-like 3D objects.
- \ **Performance:** Being a primitive collision shape, ``SphereShape3D`` is the fastest collision shape to check collisions against, as it only requires a distance check with the shape's origin.
- Tutorials
- ---------
- - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
- Properties
- ----------
- +---------------------------+----------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`radius<class_SphereShape3D_property_radius>` | ``0.5`` |
- +---------------------------+----------------------------------------------------+---------+
- Property Descriptions
- ---------------------
- .. _class_SphereShape3D_property_radius:
- - :ref:`float<class_float>` **radius**
- +-----------+-------------------+
- | *Default* | ``0.5`` |
- +-----------+-------------------+
- | *Setter* | set_radius(value) |
- +-----------+-------------------+
- | *Getter* | get_radius() |
- +-----------+-------------------+
- The sphere's radius. The shape's diameter is double the radius.
- .. |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.)`
- .. |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.)`
|
