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

CastInputForwardSystem Class

Extends SystemBase
Modifiers: final
CastInputForwardSystem manages the communication between a Spatial SDK app and the MQDH Cast window. Per execute() tick it retrieves the updated mouse/keyboard state info from MQDH Cast and processes the info to manipulate the camera/send input down into the Spatial SDK application.

Signature

class CastInputForwardSystem(val vrActivity: VrActivity, val initialPose: Pose? = null) : SystemBase

Constructors

CastInputForwardSystem ( vrActivity , initialPose )
Signature
constructor(vrActivity: VrActivity, initialPose: Pose? = null)
Parameters
vrActivity: VrActivity  The VrActivity of the Spatial SDK application.
initialPose: Pose?  Optional pose to initialize the virtual camera with. If null, uses Scene.getViewOrigin().

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
initialPose : Pose?
[Get]
Optional pose to initialize the virtual camera with. If null, uses Scene.getViewOrigin().
Signature
val initialPose: Pose? = null
maxPointerDistance : Float
[Get]
Signature
val maxPointerDistance: Float = 5.0f
movementSpeed : Float
[Get][Set]
Signature
var movementSpeed: Float
pitchSensitivity : Float
[Get]
Signature
val pitchSensitivity: Float = 100.0f
shiftMultiplier : Float
[Get][Set]
Signature
var shiftMultiplier: 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
vrActivity : VrActivity
[Get]
The VrActivity of the Spatial SDK application.
Signature
val vrActivity: VrActivity
yawSensitivity : Float
[Get]
Signature
val yawSensitivity: Float = 100.0f

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.
calculateDirectionVector ( normalizedX , normalizedY , fovLeft , fovRight , fovUp , fovDown )
Signature
fun calculateDirectionVector(normalizedX: Double, normalizedY: Double, fovLeft: Double, fovRight: Double, fovUp: Double, fovDown: Double): Vector3
Parameters
normalizedX: Double
normalizedY: Double
fovLeft: Double
fovRight: Double
fovUp: Double
fovDown: Double
Returns
Vector3
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 override fun destroy()
destroyPanelAppStreamer ()
Signature
fun destroyPanelAppStreamer()
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.
onPause ()
Signature
fun onPause()
onResume ()
Signature
fun onResume()
setEnabled ( enabled )
Signature
fun setEnabled(enabled: Boolean)
Parameters
enabled: Boolean