ColocatedTrackingComponent
ClassAllows SceneObject to be tracked in a Connected Lens Experience.
- Available on all platforms
Since Lens Scripting v148
Index
Properties
Methods
Remarks
Creates Colocated Connected Lenses experiences by enabling the creation and tracking of a shared space which can be used to place several users in the same coordinate frame. This shared space will be made available and can be tracked by any friend you invite to join your session via Snapcode. Users are expected to be located in the same room when using the colocated feature. This component needs to be attached to the camera.
Extends
Properties
buildingProgress
readonlybuildingProgress:number
Provides the shared space building progress expressed in values 0-1. These values can be used to populate a progress bar. Once this value has reached 1, the colocated tracking component attempts to share the space which the user created.
Since
Lens Scripting Version 148
canBuild
readonlycanBuild:boolean
Indicates whether a shared space can be built on this device. Colocated Tracking is available on devices with ARKit/ARCore in the rear camera. This flag should be checked before attempting to build or join a session. If it is false, you should inform users: "Sorry, your device does not support shared AR experiences."
Since
Lens Scripting Version 149
canTrack
readonlycanTrack:boolean
Indicates whether a shared space is present and ready to be tracked.
Since
Lens Scripting Version 148
enabled
enabled:
boolean
If disabled, the Component will stop enacting its behavior.
Default Value
true
Inherited from
isBeingDestroyed
readonlyisBeingDestroyed:boolean
Returns true if this Component is currently being destroyed. Becomes true as soon as
destruction begins via Component#destroy or destruction of its owning SceneObject,
before any OnDestroyEvent callbacks fire.
Since
Lens Scripting Version 364
Example
if (!script.isBeingDestroyed) {
// Component is still fully alive
}
Inherited from
isBuilding
readonlyisBuilding:boolean
Indicates whether a shared space building operation is in progress. Once the flag is false, the shared space still needs to be shared. Use onTrackingAvailable to determine when your space has been shared.
Since
Lens Scripting Version 148
isEnabledInHierarchy
readonlyisEnabledInHierarchy:boolean
Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
Inherited from
Component.isEnabledInHierarchy
isJoining
readonlyisJoining:boolean
Indicates whether a session joining operation is in progress.
Since
Lens Scripting Version 148
isTracking
readonlyisTracking:boolean
Indicates whether a shared space is actively being tracked. This value will be true while tracking is active, either with or without the shared space in view. This property matches the equivalent one in MarkerTrackingComponent.
Since
Lens Scripting Version 148
onBuildFailed
readonlyonBuildFailed:event0<void>
Event fired when the building operation fails (for example, sharing your space failed). Once onTrackingAvailable event is triggered, this event will not be triggered anymore.
Since
Lens Scripting Version 148
onFound
readonlyonFound:event0<void>
Event fired when a shared space starts being actively tracked. This property is an analogue of the onMarkerFound property in MarkerTrackingComponent.
Since
Lens Scripting Version 148
onJoinFailed
readonlyonJoinFailed:event0<void>
Event fired when a join operation completes but no shared space was found in the session.
Since
Lens Scripting Version 148
onLost
readonlyonLost:event0<void>
Event fired when a shared space stops being actively tracked. This property is an analogue of the onMarkerLost property in MarkerTrackingComponent.
Since
Lens Scripting Version 148
onTrackingAvailable
readonlyonTrackingAvailable:event0<void>
Event fired when a shared space has been shared or received and the device can attempt to start tracking. If this event is not being triggered for a long period, the process will time out and onBuildFailed event will be triggered.
Since
Lens Scripting Version 148
sceneObject
readonlysceneObject:SceneObject
The SceneObject this component is on.
Inherited from
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
Methods
destroy()
destroy():
void
Destroys the component.
Returns
void
Inherited from
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject the component is attached to.
Returns
Inherited from
getTransform()
getTransform():
Transform
Returns the Transform this component is attached to.
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<ColocatedTrackingComponent>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<ColocatedTrackingComponent>
Since
Lens Scripting Version 148
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
join()
join(
session):void
Joins an existing session, retrieving the shared space that the colocated session initiator just created. Throws an exception if a join or build operation is in progress or if a shared space is already present.
Parameters
| Parameter | Type |
|---|---|
session | MultiplayerSession |
Returns
void
Since
Lens Scripting Version 148
startBuilding()
startBuilding(
session):void
Starts the shared space building process locally in the session initiator's device.
If a session is provided, the shared space is placed into the session after building has completed, which is required for Colocated experiences running on mobile devices. When running the experience in Lens Studio Preview or solo mode the session is not required.
Throws an exception if a join or build operation is in progress or if a map is already present.
Parameters
| Parameter | Type |
|---|---|
session | MultiplayerSession |
Returns
void
Since
Lens Scripting Version 148