Interface TrackedPlane

A representation for plane detected by native tracking. Can be used with TrackedPoint.

Example

// @input Component.RenderMeshVisual renderMeshVisual

script.createEvent("WorldTrackingPlanesAddedEvent").bind(function (eventData) {
    var eventPlanes = eventData.getPlanes();

    for (var i = 0; i < eventPlanes.length; i++) {
      var eventPlane = eventPlanes[i];
      
      script.renderMeshVisual.mesh = eventPlane.mesh;
    }
});
interface TrackedPlane {
    isValid: boolean;
    mesh: RenderMesh;
    orientation: TrackedPlaneOrientation;
    pivot: vec3;
    size: vec3;
    transform: mat4;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

isValid mesh orientation pivot size transform

Methods

getTypeName isOfType isSame

Properties

ReadonlyisValid

isValid: boolean

Whether the detected plane is still available to utilize

Readonlymesh

mesh: RenderMesh

A coarse mesh describing the shape of the tracked plane. Can be displayed by RenderMeshVisual

Readonlyorientation

orientation: TrackedPlaneOrientation

Returns the orientation of the detected plane, either vertical or horizontal.

Readonlypivot

pivot: vec3

The center point of the detected plane

Readonlysize

size: vec3

The size of the detected plane, where it is described as width, 0, depth

Readonlytransform

transform: mat4

The position, rotation, and scale of the detected plane

Methods

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods