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 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
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

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