Documentation
¶
Overview ¶
A 2D convex polygon shape, intended for use in physics. Used internally in CollisionPolygon2D when it's in [Collisionpolygon2d.BuildSolids] mode.
ConvexPolygonShape2D is solid, which means it detects collisions from objects that are fully inside it, unlike ConcavePolygonShape2D which is hollow. This makes it more suitable for both detection and physics.
Convex decomposition: A concave polygon can be split up into several convex polygons. This allows dynamic physics bodies to have complex concave collisions (at a performance cost) and can be achieved by using several ConvexPolygonShape2D nodes or by using the CollisionPolygon2D node in [Collisionpolygon2d.BuildSolids] mode. To generate a collision polygon from a sprite, select the Sprite2D node, go to the Sprite2D menu that appears above the viewport, and choose Create Polygon2D Sibling.
Performance: ConvexPolygonShape2D is faster to check collisions against compared to ConcavePolygonShape2D, but it is slower than primitive collision shapes such as CircleShape2D and RectangleShape2D. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by primitive shapes.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsConvexPolygonShape2D() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsShape2D() Shape2D.Instance
- func (self Instance) ID() ID
- func (self Instance) Points() []Vector2.XY
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPointCloud(point_cloud []Vector2.XY)
- func (self Instance) SetPoints(value []Vector2.XY)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsConvexPolygonShape2D ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.ConvexPolygonShape2D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsConvexPolygonShape2D ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) Points ¶
The polygon's list of vertices that form a convex hull. Can be in either clockwise or counterclockwise order.
Warning: Only set this property to a list of points that actually form a convex hull. Use SetPointCloud to generate the convex hull of an arbitrary set of points.
func (Instance) SetPointCloud ¶
Based on the set of points provided, this assigns the Points property using the convex hull algorithm, removing all unneeded points. See Geometry2D.ConvexHull for details.
Source Files