| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- :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/SegmentShape2D.xml.
- .. _class_SegmentShape2D:
- SegmentShape2D
- ==============
- **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Segment shape resource for 2D physics.
- Description
- -----------
- 2D segment shape to be added as a *direct* child of a :ref:`PhysicsBody2D<class_PhysicsBody2D>` or :ref:`Area2D<class_Area2D>` using a :ref:`CollisionShape2D<class_CollisionShape2D>` node. Consists of two points, ``a`` and ``b``.
- \ **Performance:** Being a primitive collision shape, ``SegmentShape2D`` is fast to check collisions against (though not as fast as :ref:`CircleShape2D<class_CircleShape2D>`).
- Properties
- ----------
- +-------------------------------+-------------------------------------------+--------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`a<class_SegmentShape2D_property_a>` | ``Vector2(0, 0)`` |
- +-------------------------------+-------------------------------------------+--------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`b<class_SegmentShape2D_property_b>` | ``Vector2(0, 10)`` |
- +-------------------------------+-------------------------------------------+--------------------+
- Property Descriptions
- ---------------------
- .. _class_SegmentShape2D_property_a:
- - :ref:`Vector2<class_Vector2>` **a**
- +-----------+-------------------+
- | *Default* | ``Vector2(0, 0)`` |
- +-----------+-------------------+
- | *Setter* | set_a(value) |
- +-----------+-------------------+
- | *Getter* | get_a() |
- +-----------+-------------------+
- The segment's first point position.
- ----
- .. _class_SegmentShape2D_property_b:
- - :ref:`Vector2<class_Vector2>` **b**
- +-----------+--------------------+
- | *Default* | ``Vector2(0, 10)`` |
- +-----------+--------------------+
- | *Setter* | set_b(value) |
- +-----------+--------------------+
- | *Getter* | get_b() |
- +-----------+--------------------+
- The segment's second point position.
- .. |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.)`
|
