BodyDefinition

Box2D building DSL utility class. BodyDef extension storing FixtureDef instances in fixtureDefinitions collection. Provides inlined building methods that construct fixture definitions.

Constructors

BodyDefinition

constructor()

Properties

active

var active: Boolean

allowSleep

var allowSleep: Boolean

angle

var angle: Float

angularDamping

var angularDamping: Float

angularVelocity

var angularVelocity: Float

awake

var awake: Boolean

bullet

var bullet: Boolean

creationCallback

var creationCallback: (Body) -> Unit?

Invoked after the Body is fully constructed.

fixedRotation

var fixedRotation: Boolean

fixtureDefinitions

val fixtureDefinitions: Array<FixtureDefinition>

Stores FixtureDefinition instances of all currently defined fixtures of this body. Should not be modified manually - instead, use fixture or one of building methods for fixtures of a specific shape.

gravityScale

var gravityScale: Float

linearDamping

var linearDamping: Float

linearVelocity

val linearVelocity: Vector2

position

val position: Vector2

type

var type: BodyDef.BodyType

userData

var userData: Any?

Custom data object assigned to Body.getUserData. Allows to store additional data about the Body without having to override the class. Defaults to null.

Functions

box

inline fun BodyDefinition.box(width: Float = 1.0f, height: Float = 1.0f, position: Vector2 = Vector2.Zero, angle: Float = 0.0f, init: FixtureDefinition.(PolygonShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with PolygonShape set as box. Note that - contrary to PolygonShape.setAsBox methods - this method consumes actual not halved box width and height sizes.

chain

inline fun BodyDefinition.chain(vararg vertices: Vector2, init: FixtureDefinition.(ChainShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with ChainShape.

inline fun BodyDefinition.chain(vertices: FloatArray, init: FixtureDefinition.(ChainShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with ChainShape. Note that this method consumes a FloatArray instead of array of Vector2 instances, which might be less readable, but creates slightly less garbage. This method is advised to be used instead of the Vector2-consuming variant on mobile devices.

circle

inline fun BodyDefinition.circle(radius: Float = 1.0f, position: Vector2 = Vector2.Zero, init: FixtureDefinition.(CircleShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with CircleShape.

edge

inline fun BodyDefinition.edge(from: Vector2, to: Vector2, init: FixtureDefinition.(EdgeShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with EdgeShape.

inline fun BodyDefinition.edge(fromX: Float, fromY: Float, toX: Float, toY: Float, init: FixtureDefinition.(EdgeShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with EdgeShape. Note that this method consumes floats instead of Vector2 instances, which might be less concise, but also creates slightly less garbage. This method is advised to be used instead of the Vector2-consuming variant on mobile devices.

fixture

inline fun <ShapeType : Shape> BodyDefinition.fixture(shape: ShapeType, disposeOfShape: Boolean = false, init: FixtureDefinition.(ShapeType) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures of custom shape type.

loop

inline fun BodyDefinition.loop(vararg vertices: Vector2, init: FixtureDefinition.(ChainShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with looped ChainShape.

inline fun BodyDefinition.loop(vertices: FloatArray, init: FixtureDefinition.(ChainShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with looped ChainShape. Note that this method consumes a FloatArray instead of array of Vector2 instances, which might be less readable, but creates slightly less garbage. This method is advised to be used instead of the Vector2-consuming variant on mobile devices.

onCreate

fun onCreate(callback: (Body) -> Unit)

polygon

inline fun BodyDefinition.polygon(vararg vertices: Vector2, init: FixtureDefinition.(PolygonShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with PolygonShape.

inline fun BodyDefinition.polygon(vertices: FloatArray? = null, init: FixtureDefinition.(PolygonShape) -> Unit = {}): FixtureDefinition

Utility builder method for constructing fixtures with PolygonShape. Note that this method consumes a FloatArray instead of array of Vector2 instances, which might be less readable, but creates slightly less garbage. This method is advised to be used instead of the Vector2-consuming variant on mobile devices.

BodyDefinition

See also

Constructors

Properties

Functions