Up to date
This page is up to date for Godot 4.0.
If you still find outdated information, please open an issue.
ConvexPolygonShape3D¶
Inherits: Shape3D < Resource < RefCounted < Object
Convex polygon shape resource for 3D physics.
Description¶
3D convex polygon shape resource to be added as a direct child of a PhysicsBody3D or Area3D using a CollisionShape3D node.
The shape is a solid that includes all the points that it encloses, as opposed to ConcavePolygonShape3D which is hollow if it encloses anything. See also CollisionPolygon3D.
The solid nature of the shape makes it well-suited for both detection and physics; in physics body interactions this allows depenetrating even those shapes which end up (e.g. due to high speed) fully inside the convex shape (similarly to primitive shapes, but unlike ConcavePolygonShape3D and HeightMapShape3D). The convexity restricts the possible geometric shape of a single ConvexPolygonShape3D: it cannot be concave.
Convex decomposition: Concave objects' collisions can be represented accurately using several convex shapes. This allows dynamic physics bodies to have complex concave collisions (at a performance cost). It can be achieved by using several ConvexPolygonShape3D nodes or by using the CollisionPolygon3D node. To generate a collision polygon from a mesh, select the MeshInstance3D node, go to the Mesh menu that appears above the viewport and choose Create Multiple Convex Collision Siblings. Alternatively, MeshInstance3D.create_multiple_convex_collisions can be called in a script to perform this decomposition at run-time.
Performance: ConvexPolygonShape3D is faster to check collisions against compared to ConcavePolygonShape3D, but it is slower than primitive collision shapes such as SphereShape3D or BoxShape3D. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by primitive shapes.
Tutorials¶
Properties¶
|
Property Descriptions¶
PackedVector3Array points = PackedVector3Array()
void set_points ( PackedVector3Array value )
PackedVector3Array get_points ( )
The list of 3D points forming the convex polygon shape.