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

Body

expect class Body

A rigid body in the physics world.

Properties

expect val aabb: AABB

Compute the axis-aligned bounding box of all shapes attached to this body. This may not encompass the body origin. If there are no shapes attached then the returned AABB is empty and centered on the body origin.

angle

expect val angle: Float

The body's angle in radians.

angularDamping

expect var angularDamping: Float

Angular damping. Controls how quickly the angular velocity decreases.

angularVelocity

expect var angularVelocity: Float

The angular velocity in radians per second.

contactCount

expect val contactCount: Int

Get the maximum number of contacts for this body (capacity).

gravityScale

expect var gravityScale: Float

The gravity scale.

inertia

expect val inertia: Float

Get the rotational inertia about the center of mass.

isAwake

expect var isAwake: Boolean

Is this body awake?

isBullet

expect var isBullet: Boolean

Whether this body is a bullet (uses continuous collision detection).

isEnabled

expect var isEnabled: Boolean

Is this body enabled?

isFixedRotation

expect var isFixedRotation: Boolean

Whether this body has fixed rotation (cannot rotate).

isSleepEnabled

expect var isSleepEnabled: Boolean

Whether sleep is enabled for this body.

isValid

expect val isValid: Boolean

Check if this body reference is valid.

jointCount

expect val jointCount: Int

Get the number of joints connected to this body.

linearDamping

expect var linearDamping: Float

Linear damping. Controls how quickly the linear velocity decreases.

linearVelocity

expect var linearVelocity: Vec2

The linear velocity of the body's center of mass.

localCenterOfMass

expect val localCenterOfMass: Vec2

Get the local center of mass position.

mass

expect val mass: Float

Get the mass of the body (usually in kilograms).

name

expect var name: String?

The body's name. Useful for debugging.

position

expect val position: Vec2

Get the world position of the body's origin.

rotation

expect val rotation: Rot

Get the body's rotation.

shapeCount

expect val shapeCount: Int

Get the number of shapes attached to this body.

sleepThreshold

expect var sleepThreshold: Float

The sleep threshold speed. A body will not sleep below this speed.

transform

expect var transform: Transform

The body's transform (position + rotation).

type

expect var type: BodyType

Get or set the body type (Static, Kinematic, or Dynamic).

userData

expect var userData: Long

User data stored as a Long. Can be used as a key in a Map for associating arbitrary objects with this body.

world

expect val world: World

Get the world that owns this body.

worldCenter

expect val worldCenter: Vec2

Get the world center of mass position.

Functions

applyAngularImpulse

expect fun applyAngularImpulse(impulse: Float, wake: Boolean = true)

Apply an angular impulse.

applyForce

expect fun applyForce(force: Vec2, point: Vec2, wake: Boolean = true)

Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque.

applyForceToCenter

expect fun applyForceToCenter(force: Vec2, wake: Boolean = true)

Apply a force to the center of mass.

applyLinearImpulse

expect fun applyLinearImpulse(impulse: Vec2, point: Vec2, wake: Boolean = true)

Apply an impulse at a world point. This immediately modifies the velocity.

applyLinearImpulseToCenter

expect fun applyLinearImpulseToCenter(impulse: Vec2, wake: Boolean = true)

Apply an impulse to the center of mass.

applyMassFromShapes

expect fun applyMassFromShapes()

Recompute the body mass properties from all attached shapes.

applyTorque

expect fun applyTorque(torque: Float, wake: Boolean = true)

Apply a torque.

createCapsuleShape

expect fun createCapsuleShape(def: ShapeDef, capsule: Capsule): Shape

Create a capsule shape and attach it to this body.

createChain

expect fun createChain(def: ChainDef): Chain

Create a chain shape and attach it to this body.

createCircleShape

expect fun createCircleShape(def: ShapeDef, circle: Circle): Shape

Create a circle shape and attach it to this body.

createPolygonShape

expect fun createPolygonShape(def: ShapeDef, polygon: Polygon): Shape

Create a polygon shape and attach it to this body.

createSegmentShape

expect fun createSegmentShape(def: ShapeDef, segment: Segment): Shape

Create a segment (line) shape and attach it to this body.

enableContactEvents

expect fun enableContactEvents(enabled: Boolean)

Enable or disable contact events for all shapes on this body.

enableHitEvents

expect fun enableHitEvents(enabled: Boolean)

Enable or disable hit events for all shapes on this body.

getContactData

expect fun getContactData(): List<ContactData>

Get contact data for this body.

getJoints

expect fun getJoints(): List<Joint>

Get all joints connected to this body.

getLocalPoint

expect fun getLocalPoint(worldPoint: Vec2): Vec2

Get a local point given a world point.

getLocalPointVelocity

expect fun getLocalPointVelocity(localPoint: Vec2): Vec2

Get the linear velocity of a local point on the body (in world coordinates).

getLocalVector

expect fun getLocalVector(worldVector: Vec2): Vec2

Get a local vector given a world vector.

getMassData

expect fun getMassData(): MassData

Get the mass data for this body.

getShapes

expect fun getShapes(): List<Shape>

Get all shapes attached to this body.

getWorldPoint

expect fun getWorldPoint(localPoint: Vec2): Vec2

Get a world point given a local point.

getWorldPointVelocity

expect fun getWorldPointVelocity(worldPoint: Vec2): Vec2

Get the linear velocity of a world point attached to the body.

getWorldVector

expect fun getWorldVector(localVector: Vec2): Vec2

Get a world vector given a local vector.

setMassData

expect fun setMassData(massData: MassData)

Set the mass data for this body.

setTargetTransform

expect fun setTargetTransform(target: Transform, timeStep: Float)

Set the target transform for a kinematic body. This will be reached over the given time step.