API reference
API reference
Select your platform
No SDKs available
No versions available

PhysicsCreationSystem Class

Extends SystemBase
Modifiers: final
System responsible for creating and managing physics objects. Monitors changes to Physics components and loads collision shapes from local or networked assets. Handles both HTTP/HTTPS URLs and local file paths for collision shapes.
Supports custom physics creators for compound shapes and other custom physics configurations. Register custom creators using the physicsCreators map with physics:// URL scheme.
Example:
val physicsCreationSystem = systemManager.findSystem<PhysicsCreationSystem>()
physicsCreationSystem.physicsCreators["physics://dumbbell"] = { entity ->
    val dumbbell = ScenePhysicsObject.createCompound(scene, entity, 2.0f)
    dumbbell.addChildSphere(0.15f, Vector3(-0.4f, 0f, 0f))
    dumbbell.addChildBox(0.4f, 0.04f, 0.04f, Pose())
    dumbbell.addChildSphere(0.15f, Vector3(0.4f, 0f, 0f))
    dumbbell.finalizeCompound(physicsBridge.dataModel)
    dumbbell
}

Uses the changedSince pattern for efficient incremental updates.
IMPORTANT: This system MUST run BEFORE PhysicsConstraintSystem to ensure physics bodies exist before constraints are created.

Signature

class PhysicsCreationSystem(val physicsBridge: PhysicsBridge) : SystemBase

Constructors

PhysicsCreationSystem ( physicsBridge )
Signature
constructor(physicsBridge: PhysicsBridge)
Parameters
physicsBridge: PhysicsBridge  The PhysicsBridge used to create and delete physics objects

Properties

executeCount : Long
[Get]
The number of times this system's SystemBase.execute method has been called by the system manager. Incremented automatically before each execution cycle. Useful for performance monitoring.
Signature
var executeCount: Long
physicsBridge : PhysicsBridge
[Get]
The PhysicsBridge used to create and delete physics objects
Signature
val physicsBridge: PhysicsBridge
physicsCreators : HashMap<String, (entity: Entity) -> ScenePhysicsObject>
[Get]
Map of physics URLs to creator functions that return ScenePhysicsObject.
Signature
val physicsCreators: HashMap<String, (entity: Entity) -> ScenePhysicsObject>
systemManager : SystemManager
[Get][Set]
The SystemManager that this system is registered with. Provides access to other systems and the scene. Initialized during system registration.
Signature
lateinit var systemManager: SystemManager

Methods

associateSystemManager ( systemManager )
Associates this system with a SystemManager. Called during registration. Throws RuntimeException if the system is already associated — each system instance can only belong to one manager.
Signature
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager  The system manager that will own and execute this system.
delete ( entity )
Called when an PhysicsCreationSystem.delete is removed from the scene. Override to clean up any per-entity state this system maintains, such as cached components, tracking maps, or native resource handles.
Signature
open override fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
Called during system shutdown to release all resources held by this system. Override to dispose of native handles, close streams, and clear any global state accumulated during the session.
Signature
open fun destroy()
equals ( other )
Checks if this system is equal to another object. Two systems are considered equal if they are the same instance or share the same Kotlin class, regardless of configuration state.
Signature
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?  The object to compare with.
Returns
Boolean  True if the other object is the same system instance or the same system class.
execute ()
Called each frame by the SystemManager to perform this system's per-tick logic. Override to query entities with relevant components and apply updates.
Signature
open override fun execute()
getDependencies ()
Returns the execution ordering dependencies for this system. Override to declare which other systems must run before or after this one using SystemDependencies.
Signature
open fun getDependencies(): SystemDependencies?
Returns
SystemDependencies?  The dependency configuration, or null if this system has no ordering constraints.
getPhysicsObject ( entity )
Gets the ScenePhysicsObject for an entity, if one exists.
Signature
fun getPhysicsObject(entity: Entity): ScenePhysicsObject?
Parameters
entity: Entity  The entity to get the physics object for
Returns
ScenePhysicsObject?  The ScenePhysicsObject or null if none exists
getScene ()
Returns the Scene that this system operates within. Delegates to the associated SystemManager to retrieve the active scene instance.
Signature
fun getScene(): Scene
Returns
Scene  The scene containing the entities and rendering state for this system.
hashCode ()
Returns the hash code of this system, based on its Kotlin class identity. Consistent with the SystemBase.equals implementation — systems of the same class produce the same hash code.
Signature
open override fun hashCode(): Int
Returns
Int  The hash code derived from this system's Kotlin class.