class_shape.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Shape.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Shape:
  5. Shape
  6. =====
  7. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Inherited By:** :ref:`BoxShape<class_BoxShape>`, :ref:`CapsuleShape<class_CapsuleShape>`, :ref:`ConcavePolygonShape<class_ConcavePolygonShape>`, :ref:`ConvexPolygonShape<class_ConvexPolygonShape>`, :ref:`CylinderShape<class_CylinderShape>`, :ref:`PlaneShape<class_PlaneShape>`, :ref:`RayShape<class_RayShape>`, :ref:`SphereShape<class_SphereShape>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for all 3D shape resources.
  13. Properties
  14. ----------
  15. +---------------------------+--------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`margin<class_Shape_property_margin>` |
  17. +---------------------------+--------------------------------------------+
  18. Description
  19. -----------
  20. Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>` objects.
  21. Tutorials
  22. ---------
  23. - :doc:`../tutorials/physics/physics_introduction`
  24. Property Descriptions
  25. ---------------------
  26. .. _class_Shape_property_margin:
  27. - :ref:`float<class_float>` **margin**
  28. +----------+-------------------+
  29. | *Setter* | set_margin(value) |
  30. +----------+-------------------+
  31. | *Getter* | get_margin() |
  32. +----------+-------------------+