模型底盘指南针
ModelChassisCompassPlugin
功能说明
模型底盘指南针插件 集成了一套能够在模型状态下查看模型朝向的指南针底盘
详细功能点如下:
- 在模型态下,使用指南针模型标识模型物理朝向。
效果展示
点击空间总览按钮,查看空间总览模态下的模型底盘指南针。
安装引用
请按需选择 yarn
或 npm
安装方式:
- npm
- Yarn
- pnpm
npm install @realsee/dnalogel
yarn add @realsee/dnalogel
pnpm add @realsee/dnalogel
通过 es 引用:
import { ModelChassisCompassPlugin } from "@realsee/dnalogel"
开发指南
初始化
在初始化 Five
实例时,将 ModelChassisCompassPlugin
配置在初始化插件参数即可。
import { Five } from '@realsee/five'
import { ModelChassisCompassPlugin } from "@realsee/dnalogel";
const five = new Five({
plugins: [
[
ModelChassisCompassPlugin,
'modelChassisCompassPlugin', // 自定义插件名称
{
// 参数配置
}
]
]
})
React 初始化
在创建 FiveProvider
时,将 ModelChassisCompassPlugin
配置在初始化插件参数即可。
import { ModelChassisCompassPlugin } from "@realsee/dnalogel";
import { createFiveProvider, FiveCanvas } from "@realsee/five/react";
const FiveProvider = createFiveProvider({
plugins: [
[
ModelChassisCompassPlugin,
'modelChassisCompassPlugin', // 自定义插件名称
{
// 参数配置
}
]
]
});
Vue 初始化
在使用 FiveProvider
时,将 ModelChassisCompassPlugin
配置在初始化插件参数即可。
<template>
<FiveProvider :fiveInitArgs="fiveInitArgs">
</FiveProvider>
</template>
<script setup>
import ModelChassisCompassPlugin from "@realsee/dnalogel/libs/ModelChassisCompassPlugin";
import { FiveProvider, FiveCanvas } from "@realsee/five/vue";
const fiveInitArgs = {
plugins: [
[
ModelChassisCompassPlugin,
'modelChassisCompassPlugin', // 自定义插件名称
{
// 参数配置
}
]
]
}
</script>
载入数据
// 获取插件实例,其中 `modelChassisCompassPlugin` 是初始化时自定义的名称
const pluginInstance = five.plugins.modelChassisCompassPlugin
// 调用 `load` 方法载入模型房屋标签数据
pluginInstance.load(modelChassisCompassPluginData)
核心方法
load(data: ModelChassisCompassPluginData)
载入插件数据
您需要手动载入插件数据,数据来源请阅读如视开放平台 API。
-
enable: () => void
启用插件 -
disable: () => void
禁用插件