Model Entry Door Guide

ModelEntryDoorGuidePlugin

Overview

The Model Entry Door Guide plugin provides a set of features for displaying the entry-door marker of a scene while in model view.

Detailed feature points:

• In model view, mark the entry door of the space with an animated model indicator.

External Demo

Open the Model Entry Door Guide demo. In the external demo, choose Space Overview to view the entry-door marker.

Installation

Choose either yarn or npm as needed:

npm install @realsee/dnalogel

Import via ES modules:

import { ModelEntryDoorGuidePlugin } from "@realsee/dnalogel"

Development Guide

Initialization

When creating the Five instance, pass ModelEntryDoorGuidePlugin in the initialization plugins parameter.

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

const five = new Five({
    plugins: [
        [
            ModelEntryDoorGuidePlugin,
            'modelEntryDoorGuidePlugin', // custom plugin name
            {
                // parameter configuration
            }
        ]
    ]
})

Loading Data

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

// Call the `load` method to load the model house tag data
pluginInstance.load(modelEntryDoorGuidePluginData)

Core Methods

• load(data: ModelEntryDoorGuidePluginData) — load plugin data

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

• enable: (config?: { animationEnable?: boolean /** whether to enable the animation effect */ }) => void — enable the plugin
• disable: () => void — disable the plugin

Source Reference

ModelEntryDoorGuidePlugin example source