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
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 the system has been executed. 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 system manager that this system is associated with. 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

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