class_jointlimitationcone3d.rst 2.8 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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JointLimitationCone3D.xml.
  6. .. _class_JointLimitationCone3D:
  7. JointLimitationCone3D
  8. =====================
  9. **Inherits:** :ref:`JointLimitation3D<class_JointLimitation3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A cone shape limitation that interacts with :ref:`ChainIK3D<class_ChainIK3D>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A cone shape limitation that interacts with :ref:`ChainIK3D<class_ChainIK3D>`.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------+------------------------------------------------------------------------+----------+
  21. | :ref:`float<class_float>` | :ref:`radius_range<class_JointLimitationCone3D_property_radius_range>` | ``0.25`` |
  22. +---------------------------+------------------------------------------------------------------------+----------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Property Descriptions
  27. ---------------------
  28. .. _class_JointLimitationCone3D_property_radius_range:
  29. .. rst-class:: classref-property
  30. :ref:`float<class_float>` **radius_range** = ``0.25`` :ref:`🔗<class_JointLimitationCone3D_property_radius_range>`
  31. .. rst-class:: classref-property-setget
  32. - |void| **set_radius_range**\ (\ value\: :ref:`float<class_float>`\ )
  33. - :ref:`float<class_float>` **get_radius_range**\ (\ )
  34. The size of the hole made by the cone.
  35. \ ``0`` is no hole, ``0.5`` makes a hemisphere, and ``1.0`` makes a sphere (no limitation).
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  38. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  39. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  40. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  41. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  42. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  43. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  44. .. |void| replace:: :abbr:`void (No return value.)`