Boks2D/io.github.joaomcl.boks2d.shapes/ShapeDef

ShapeDef

data class ShapeDef(val density: Float = 1.0f, val friction: Float = 0.6f, val restitution: Float = 0.0f, val rollingResistance: Float = 0.0f, val tangentSpeed: Float = 0.0f, val filter: Filter = Filter.Default, val isSensor: Boolean = false, val enableSensorEvents: Boolean = false, val enableContactEvents: Boolean = false, val enableHitEvents: Boolean = false, val enablePreSolveEvents: Boolean = false, val invokeContactCreation: Boolean = true, val updateBodyMass: Boolean = true)

Definition for creating a shape. Default values match Box2D's b2DefaultShapeDef().

Constructors

ShapeDef

constructor(density: Float = 1.0f, friction: Float = 0.6f, restitution: Float = 0.0f, rollingResistance: Float = 0.0f, tangentSpeed: Float = 0.0f, filter: Filter = Filter.Default, isSensor: Boolean = false, enableSensorEvents: Boolean = false, enableContactEvents: Boolean = false, enableHitEvents: Boolean = false, enablePreSolveEvents: Boolean = false, invokeContactCreation: Boolean = true, updateBodyMass: Boolean = true)

Properties

density

val density: Float

The density, usually in kg/m^2.

enableContactEvents

val enableContactEvents: Boolean

Enable contact events for this shape. Only applies to kinematic and dynamic bodies. Ignored for sensors.

enableHitEvents

val enableHitEvents: Boolean

Enable hit events for this shape. Only applies to kinematic and dynamic bodies. Ignored for sensors.

enablePreSolveEvents

val enablePreSolveEvents: Boolean

Enable pre-solve contact events for this shape. Only applies to dynamic bodies. These are expensive and must be carefully handled due to threading. Ignored for sensors.

enableSensorEvents

val enableSensorEvents: Boolean

Enable sensor events for this shape. False by default, even for sensors.

filter

val filter: Filter

Collision filtering data.

friction

val friction: Float

The Coulomb (dry) friction coefficient, usually in the range 0,1.

invokeContactCreation

val invokeContactCreation: Boolean

When true, the shape will trigger a contact creation callback even if the collision filter would normally prevent it. This is useful for custom filtering.

isSensor

val isSensor: Boolean

A sensor shape generates overlap events but never generates a collision response. Sensors do not have continuous collision. Sensors still contribute to the body mass if they have non-zero density.

restitution

val restitution: Float

The coefficient of restitution (bounce) usually in the range 0,1.

rollingResistance

val rollingResistance: Float

The rolling resistance, usually in the range 0,1.

tangentSpeed

val tangentSpeed: Float

The tangent speed for conveyor belt behavior in meters per second.

updateBodyMass

val updateBodyMass: Boolean

When true, adding/removing this shape will automatically update the body mass properties. Set to false if you want to manually call applyMassFromShapes().