Skip to main content

WorldTrackingPlanesUpdatedEvent

Class

Triggered when currently detected plane(s) are updated.

  • 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.

Since Lens Scripting v144

Triggered when currently detected plane(s) are updated. This usually happens when a plane grows in size. The worldOptions.nativePlaneTrackingType must be set to anything other than NativePlaneTrackingType.None. In addition, DeviceTracking component must be set to World mode to orient the Camera relative to the planes correctly.

Index

Example

//@input Component.DeviceTracking deviceTracking
script.deviceTracking.worldOptions.nativePlaneTrackingType = NativePlaneTrackingType.Both;

script.createEvent("WorldTrackingPlanesUpdatedEvent").bind(function(eventData){

var eventPlanes = eventData.getPlanes();

});

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


getPlanes()

getPlanes(): TrackedPlane[]

Returns an array of TrackedPlane that were updated.

Returns

TrackedPlane[]

Since

Lens Scripting Version 144


getTypeName()

static getTypeName(): TypeName<WorldTrackingPlanesUpdatedEvent>

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

Since

Lens Scripting Version 144

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