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

GrabbablePhysicsSystem Class

Extends SystemBase
Modifiers: final
System that manages physics state changes for grabbable entities. When an entity is grabbed, its physics state is switched to KINEMATIC. When released, the physics state is restored to its original value.

Signature

class GrabbablePhysicsSystem : SystemBase

Constructors

GrabbablePhysicsSystem ()
Signature
constructor()

Properties

executeCount : Long
[Get]
The number of times the system has been executed.
Signature
var executeCount: Long
systemManager : SystemManager
[Get][Set]
The system manager that this system is associated with.
Signature
lateinit var systemManager: SystemManager

Functions

associateSystemManager ( systemManager )
Associates this system with a system manager, used in the Spatial SDK.
Signature
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager
  The system manager to associate with.
delete ( entity )
System should do any housekeeping based on SystemBase.delete being removed from the scene
Signature
open fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
System should clean up any and all resources for shutdown
Signature
open fun destroy()
enableGrabbablePhysics ( enabled )
Enables or disables the grabbable physics behavior. When disabled, the system will not modify physics states when entities are grabbed.
Signature
fun enableGrabbablePhysics(enabled: Boolean = true)
Parameters
enabled: Boolean
  Whether to enable grabbable physics behavior. Defaults to true.
equals ( other )
Checks if this system is equal to another object.
Signature
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?
  The object to compare with.
Returns
Boolean
  True if this system is equal to the other object, false otherwise.
execute ()
System should perform all the operations based on relevant entities.
Signature
open override fun execute()
getDependencies ()
Returns the dependencies of this system.
Signature
open override fun getDependencies(): SystemDependencies?
Returns
  The dependencies of this system, or null if there are no dependencies.
getScene ()
Returns the scene that this system is associated with.
Signature
fun getScene(): Scene
Returns
  The scene that this system is associated with.
hashCode ()
Returns the hash code of this system.
Signature
open override fun hashCode(): Int
Returns
Int
  The hash code of this system.
Did you find this page helpful?