WorldTrackingPlanesAddedEvent
ClassTriggered when plane(s) are newly detected.
- Available on all platforms
Since Lens Scripting v144
Triggered when plane(s) are newly detected. 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("WorldTrackingPlanesAddedEvent").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
Methods
bind()
bind(
evCallback):void
Binds a callback function to this event.
Parameters
| Parameter | Type |
|---|---|
evCallback | (arg1) => void |
Returns
void
Inherited from
getPlanes()
getPlanes():
TrackedPlane[]
Returns an array of newly added TrackedPlane.
Returns
Since
Lens Scripting Version 144
getTypeName()
staticgetTypeName():TypeName<WorldTrackingPlanesAddedEvent>
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<WorldTrackingPlanesAddedEvent>
Since
Lens Scripting Version 144
Overrides
getTypeName()
getTypeName():
string
Returns the typename of the SceneEvent.
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