reckfellENGINE

ConvexPolygonShape3D

A 3D convex polyhedron shape used for physics collision.

On this page
class ConvexPolygonShape3DReckfellSharpInherits Shape3D

A 3D convex polyhedron shape used for physics collision.

A 3D convex polyhedron shape, intended for use in physics. Usually used to provide a shape for a CollisionShape3D. ConvexPolygonShape3D is solid, which means it detects collisions from objects that are fully inside it, unlike ConcavePolygonShape3D which is hollow. This makes it more suitable for both detection and physics. Convex decomposition: A concave polyhedron can be split up into several convex polyhedra. This allows dynamic physics bodies to have complex concave collisions (at a performance cost) and can be achieved by using several ConvexPolygonShape3D nodes. To generate a convex decomposition 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.CreateMultipleConvexCollisions 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 and BoxShape3D. Its use should generally be limited to medium-sized objects that cannot have their collision accurately represented by primitive shapes.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

ConvexPolygonShape3DConstructor
# ConvexPolygonShape3D
C#
public ConvexPolygonShape3D();

Properties1

PointsProperty
# Points
C#
public Vector3[] Points { get; set; }

The list of 3D points forming the convex polygon shape.

Methods3

GetPointsVector3[]
# GetPoints
C#
public Vector3[] GetPoints();
Returns Vector3[]
SetPoints2 overloads
# SetPoints · 1/2
C#
public void SetPoints(Vector3[] points);
Parameters
NameTypeDefault
pointsVector3[]—
# SetPoints · 2/2
C#
public void SetPoints(ReadOnlySpan<Vector3> points);
Parameters
NameTypeDefault
pointsReadOnlySpan<Vector3>—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.