Boks2D/io.github.joaomcl.boks2d.joints

Package-level declarations

Types

data class DistanceJointDef(val bodyA: Body, val bodyB: Body, val localAnchorA: Vec2 = Vec2.Zero, val localAnchorB: Vec2 = Vec2.Zero, val length: Float = 1.0f, val enableSpring: Boolean = false, val hertz: Float = 0.0f, val dampingRatio: Float = 0.0f, val enableLimit: Boolean = false, val minLength: Float = 0.0f, val maxLength: Float = B2_HUGE, val enableMotor: Boolean = false, val maxMotorForce: Float = 0.0f, val motorSpeed: Float = 0.0f, val collideConnected: Boolean = false)

Distance joint definition.

FilterJointDef

data class FilterJointDef(val bodyA: Body, val bodyB: Body)

Definition for a filter joint. A filter joint is used to disable collision between two bodies.

Joint

expect class Joint

Base class for all joints. A joint connects two bodies and constrains their relative motion.

JointType

enum JointType : Enum<JointType>

Joint types supported by Box2D.

MotorJointDef

data class MotorJointDef(val bodyA: Body, val bodyB: Body, val linearOffset: Vec2 = Vec2.Zero, val angularOffset: Float = 0.0f, val maxForce: Float = 1.0f, val maxTorque: Float = 1.0f, val correctionFactor: Float = 0.3f, val collideConnected: Boolean = false)

Motor joint definition.

MouseJointDef

data class MouseJointDef(val bodyA: Body, val bodyB: Body, val target: Vec2, val maxForce: Float = 1.0f, val hertz: Float = 4.0f, val dampingRatio: Float = 1.0f, val collideConnected: Boolean = false)

Mouse joint definition.

PrismaticJointDef

data class PrismaticJointDef(val bodyA: Body, val bodyB: Body, val localAnchorA: Vec2 = Vec2.Zero, val localAnchorB: Vec2 = Vec2.Zero, val localAxisA: Vec2 = Vec2(1f, 0f), val referenceAngle: Float = 0.0f, val enableSpring: Boolean = false, val hertz: Float = 0.0f, val dampingRatio: Float = 0.0f, val enableLimit: Boolean = false, val lowerTranslation: Float = 0.0f, val upperTranslation: Float = 0.0f, val enableMotor: Boolean = false, val maxMotorForce: Float = 0.0f, val motorSpeed: Float = 0.0f, val targetTranslation: Float = 0.0f, val collideConnected: Boolean = false)

Prismatic joint definition.

RevoluteJointDef

data class RevoluteJointDef(val bodyA: Body, val bodyB: Body, val localAnchorA: Vec2 = Vec2.Zero, val localAnchorB: Vec2 = Vec2.Zero, val referenceAngle: Float = 0.0f, val enableSpring: Boolean = false, val hertz: Float = 0.0f, val dampingRatio: Float = 0.0f, val enableLimit: Boolean = false, val lowerAngle: Float = 0.0f, val upperAngle: Float = 0.0f, val enableMotor: Boolean = false, val maxMotorTorque: Float = 0.0f, val motorSpeed: Float = 0.0f, val targetAngle: Float = 0.0f, val collideConnected: Boolean = false)

Revolute joint definition.

WeldJointDef

data class WeldJointDef(val bodyA: Body, val bodyB: Body, val localAnchorA: Vec2 = Vec2.Zero, val localAnchorB: Vec2 = Vec2.Zero, val referenceAngle: Float = 0.0f, val linearHertz: Float = 0.0f, val angularHertz: Float = 0.0f, val linearDampingRatio: Float = 0.0f, val angularDampingRatio: Float = 0.0f, val collideConnected: Boolean = false)

Weld joint definition.

WheelJointDef

data class WheelJointDef(val bodyA: Body, val bodyB: Body, val localAnchorA: Vec2 = Vec2.Zero, val localAnchorB: Vec2 = Vec2.Zero, val localAxisA: Vec2 = Vec2(0f, 1f), val enableSpring: Boolean = true, val hertz: Float = 1.0f, val dampingRatio: Float = 0.7f, val enableLimit: Boolean = false, val lowerTranslation: Float = 0.0f, val upperTranslation: Float = 0.0f, val enableMotor: Boolean = false, val maxMotorTorque: Float = 0.0f, val motorSpeed: Float = 0.0f, val collideConnected: Boolean = false)

Wheel joint definition.