Skip to main content

WorldTrackingMeshesAddedEvent

Class

Triggered when new world tracking meshes are detected.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Triggered when new world tracking meshes are detected. Only available when a Device Tracking component is in the scene, and world mesh tracking is supported and enabled. In addition, DeviceTracking component must be set to World mode to orient the Camera relative to the mesh correctly.

Index

Example

script.createEvent("WorldTrackingMeshesAddedEvent").bind(onMeshesAdded);

function onMeshesAdded(eventData) {
var trackedMeshes = eventData.getMeshes();
print(trackedMeshes.length + " meshes were added");

for (var i = 0; i < trackedMeshes.length; i++) {
print("TrackedMesh is valid " + trackedMeshes[i].isValid);
print("Transformation matrix " + trackedMeshes[i].transform);
}
}

Extends

Properties

enabled

enabled: boolean

If true, the event is able to trigger. If false, the event will not trigger.

Default Value

true

Inherited from

SceneEvent.enabled

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

SceneEvent.bind


getMeshes()

getMeshes(): TrackedMesh[]

Returns an array of newly added Tracked Meshes.

Returns

TrackedMesh[]


getTypeName()

static getTypeName(): TypeName<WorldTrackingMeshesAddedEvent>

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

Overrides

SceneEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

SceneEvent.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

SceneEvent.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

SceneEvent.isSame