Panorama Ruler Pro

PanoRulerProPlugin

Overview

The Panorama Ruler plugin lets you annotate the dimensions of a property's key contours in panorama mode.

Detailed features:

• Annotate the dimensions of a property's key contours in panorama mode, such as the ceiling height, frontage width, and depth of individual rooms.
• Compared with the standard ruler, it adds object recognition and wall-occlusion detection, rendering occluded segments as dashed lines, and includes refined styling that conveys a stronger sense of space. It currently supports only real-scene VR scenes, only single-floor properties captured with Galois, and only residential spaces under 200 square meters; it does not support unfinished (bare-shell) properties and requires a designated range to be pre-processed before the client-side entry point can be enabled.
• Only shows the ruler lines near the center of the current viewing angle.
• As you move between capture points and change the viewing angle, the ruler lines move and transform along with you.
• Adaptive value-bubble length: the bubble length adapts to the value content, and the value content can also be configured for special requirements, such as displaying values with inch units.
• If a ruler line is shorter than its value bubble, that ruler line is not displayed.

Differences from the Standard Panorama Ruler

Improvements

1. More accurate ceiling-height data: Based on previous offline measurement data, the 1.0 ruler had a ceiling-height error of around 10 cm, one of its main pain points. The 2.0 ruler reduces this error to within 3 cm through algorithmic optimization.
2. More accurate annotation positioning: The 2.0 ruler uses optimized wall-line algorithm recognition, so the ruler is displayed in positions that better match the real wall lines.
3. Better display experience: The 2.0 ruler adds object recognition and wall-occlusion detection, renders occluded segments as dashed lines, and refines the styling to convey a stronger sense of space.

Limitations

1. Currently supports only real-scene VR scenes.
2. Supports only single-floor properties captured with Galois.
3. Applies only to residential spaces under 200 square meters; does not support unfinished (bare-shell) properties.
4. Requires you to contact Realsee to designate the VR range for data production; the feature can only be used after that data has been produced.

Example

Open the official PanoRulerProPlugin demo.

Installation

Choose either the yarn or npm installation method as needed:

npm install @realsee/dnalogel

Import via ES module:

import { PanoRulerProPlugin } from "@realsee/dnalogel";

Development Guide

Initialization

When initializing the Five instance, configure PanoRulerProPlugin in the plugin initialization parameters.

import { Five } from "@realsee/five";
import { PanoRulerProPlugin } from "@realsee/dnalogel";

const five = new Five({
  plugins: [
    [
      PanoRulerProPlugin,
      "panoRulerProPlugin", // custom plugin name
      {
        // parameter configuration
      },
    ],
  ],
});

Loading Data

// Get the plugin instance, where `panoRulerProPlugin` is the custom name set during initialization
const pluginInstance = five.plugins.panoRulerProPlugin;

// Call the `load` method to load the panorama ruler data
pluginInstance.load(data, {
  distanceText: (distance) => `Approx. ${distance.toFixed(1)} m`,
});

Core Methods

• load: (serverData: PanoRulerProPluginDatas) => Promise<boolean> Loads the plugin data

You need to load the plugin data manually. For the data source, see the OpenAPI documentation.

• enable: () => void Enables the ruler
• disable: () => void Disables the ruler

Source Reference

PanoRulerProPlugin example source