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

InputSystem Class

Extends SystemBase
Modifiers: final
DeprecatedThis system is deprecated and has been replaced by IsdkSystem. To use this system instead, change the inputSystemType argument on VrFeature.

Constructors

InputSystem ( locomotionSystem , ctx )
Signature
constructor(locomotionSystem: LocomotionSystem, ctx: Context)
Parameters
locomotionSystem: LocomotionSystem
ctx: Context

Properties

active : Boolean
[Get]
Signature
var active: Boolean
ctx : Context
[Get]
Signature
val ctx: Context
cursorActuatedRatio : Float
[Get][Set]
Signature
var cursorActuatedRatio: Float
cursorDepthScale : Float
[Get][Set]
Signature
var cursorDepthScale: Float
cursorScale : Float
[Get][Set]
Signature
var cursorScale: Float
cursorScaleMultiplier : Float
[Get][Set]
Signature
var cursorScaleMultiplier: Float
directInputEnabled : Boolean
[Get]
Signature
var directInputEnabled: Boolean
executeCount : Long
[Get]
The number of times the system has been executed.
Signature
var executeCount: Long
locomotionSystem : LocomotionSystem
[Get]
Signature
val locomotionSystem: LocomotionSystem
maxPointerDistance : Float
[Get][Set]
Signature
var maxPointerDistance: Float
preBuiltQuery : BuiltQuery
[Get]
Signature
val preBuiltQuery: BuiltQuery
selectButtons : Int
[Get][Set]
Signature
var selectButtons: Int
systemManager : SystemManager
[Get][Set]
The system manager that this system is associated with.
Signature
lateinit var systemManager: SystemManager
touchButtons : Int
[Get][Set]
Signature
var touchButtons: Int

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()
enableDirectInput ( enabled )
Signature
fun enableDirectInput(enabled: Boolean)
Parameters
enabled: Boolean
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
  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.
setLeftHandDirectionOverride ( lookDirection )
Overrides the natural direction of the left hand controller with a custom look direction. When set, the controller's pose rotation will be calculated using this direction instead of the controller's natural orientation.
Signature
fun setLeftHandDirectionOverride(lookDirection: Vector3?)
Parameters
lookDirection: Vector3?
  The direction vector to override the left hand controller's look direction, or null to disable the override and use natural controller orientation. Example:
// Point left hand controller towards a specific target
val targetDirection = Vector3(1.0f, 0.0f, 0.0f) // Point right
inputSystem.setLeftHandDirectionOverride(targetDirection)
// Restore natural controller orientation
inputSystem.setLeftHandDirectionOverride(null)

setRightHandDirectionOverride ( lookDirection )
Overrides the natural direction of the right hand controller with a custom look direction. When set, the controller's pose rotation will be calculated using this direction instead of the controller's natural orientation.
Signature
fun setRightHandDirectionOverride(lookDirection: Vector3?)
Parameters
lookDirection: Vector3?
  The direction vector to override the right hand controller's look direction, or null to disable the override and use natural controller orientation. Example:
// Point right hand controller towards a specific target
val targetDirection = Vector3(-1.0f, 0.0f, 0.0f) // Point left
inputSystem.setRightHandDirectionOverride(targetDirection)
// Restore natural controller orientation
inputSystem.setRightHandDirectionOverride(null)

Companion Object

Companion Object Properties

DEFAULT_CURSOR_ACTUATED_RATIO : Float
[Get]
Signature
val DEFAULT_CURSOR_ACTUATED_RATIO: Float
DEFAULT_CURSOR_DEPTH_SCALE : Float
[Get]
Signature
val DEFAULT_CURSOR_DEPTH_SCALE: Float = 0.0112f
DEFAULT_CURSOR_SCALE : Float
[Get]
Signature
val DEFAULT_CURSOR_SCALE: Float = 3.2E-4f
DEFAULT_CURSOR_SCALE_MULTIPLIER : Float
[Get]
Signature
val DEFAULT_CURSOR_SCALE_MULTIPLIER: Float = 0.75f
Did you find this page helpful?