Struct ShapeDefinition

Namespace: Box3D

Assembly: Box3D.NET.dll

Everything needed to attach a shape to a body, other than the geometry itself.

public readonly record struct ShapeDefinition : IEquatable<ShapeDefinition>

Implements

IEquatable<ShapeDefinition>

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Examples

// A heavy, grippy shape that reports its collisions.
var def = ShapeDefinition.Default with
{
    Density = 2000.0f,
    Material = PhysicsMaterial.Default with { Friction = 0.9f },
    EnableContactEvents = true,
};

body.AddSphere(new Sphere(Vector3.Zero, 0.5f), def);

A trigger volume, which reports overlaps but never pushes anything:

var trigger = ShapeDefinition.Default with
{
    IsSensor = true,
    EnableSensorEvents = true,
    Density = 0.0f,
};

Remarks

Start from Box3D.ShapeDefinition.Default; a zeroed definition has no density and no collision mask, and the engine rejects it.

Attaching a shape moves the body's centre of mass, which changes its linear velocity if it is already spinning. Build bodies before you start simulating them where you can.

Properties