Class SyncKitBridge

This class helps bridge native SIK components with SpectaclesSyncKit if SpectaclesSyncKit is present in the lens and isSynced is enabled for certain SIK components, such as ScrollView, Slider, ToggleButton, Container, and InteractableManipulation.

This class is not meant to be used by developers for syncing logic, please use SpectaclesSyncKit APIs directly!

Index

Constructors

Properties

Accessors

locatedAtComponent networkIdTools sessionController SyncEntity

Methods

createSyncEntity locationQuatToWorldQuat locationTransformToWorldTransform locationVec3ToWorldVec3 worldQuatToLocationQuat worldTransformToLocationTransform worldVec3ToLocationVec3

Constructors

constructor

new SyncKitBridge(): SyncKitBridge
Returns SyncKitBridge

Properties

`Static`getInstance

getInstance: () => SyncKitBridge

Accessors

locatedAtComponent

get locatedAtComponent(): LocatedAtComponent
Returns the LocatedAtComponent of the Colocated World if using a Connected Lens.

Returns LocatedAtComponent

networkIdTools

get networkIdTools(): any
Returns any

sessionController

get sessionController(): any
Returns any

SyncEntity

get SyncEntity(): any
Returns any

Methods

createSyncEntity

createSyncEntity(script: ScriptComponent): any
Create a SyncEntity for a given script if SyncKit is present within the lens.
Parameters
- script: ScriptComponent
  the given script to attach the SyncEntity to.
Returns any
a SyncEntity if SyncKit is present, null if otherwise.

locationQuatToWorldQuat

locationQuatToWorldQuat(quat: quat): quat
Maps a quat local to the LocatedAt component's transform to a world quat.
Parameters
- quat: quat
Returns quat

locationTransformToWorldTransform

locationTransformToWorldTransform(matTransform: mat4): mat4
Maps a mat4 local to the LocatedAt component's transform to a world mat4.
Parameters
- matTransform: mat4
Returns mat4

locationVec3ToWorldVec3

locationVec3ToWorldVec3(vec: vec3): vec3
Maps a vec3 local to the LocatedAt component's transform to a world vec3.
Parameters
- vec: vec3
Returns vec3

worldQuatToLocationQuat

worldQuatToLocationQuat(quat: quat): quat
Maps a world quat into a quat local to the LocatedAt component's transform.
Parameters
- quat: quat
Returns quat

worldTransformToLocationTransform

worldTransformToLocationTransform(matTransform: mat4): mat4
Maps a world mat4 into a mat4 local to the LocatedAt component's transform.
Parameters
- matTransform: mat4
Returns mat4

worldVec3ToLocationVec3

worldVec3ToLocationVec3(vec: vec3): vec3
Maps a world vec3 into a vec3 local to the LocatedAt component's transform.
Parameters
- vec: vec3
Returns vec3