• Home
• io.github.libktx
• ktx-box2d
• 1.12.1-rc2
• source code
• joints.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

ktx.box2d.joints.kt Maven / Gradle / Ivy

package ktx.box2d

import com.badlogic.gdx.physics.box2d.Body
import com.badlogic.gdx.physics.box2d.Joint
import com.badlogic.gdx.physics.box2d.JointDef
import com.badlogic.gdx.physics.box2d.joints.DistanceJoint
import com.badlogic.gdx.physics.box2d.joints.DistanceJointDef
import com.badlogic.gdx.physics.box2d.joints.FrictionJoint
import com.badlogic.gdx.physics.box2d.joints.FrictionJointDef
import com.badlogic.gdx.physics.box2d.joints.GearJoint
import com.badlogic.gdx.physics.box2d.joints.GearJointDef
import com.badlogic.gdx.physics.box2d.joints.MotorJoint
import com.badlogic.gdx.physics.box2d.joints.MotorJointDef
import com.badlogic.gdx.physics.box2d.joints.MouseJoint
import com.badlogic.gdx.physics.box2d.joints.MouseJointDef
import com.badlogic.gdx.physics.box2d.joints.PrismaticJoint
import com.badlogic.gdx.physics.box2d.joints.PrismaticJointDef
import com.badlogic.gdx.physics.box2d.joints.PulleyJoint
import com.badlogic.gdx.physics.box2d.joints.PulleyJointDef
import com.badlogic.gdx.physics.box2d.joints.RevoluteJoint
import com.badlogic.gdx.physics.box2d.joints.RevoluteJointDef
import com.badlogic.gdx.physics.box2d.joints.RopeJoint
import com.badlogic.gdx.physics.box2d.joints.RopeJointDef
import com.badlogic.gdx.physics.box2d.joints.WeldJoint
import com.badlogic.gdx.physics.box2d.joints.WeldJointDef
import com.badlogic.gdx.physics.box2d.joints.WheelJoint
import com.badlogic.gdx.physics.box2d.joints.WheelJointDef
import kotlin.contracts.ExperimentalContracts
import kotlin.contracts.InvocationKind
import kotlin.contracts.contract

/**
 * Allows to create a [Joint] with custom [JointDef] instance. `this` [Body] will be set as the [JointDef.bodyA].
 * @param body will be set as the [JointDef.bodyB].
 * @param jointDefinition can be customized with [init] block.
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a fully constructed [Joint] based on the customized [jointDefinition].
 * @see gearJointWith
 * @see ropeJointWith
 * @see weldJointWith
 * @see motorJointWith
 * @see mouseJointWith
 * @see wheelJointWith
 * @see pulleyJointWith
 * @see distanceJointWith
 * @see frictionJointWith
 * @see revoluteJointWith
 * @see prismaticJointWith
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun  Body.jointWith(
  body: Body,
  jointDefinition: J,
  init: (@Box2DDsl J).() -> Unit = {},
): Joint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  jointDefinition.bodyA = this
  jointDefinition.bodyB = body
  jointDefinition.init()
  return world.createJoint(jointDefinition)
}

/**
 * Allows to create a [RevoluteJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [RevoluteJoint] created with the customized [RevoluteJointDef].
 * @see RevoluteJointDef
 * @see RevoluteJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.revoluteJointWith(body: Body, init: (@Box2DDsl RevoluteJointDef).() -> Unit = {}): RevoluteJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, RevoluteJointDef(), init) as RevoluteJoint
}

/**
 * Allows to create a [PrismaticJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [PrismaticJoint] created with the customized [PrismaticJointDef].
 * @see PrismaticJointDef
 * @see PrismaticJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.prismaticJointWith(body: Body, init: (@Box2DDsl PrismaticJointDef).() -> Unit = {}): PrismaticJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, PrismaticJointDef(), init) as PrismaticJoint
}

/**
 * Allows to create a [DistanceJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [DistanceJoint] created with the customized [DistanceJointDef].
 * @see DistanceJointDef
 * @see DistanceJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.distanceJointWith(body: Body, init: (@Box2DDsl DistanceJointDef).() -> Unit = {}): DistanceJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, DistanceJointDef(), init) as DistanceJoint
}

/**
 * Allows to create a [PulleyJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [PulleyJoint] created with the customized [PulleyJointDef].
 * @see PulleyJointDef
 * @see PulleyJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.pulleyJointWith(body: Body, init: (@Box2DDsl PulleyJointDef).() -> Unit = {}): PulleyJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(
    body,
    PulleyJointDef().apply {
      localAnchorA.set(0f, 0f)
      localAnchorB.set(0f, 0f)
    },
    init,
  ) as PulleyJoint
}

/**
 * Allows to create a [MouseJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [MouseJoint] created with the customized [MouseJointDef].
 * @see MouseJointDef
 * @see MouseJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.mouseJointWith(body: Body, init: (@Box2DDsl MouseJointDef).() -> Unit = {}): MouseJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, MouseJointDef(), init) as MouseJoint
}

/**
 * Allows to create a [GearJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [GearJoint] created with the customized [GearJointDef].
 * @see GearJointDef
 * @see GearJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.gearJointWith(body: Body, init: (@Box2DDsl GearJointDef).() -> Unit = {}): GearJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, GearJointDef(), init) as GearJoint
}

/**
 * Allows to create a [WheelJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [WheelJoint] created with the customized [WheelJointDef].
 * @see WheelJointDef
 * @see WheelJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.wheelJointWith(body: Body, init: (@Box2DDsl WheelJointDef).() -> Unit = {}): WheelJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, WheelJointDef(), init) as WheelJoint
}

/**
 * Allows to create a [WeldJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [WeldJoint] created with the customized [WeldJointDef].
 * @see WeldJointDef
 * @see WeldJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.weldJointWith(body: Body, init: (@Box2DDsl WeldJointDef).() -> Unit = {}): WeldJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, WeldJointDef(), init) as WeldJoint
}

/**
 * Allows to create a [FrictionJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [FrictionJoint] created with the customized [FrictionJointDef].
 * @see FrictionJointDef
 * @see FrictionJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.frictionJointWith(body: Body, init: (@Box2DDsl FrictionJointDef).() -> Unit = {}): FrictionJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, FrictionJointDef(), init) as FrictionJoint
}

/**
 * Allows to create a [RopeJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [RopeJoint] created with the customized [RopeJointDef].
 * @see RopeJointDef
 * @see RopeJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.ropeJointWith(body: Body, init: (@Box2DDsl RopeJointDef).() -> Unit = {}): RopeJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(
    body,
    RopeJointDef().apply {
      // Rope joint anchors are initiated with unexpected defaults (might be incompatible with user's Box2D world scale).
      // Clearing libGDX defaults:
      localAnchorA.set(0f, 0f)
      localAnchorB.set(0f, 0f)
    },
    init,
  ) as RopeJoint
}

/**
 * Allows to create a [MotorJoint]. `this` [Body] will be set as the [JointDef.bodyA] and will be available
 * through [Joint.getBodyA].
 * @param body will be set as [JointDef.bodyB] and available through [Joint.getBodyB].
 * @param init inlined. [JointDef.bodyA], [JointDef.bodyB] and [JointDef.type] must not be changed. Invoked after joint
 *    definition default values are preset.
 * @return a new instance of [MotorJoint] created with the customized [MotorJointDef].
 * @see MotorJointDef
 * @see MotorJoint
 */
@Box2DDsl
@OptIn(ExperimentalContracts::class)
inline fun Body.motorJointWith(body: Body, init: (@Box2DDsl MotorJointDef).() -> Unit = {}): MotorJoint {
  contract { callsInPlace(init, InvocationKind.EXACTLY_ONCE) }
  return jointWith(body, MotorJointDef(), init) as MotorJoint
}