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

IsdkDefaultCursorSystem Class

Extends SystemBase
 Modifiers: final

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
cursorConfigScale : Float
[Get][Set]
Signature 
var cursorConfigScale: Float
cursorConfigScaleMultiplier : Float
[Get][Set]
Signature 
var cursorConfigScaleMultiplier: Float
cursorConfigZOffset : Float
[Get][Set]
Signature 
var cursorConfigZOffset: Float
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 system manager that this system is associated with.
Signature 
lateinit var systemManager: SystemManager
unifiedCursorConfigHoverStrength : Float
[Get][Set]
Signature 
var unifiedCursorConfigHoverStrength: Float
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 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 override fun destroy()
enableInput ( enabled )
Signature 
fun enableInput(enabled: Boolean)
Parameters
enabled: Boolean
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
SystemDependencies?  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
Scene  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.

Inner Classes

EntityHitInfo Class

Modifiers: final

Signature

data class EntityHitInfo(val hitInfo: HitInfo, val isSelecting: Boolean, val isLaserHidden: Boolean, val isHandDevice: Boolean, val laserAlpha: Float, val unifiedCursorAlpha: Float, val sourceOrigin: Pose)

Constructors

EntityHitInfo ( hitInfo , isSelecting , isLaserHidden , isHandDevice , laserAlpha , unifiedCursorAlpha , sourceOrigin )
Signature 
constructor(hitInfo: HitInfo, isSelecting: Boolean, isLaserHidden: Boolean, isHandDevice: Boolean, laserAlpha: Float, unifiedCursorAlpha: Float, sourceOrigin: Pose)
Parameters
hitInfo: HitInfo
isSelecting: Boolean
isLaserHidden: Boolean
isHandDevice: Boolean
laserAlpha: Float
unifiedCursorAlpha: Float
sourceOrigin: Pose
Returns
IsdkDefaultCursorSystem.EntityHitInfo

Properties

hitInfo : HitInfo
[Get]
Signature 
val hitInfo: HitInfo
isHandDevice : Boolean
[Get]
Signature 
val isHandDevice: Boolean
isLaserHidden : Boolean
[Get]
Signature 
val isLaserHidden: Boolean
isSelecting : Boolean
[Get]
Signature 
val isSelecting: Boolean
laserAlpha : Float
[Get]
Signature 
val laserAlpha: Float
sourceOrigin : Pose
[Get]
Signature 
val sourceOrigin: Pose
unifiedCursorAlpha : Float
[Get]
Signature 
val unifiedCursorAlpha: Float

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

UnifiedMorphCursorAttributes Class

Modifiers: final

Signature

data class UnifiedMorphCursorAttributes(var radius: Float, var finalAlpha: Float, var innerAlpha: Float, var blurStrength: Float, var selectionStrength: Float, var actuationStrength: Float, var hoverColor: Float)

Constructors

UnifiedMorphCursorAttributes ( radius , finalAlpha , innerAlpha , blurStrength , selectionStrength , actuationStrength , hoverColor )
Signature 
constructor(radius: Float, finalAlpha: Float, innerAlpha: Float, blurStrength: Float, selectionStrength: Float, actuationStrength: Float, hoverColor: Float)
Parameters
radius: Float
finalAlpha: Float
innerAlpha: Float
blurStrength: Float
selectionStrength: Float
actuationStrength: Float
hoverColor: Float
Returns
IsdkDefaultCursorSystem.UnifiedMorphCursorAttributes

Properties

actuationStrength : Float
[Get][Set]
Signature 
var actuationStrength: Float
blurStrength : Float
[Get][Set]
Signature 
var blurStrength: Float
finalAlpha : Float
[Get][Set]
Signature 
var finalAlpha: Float
hoverColor : Float
[Get][Set]
Signature 
var hoverColor: Float
innerAlpha : Float
[Get][Set]
Signature 
var innerAlpha: Float
radius : Float
[Get][Set]
Signature 
var radius: Float
selectionStrength : Float
[Get][Set]
Signature 
var selectionStrength: Float

MorphCursorAttributes Class

Modifiers: final

Signature

data class MorphCursorAttributes(var finalAlpha: Float, var selectionStrength: Float, var ringAnimationPercent: Float)

Constructors

MorphCursorAttributes ( finalAlpha , selectionStrength , ringAnimationPercent )
Signature 
constructor(finalAlpha: Float, selectionStrength: Float, ringAnimationPercent: Float)
Parameters
finalAlpha: Float
selectionStrength: Float
ringAnimationPercent: Float
Returns
IsdkDefaultCursorSystem.MorphCursorAttributes

Properties

finalAlpha : Float
[Get][Set]
Signature 
var finalAlpha: Float
ringAnimationPercent : Float
[Get][Set]
Signature 
var ringAnimationPercent: Float
selectionStrength : Float
[Get][Set]
Signature 
var selectionStrength: Float
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta