Boks2D/io.github.joaomcl.boks2d.core/WorldDef

WorldDef

data class WorldDef(val gravity: Vec2 = Vec2(0f, -10f), val restitutionThreshold: Float = 1.0f, val hitEventThreshold: Float = 1.0f, val contactHertz: Float = 30.0f, val contactDampingRatio: Float = 10.0f, val maxContactPushSpeed: Float = 3.0f, val maximumLinearSpeed: Float = 400.0f, val enableSleep: Boolean = true, val enableContinuous: Boolean = true)

Definition for creating a physics world. Default values match Box2D's b2DefaultWorldDef().

Constructors

WorldDef

constructor(gravity: Vec2 = Vec2(0f, -10f), restitutionThreshold: Float = 1.0f, hitEventThreshold: Float = 1.0f, contactHertz: Float = 30.0f, contactDampingRatio: Float = 10.0f, maxContactPushSpeed: Float = 3.0f, maximumLinearSpeed: Float = 400.0f, enableSleep: Boolean = true, enableContinuous: Boolean = true)

Properties

contactDampingRatio

val contactDampingRatio: Float

Contact bounciness. Lower values speed up overlap recovery but make resolution more energetic.

contactHertz

val contactHertz: Float

Contact stiffness (cycles per second). Higher values increase overlap recovery speed but may cause jitter.

enableContinuous

val enableContinuous: Boolean

Enable continuous collision detection to prevent fast bodies from tunneling through thin objects.

enableSleep

val enableSleep: Boolean

Can bodies go to sleep to improve performance.

gravity

val gravity: Vec2

Gravity vector. Box2D has no up-vector defined.

hitEventThreshold

val hitEventThreshold: Float

Threshold speed for hit events (m/s).

maxContactPushSpeed

val maxContactPushSpeed: Float

Maximum speed for contact push-out resolution (m/s).

maximumLinearSpeed

val maximumLinearSpeed: Float

Maximum linear speed for bodies (m/s). Default is 400 (faster than speed of sound).

restitutionThreshold

val restitutionThreshold: Float

Restitution speed threshold (m/s). Collisions above this speed have restitution applied (will bounce).