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

MicrogesturesSystem Class

Extends SystemBase
Modifiers: final
System for handling microgesture detection and state management.
This system monitors microgesture state changes and provides an API for other systems to register listeners for these changes.
Example usage:
// Register a listener and get a handle
val handle = microgesturesSystem.addListener { microgestureBit, isActive ->
    when (microgestureBit) {
        MicrogestureBits.LeftMicrogestureSwipeLeft -> {
            // Handle left hand swipe left
        }
        MicrogestureBits.RightMicrogestureTapThumb -> {
            // Handle right hand thumb tap
        }
        // Handle other microgestures...
    }
}
// Remove the listener when no longer needed
microgesturesSystem.removeListener(handle)

Signature

class MicrogesturesSystem : SystemBase

Constructors

MicrogesturesSystem ()
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

addListener ( listener )
Add a listener for microgesture state changes
Signature
fun addListener(listener: MicrogestureStateChangeListener): MicrogestureListenerHandle
Parameters
  The lambda function to call when a microgesture state changes
Returns
  A handle that can be used to remove the listener
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()
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.
removeListener ( handle )
Remove a listener for microgesture state changes
Signature
fun removeListener(handle: MicrogestureListenerHandle): Boolean
Parameters
  The handle returned from addListener
Returns
Boolean
  True if the listener was removed, false if the handle was invalid
Did you find this page helpful?