@realsee/dnalogel 0.1.7 → 2.0.0-alpha.1

package/README.md

@@ -1,94 +1,10 @@
-# 如视 -- "Dnalogel"
+# 注意
 
-[如视(realsee.com)](https://realsee.com) 提供了在浏览器环境中的渲染三维空间 [VR 看房 SDK Five](https://developers.realsee.com/docs/#/docs/five/web/quickstart)。
-通过 [如视 3D 空间 API](https://developers.realsee.com/docs/#/docs/five/server/README) 并结合 Five 的渲染能力可以制作丰富多彩的三维空间应用。
+此版本为 **测试** 版本， 不推荐使用。
 
-除了 Five 强大的三维空间渲染能力之外，我们也积累了大量的 **VR 看房** 常用功能，并以 `React Components` 和 `Five Plugins` 的形式进行抽象。
+如您有插件使用需求，请安装 1.x 版本。
 
-无论是经过线上环境千锤百炼的刚需功能，还是灵感一现的炫酷尝试，凡是最终落地的功能我们均毫无保留的开源并以 [Storybook](https://storybook.js.org/) 的形式演示。
-
-如果组件满足您的需求，`npm install @realsee/dnalogel`一键安装使用。
-
-如果不满足需求，没关系，把我们当作代码示例，我们抛砖引玉。
-
-我们也很期待您基于 [Three.js](https://threejs.org/)、[Five.js](https://www.npmjs.com/package/@realsee/five) 等这类渲染库做出有意思的功能。
-
-## Components
-
-我们目前的组件都是基于 [React](https://reactjs.org/) 界面库实现的，直接按照 [React](https://reactjs.org/) 方式引用使用即可。
-
-### 组件列表
-
-- `ARVideoFigure` AR 视频形象
-- `FloorplanRadar` 户型雷达图
-- `GlassFilters` 滤镜
-- `ModelView` 模型视图 @todo
-- `PBRView` PBR 视图 @todo
-- `PaintBrush` 画笔 @todo
-- `PanoTag` 全景标签 @todo
-- ... 待补充
-
-### 使用方式
-
-```jsx
-import { FiveProvider, FiveCanvas } from '@realsee/five/react'
-import Component from '@realsee/dnalogel/components/Component'
-
-ReactDOM.render(
-  <FiveProvider>
-    <FiveCanvas />
-    <Component config onCallback />
-  </FiveProvider>,
-  containter,
-)
-```
-
-## Five Plugins
-
-**Five Plugins** 是使用了 `@realsee/five` 提供的工厂模式插件机制开发的插件。适合面向过程的可复用逻辑、命令式调用的对象抽象、无 DOM 或轻量 DOM 的组件、复杂动画等。
-
-如果您项目的技术栈不是[React](https://reactjs.org/) ，**Five Plugins** 可能更适合你。
-
-当然，部分插件我们也以 [React Component](https://reactjs.org/) 的形式提供了支持，但这些组件非**纯**组件（会有影响 `five` 实例状态的副作用），您可以按照实际情况酌情引用。
-
-### 插件列表
-
-- `ModelChassisCompassPlugin` 模型底盘雷达图插件
-- `ModelTVVideoPlugin` 模型电视视频插件
-- `ModelViewPlugin` 模型视图插件
-- `PanoRulerPlugin` 全景标尺插件
-- `PanoTVVideoPlugin` 全景电视视频插件
-- `PanoFloorplanRadarPlugin` 全景户型雷达图插件
-- `PanoDoorLabelPlugin` 全景房间标签引导插件 @todo
-- `PanoIRobotPlugin` 全景扫地机器人插件 @todo
-- `PanoMeasurePlguin` 全景测量插件 @todo
-- `ModelEntryDoorGuidePlugin` 模型入户门引导插件 @todo
-- ... 待补充
-
-### 使用方式
-
-```js
-import { Five } from '@realsee/five'
-import Plugin from '@realsee/dnalogel/plugins/Plugin'
-const five = new Five({
-  plugins: [[Plugin, 'PluginName', initOptions]],
-})
-
-// 不同插件提供的方法可能存在差异
-five.plugins.PluginName.load(data)
-five.plugins.PluginName.enable()
-five.plugins.PluginName.disable()
+此版本依赖 `svelte`， 使用时请同时安装 
+```bash
+npm install svelte 
 ```
-
-## Examples
-
-> **Examples** 是应用级别的复杂示例。例子永远不嫌多！
-
-### 最佳示例
-
-- Five 状态控制器：[Demo]()。
-- VR 看房：[移动端 Demo]() | [PC 端 Demo]()。
-
-## Tools
-
-> 为方便您更合理使用、理解 "Dnalogel" 组件、插件，我们提供了一些简单的数据生产编辑工具。