rattle-api/io.github.aecsocket.rattle/PhysicsSpace

PhysicsSpace

An independent object storing simulation data for a set of physics structures. This takes ownership of objects like RigidBody and Collider instances, and allows manipulating and querying the internal structures. An instance can be created through PhysicsEngine.createSpace.

Types

ActiveContainer

interface ActiveContainer<R, W, O, K> : PhysicsSpace.SimpleContainer<R, W, O, K>

ColliderContainer

interface ColliderContainer : PhysicsSpace.SimpleContainer<Collider, Collider.Mut, Collider.Own, ColliderKey>

ImpulseJointContainer

interface ImpulseJointContainer

MultibodyJointContainer

interface MultibodyJointContainer

OnCollision

data class OnCollision(val state: PhysicsSpace.OnCollision.State, val colliderA: ColliderKey, val colliderB: ColliderKey, val manifolds: List<ContactManifold>)

OnContactForce

data class OnContactForce(val dt: Double, val totalMagnitude: Double, val colliderA: ColliderKey, val colliderB: ColliderKey, val manifolds: List<ContactManifold>)

OnFilterContactPair

data class OnFilterContactPair(val colliderA: ColliderKey, val colliderB: ColliderKey, val bodyA: RigidBodyKey?, val bodyB: RigidBodyKey?, var solverFlags: PhysicsSpace.SolverFlags = SolverFlags.COMPUTE_IMPULSES)

OnFilterIntersectionPair

data class OnFilterIntersectionPair(val colliderA: ColliderKey, val colliderB: ColliderKey, val bodyA: RigidBodyKey?, val bodyB: RigidBodyKey?, var createPair: Boolean = true)

OnModifySolverContacts

data class OnModifySolverContacts(val colliderA: ColliderKey, val colliderB: ColliderKey, val bodyA: RigidBodyKey?, val bodyB: RigidBodyKey?, val manifold: ContactManifold, var normal: DVec3)

Settings

@ConfigSerializable

data class Settings(val gravity: DVec3 = DVec3(0.0, -9.81, 0.0))

Simulation parameters for a physics space.

SimpleContainer

interface SimpleContainer<R, W, O, K>

SolverFlags

@JvmInline

value class SolverFlags(val flags: Int)

Properties

colliders

abstract val colliders: PhysicsSpace.ColliderContainer

Provides access to the Collider instances in this space.

impulseJoints

abstract val impulseJoints: PhysicsSpace.ImpulseJointContainer

Provides access to the ImpulseJoint instances in this space.

lock

abstract var lock: ReentrantLock?

The lock used for checking thread-safe access (see PhysicsEngine).

multibodyJoints

abstract val multibodyJoints: PhysicsSpace.MultibodyJointContainer

Provides access to the MultibodyJoint instances in this space.

onCollision

abstract val onCollision: EventDispatch<PhysicsSpace.OnCollision>

Runs when a collision between two Colliders is either started or stopped. Runs only when ColliderEvent.COLLISION is marked on at least one of the colliders.

onContactForce

abstract val onContactForce: EventDispatch<PhysicsSpace.OnContactForce>

onFilterContactPair

abstract val onFilterContactPair: EventDispatch<PhysicsSpace.OnFilterContactPair>

onFilterIntersectionPair

abstract val onFilterIntersectionPair: EventDispatch<PhysicsSpace.OnFilterIntersectionPair>

onModifySolverContacts

abstract val onModifySolverContacts: EventDispatch<PhysicsSpace.OnModifySolverContacts>

query

abstract val query: PhysicsQuery

Provides access to performing queries on this physics space, such as raycasts.

rigidBodies

abstract val rigidBodies: PhysicsSpace.ActiveContainer<RigidBody, RigidBody.Mut, RigidBody.Own, RigidBodyKey>

Provides access to the RigidBody instances in this space.

settings

abstract var settings: PhysicsSpace.Settings

Settings for the simulation of the physics space. Note that not all options will be configurable here, as some are considered implementation details. In this case, the settings need to be configured with the actual implementation.

Functions

destroy

abstract fun destroy()