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

GrabbableSystem Class

Extends SystemBase
Modifiers: final
DeprecatedThis system is deprecated and has been replaced by IsdkSystem. To use this system instead, change the inputSystemType argument on VrFeature.
GrabbableSystem is a System that allows for grabbing of objects in the scene. It is responsible for detecting when an object is grabbed and then updating the object's position and rotation to match the grabber's position and rotation. It also handles the release of the object when the grabber releases it.
This System comes default with Meta Spatial SDK and operates on entities with Grabbable components. It interacts with Controller components to detect grab inputs and can affect Followable components by disabling them during grabs.

Signature

class GrabbableSystem : SystemBase

Constructors

GrabbableSystem ()
Signature
constructor()

Properties

active : Boolean
[Get][Set]
Signature
var active: Boolean
executeCount : Long
[Get]
The number of times the system has been executed.
Signature
var executeCount: Long
grabButtons : Int
[Get][Set]
The default is just grabbing with the grip buttons. You can change the grab buttons by accessing the grabButtons variable of the GrabbableSystem:
Example:
systemManager.findSystem<GrabbableSystem>().grabButtons = (ButtonBits.ButtonSqueezeR or
ButtonBits.ButtonSqueezeL or ButtonBits.ButtonX)

Signature
var grabButtons: Int
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 GrabbableSystem.delete being removed from the scene
Signature
open override fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
System should clean up any and all resources for shutdown
Signature
open fun destroy()
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 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?