Class XrPlane

Represents a detected plane in the real world, providing its position, rotation, polygon points, and semantic label. The plane data may change over time as the system updates its understanding of the environment. Instances of this class are created and managed by the XrPlaneDetection system.

Hierarchy (View Summary)

Accessors

id label orientation points

Methods

fire getPosition getRotation hasEvent off on once

Events

EVENT_CHANGE EVENT_REMOVE

Accessors

id

label

  • get label(): string

  • Gets the semantic label of the plane provided by the underlying system. The label describes the type of surface the plane represents, such as "floor", "wall", "ceiling", etc. The list of possible labels can be found in the semantic labels repository.

    Returns string

    Example

    if (plane.label === 'floor') {
        console.log('This plane represents the floor.');
    } else if (plane.label === 'wall') {
        console.log('This plane represents a wall.');
    }

orientation

  • get orientation(): "horizontal" | "vertical"

  • Gets the plane's specific orientation. This can be "horizontal" for planes that are parallel to the ground, "vertical" for planes that are perpendicular to the ground, or null if the orientation is different or unknown.

    Returns "horizontal" | "vertical"

    Example

    if (plane.orientation === 'horizontal') {
        console.log('This plane is horizontal.');
    } else if (plane.orientation === 'vertical') {
        console.log('This plane is vertical.');
    } else {
        console.log('Orientation of this plane is unknown or different.');
    }

points

  • get points(): DOMPointReadOnly[]

  • Gets the array of points that define the polygon of the plane in its local coordinate space. Each point is represented as a DOMPointReadOnly object with x, y, and z properties. These points can be transformed to world coordinates using the plane's position and rotation.

    Returns DOMPointReadOnly[]

    Example

    // prepare reusable objects
    const transform = new pc.Mat4();
    const vecA = new pc.Vec3();
    const vecB = new pc.Vec3();

    // update Mat4 to plane position and rotation
    transform.setTRS(plane.getPosition(), plane.getRotation(), pc.Vec3.ONE);

    // draw lines between points
    for (let i = 0; i < plane.points.length; i++) {
        vecA.copy(plane.points[i]);
        vecB.copy(plane.points[(i + 1) % plane.points.length]);

        // transform points to world space
        transform.transformPoint(vecA, vecA);
        transform.transformPoint(vecB, vecB);

        // render line
        app.drawLine(vecA, vecB, pc.Color.WHITE);
    }

Methods

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

  • Fire an event, all additional arguments are passed on to the event listener.

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

    obj.fire('test', 'This is the message');

getPosition

getRotation

hasEvent

  • hasEvent(name: string): boolean

  • Test if there are any handlers bound to an event name.

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

    True if the object has handlers bound to the specified event name.

    Example

    obj.on('test', function () { }); // bind an event to 'test'
    obj.hasEvent('test'); // returns true
    obj.hasEvent('hello'); // returns false

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    const handler = function () {
    };
    obj.on('test', handler);

    obj.off(); // Removes all events
    obj.off('test'); // Removes all events called 'test'
    obj.off('test', handler); // Removes all handler functions, called 'test'
    obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

    obj.on('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event. This handler will be removed after being fired once.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    obj.once('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console
    obj.fire('test', 1, 2); // not going to get handled

Events

StaticEVENT_CHANGE

EVENT_CHANGE: string = 'change'

Fired when XrPlane attributes such as: orientation and/or points have been changed. Position and rotation can change at any time without triggering a change event.

Example

plane.on('change', () -> {
    // plane has been changed
});

StaticEVENT_REMOVE

EVENT_REMOVE: string = 'remove'

Fired when an XrPlane is removed.

Example

plane.once('remove', () => {
    // plane is not available anymore
});

Settings

Member Visibility

On This Page

Accessors
Methods
Events