Engine API Reference - v2.6.1
    Preparing search index...

    Class XrPlaneDetection

    Plane Detection provides the ability to detect real world surfaces based on estimations of the underlying AR system.

    // start session with plane detection enabled
    app.xr.start(camera, pc.XRTYPE_VR, pc.XRSPACE_LOCALFLOOR, {
        planeDetection: true
    });

    app.xr.planeDetection.on('add', (plane) => {
        // new plane been added
    });

    Hierarchy (View Summary)

    Index

    Accessors

    available planes supported

    Methods

    fire hasEvent off on once

    Events

    EVENT_ADD EVENT_AVAILABLE EVENT_REMOVE EVENT_UNAVAILABLE

    Accessors

    • get available(): boolean

      True if Plane Detection is available. This information is available only when the session has started.

      Returns boolean

    Methods

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

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

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

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

    • 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: any

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

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      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

    • 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: any = ...

        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.

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

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

    • 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: any = ...

        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.
      obj.once('test', (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

    EVENT_ADD: string = 'add'

    Fired when new XrPlane is added to the list. The handler is passed the XrPlane instance that has been added.

    app.xr.planeDetection.on('add', (plane) => {
        // new plane is added
    });
    EVENT_AVAILABLE: string = 'available'

    Fired when plane detection becomes available.

    app.xr.planeDetection.on('available', () => {
        console.log('Plane detection is available');
    });
    EVENT_REMOVE: string = 'remove'

    Fired when a XrPlane is removed from the list. The handler is passed the XrPlane instance that has been removed.

    app.xr.planeDetection.on('remove', (plane) => {
        // new plane is removed
    });
    EVENT_UNAVAILABLE: string = 'unavailable'

    Fired when plane detection becomes unavailable.

    app.xr.planeDetection.on('unavailable', () => {
        console.log('Plane detection is unavailable');
    });

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Events