API reference

IsdkDefaultCursorSystem Class

Extends SystemBase
 Modifiers: final
System that renders affordances for hovered/selected interactables. When an interaction is active on a mesh surface, this system will render a cursor on at the interaction world location, and a ray towards it from the interactor (hand or controller).
This system subscribes to PointerEvents from the IsdkSystem to determine which cursor visuals should be drawn.
To disable the default cursor visuals, set this system to inactive via the enableInput method.

Constructors

IsdkDefaultCursorSystem ( ctx , isdkSystem )
Signature 
constructor(ctx: Context, isdkSystem: IsdkSystem)
Parameters
ctx: Context
isdkSystem: IsdkSystem
Returns
IsdkDefaultCursorSystem

Properties

active : Boolean
[Get]
Signature 
var active: Boolean
ctx : Context
[Get]
Signature 
val ctx: Context
cursorConfigActuatedRatio : Float
[Get][Set]
Signature 
var cursorConfigActuatedRatio: Float
cursorConfigDepthScale : Float
[Get][Set]
Signature 
var cursorConfigDepthScale: Float
cursorConfigDepthZOffset : Float
[Get][Set]
Signature 
var cursorConfigDepthZOffset: Float
cursorConfigScale : Float
[Get][Set]
Signature 
var cursorConfigScale: Float
cursorConfigScaleMultiplier : Float
[Get][Set]
Signature 
var cursorConfigScaleMultiplier: Float
cursorConfigZOffset : Float
[Get][Set]
Signature 
var cursorConfigZOffset: Float
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.
@Volatile guarantees atomic 64-bit reads + happens-before semantics so the introspection reader (which runs on the dump caller's thread) observes a consistent value. Only SystemBase.incrementExecuteCount writes this field, so the non-atomic read-modify-write is safe.
Signature 
var executeCount: Long
isdkSystem : IsdkSystem
[Get]
Signature 
val isdkSystem: IsdkSystem
laserConfigColorActuated : Vector3
[Get][Set]
Signature 
var laserConfigColorActuated: Vector3
laserConfigColorNormal : Vector3
[Get][Set]
Signature 
var laserConfigColorNormal: Vector3
laserConfigDefault : IsdkDefaultCursorSystem.PerDeviceLaserConfig
[Get][Set]
Signature 
var laserConfigDefault: IsdkDefaultCursorSystem.PerDeviceLaserConfig
laserConfigFadeTime : Float
[Get][Set]
Signature 
var laserConfigFadeTime: Float
laserConfigHand : IsdkDefaultCursorSystem.PerDeviceLaserConfig
[Get][Set]
Signature 
var laserConfigHand: IsdkDefaultCursorSystem.PerDeviceLaserConfig
laserConfigMaxLength : Float
[Get]
Signature 
val laserConfigMaxLength: Float = 0.25f
laserConfigWidth : Float
[Get][Set]
Signature 
var laserConfigWidth: Float
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
unifiedCursorConfigRadiusLeastPinch : Float
[Get][Set]
Signature 
var unifiedCursorConfigRadiusLeastPinch: Float
unifiedCursorConfigRadiusMostPinch : Float
[Get][Set]
Signature 
var unifiedCursorConfigRadiusMostPinch: Float
unifiedCursorConfigScale : Float
[Get][Set]
Signature 
var unifiedCursorConfigScale: Float

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 entity 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. Subclasses must call super.destroy() so the framework can clean up auto-registered introspection nodes.
Signature 
open override fun destroy()
enableInput ( enabled )
Signature 
fun enableInput(enabled: Boolean)
Parameters
enabled: Boolean
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.

Inner Class

PerDeviceLaserConfig Class

Modifiers: final

Signature

data class PerDeviceLaserConfig(val surfaceOffset: Float, val originOffset: Float, val farToNearFadeLength: Float, val nearToFarFadeLength: Float)

Constructors

PerDeviceLaserConfig ( surfaceOffset , originOffset , farToNearFadeLength , nearToFarFadeLength )
Signature 
constructor(surfaceOffset: Float, originOffset: Float, farToNearFadeLength: Float, nearToFarFadeLength: Float)
Parameters
surfaceOffset: Float
originOffset: Float
farToNearFadeLength: Float
nearToFarFadeLength: Float
Returns
IsdkDefaultCursorSystem.PerDeviceLaserConfig

Properties

farToNearFadeLength : Float
[Get]
Signature 
val farToNearFadeLength: Float
nearToFarFadeLength : Float
[Get]
Signature 
val nearToFarFadeLength: Float
originOffset : Float
[Get]
Signature 
val originOffset: Float
surfaceOffset : Float
[Get]
Signature 
val surfaceOffset: Float
Meta
English (US)
© 2026 Meta