@realsee/five 6.0.0-alpha.10 → 6.0.0-alpha.100

package/package.json

@@ -1,17 +1,14 @@
 {
   "name": "@realsee/five",
-  "version": "6.0.0-alpha.10",
+  "version": "6.0.0-alpha.100",
   "description": "Realsee Renderer SDK",
   "bin": {
-    "five-plugin-init": "./scripts/five-plugin-init.js",
-    "five-react-component-init": "./scripts/five-react-component-init.js",
-    "five-quick-start-init": "./scripts/five-quick-start-init.js",
     "five-staticify": "./scripts/five-staticify.js"
   },
   "author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
   "license": "SEE LICENSE IN TERMS.txt",
   "peerDependencies": {
-    "react": "^16.0.0",
+    "react": ">=16.12.0",
     "three": "^0.117.1",
     "vue": "^3.0.0"
   },
@@ -27,14 +24,53 @@
     }
   },
   "dependencies": {
-    "archiver": "^5.3.0",
-    "commander": "^9.0.0",
-    "copyfiles": "^2.4.1",
+    "archiver": "^6.0.1",
+    "commander": "^11.1.0",
     "ejs": "^3.1.6",
-    "glob": "^7.2.0",
-    "protobufjs": "^6.8.8",
-    "url": "^0.11.0"
+    "protobufjs": "^7.2.5"
   },
   "main": "five/index.js",
-  "types": "five/index.d.ts"
+  "types": "five/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./five/index.mjs",
+      "require": "./five/index.js",
+      "types": "./five/index.d.ts"
+    },
+    "./gltf-loader": {
+      "import": "./gltf-loader/index.mjs",
+      "require": "./gltf-loader/index.js",
+      "types": "./gltf-loader/index.d.ts"
+    },
+    "./line": {
+      "import": "./line/index.mjs",
+      "require": "./line/index.js",
+      "types": "./line/index.d.ts"
+    },
+    "./react": {
+      "import": "./react/index.mjs",
+      "require": "./react/index.js",
+      "types": "./react/index.d.ts"
+    },
+    "./sticker": {
+      "import": "./sticker/index.mjs",
+      "require": "./sticker/index.js",
+      "types": "./sticker/index.d.ts"
+    },
+    "./vfx": {
+      "import": "./vfx/index.mjs",
+      "require": "./vfx/index.js",
+      "types": "./vfx/index.d.ts"
+    },
+    "./vue": {
+      "import": "./vue/index.mjs",
+      "require": "./vue/index.js",
+      "types": "./vue/index.d.ts"
+    },
+    "./plugins": {
+      "import": "./plugins/index.mjs",
+      "require": "./plugins/index.js",
+      "types": "./plugins/index.d.ts"
+    }
+  }
 }

package/plugins/index.d.ts

@@ -0,0 +1,253 @@
+import { Five } from '@realsee/five';
+import { Subscribe } from '@realsee/five';
+
+export declare namespace BasePlugin {
+    /**
+     * 基本属性字段
+     */
+    export interface State {
+        /**
+         * 插件是否启用
+         */
+        enabled: boolean;
+        /**
+         * 插件UI是否展示
+         */
+        visible?: boolean;
+        /**
+         * 插件的配置项
+         */
+        config?: unknown;
+    }
+    export interface BaseOptions {
+        /** 是否是用户行为 */
+        userAction?: boolean;
+    }
+    export interface Config {
+        /** 静态资源前缀 */
+        staticPrefix?: string;
+        /** 国际化转换函数 */
+        i18n?: (key: string) => string;
+    }
+    /**
+     * 插件基本事件
+     */
+    export type EventMap<PluginState, PluginData> = {
+        /**
+         * 插件被销毁
+         */
+        dispose: () => void;
+        /**
+         * 插件状态变化
+         * @param state      - 最新的State
+         * @param prevState  - 上一个State
+         * @param userAction - 是否是用户触发
+         */
+        stateChange: (params: {
+            state: PluginState;
+            prevState?: PluginState;
+            userAction: boolean;
+        }) => void;
+        /** 数据变更 */
+        dataChange: (data: PluginData, prevData?: PluginData) => void;
+        /** 数据加载完成 */
+        dataLoaded: (data: PluginData) => void;
+    };
+    /**
+     * plugin 的基本控制器
+     */
+    export abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData, PluginData> {
+        five: Five;
+        protected abstract data?: PluginData;
+        /**
+         * 加载插件依赖数据
+         * @param serverData  - 插件数据
+         * @param state  - 插件 State
+         */
+        abstract load?(serverData: PluginServerData, state?: PluginState, userAction?: boolean): Promise<void>;
+        /**
+         * @description 插件事件钩子
+         */
+        hooks: Subscribe<PluginEventMap>;
+        readonly staticPrefix: string;
+        /**
+         * 当前状态
+         * @description
+         * ```text
+         * 可以通过 plugin.state 和 plugin.setState 来获取和设置。
+         * 通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
+         * 来迎合一些通过数据驱动的场景。
+         * ```
+         */
+        abstract state: PluginState;
+        constructor(five: Five, config?: Config);
+        /**
+         * 获取当前的插件状态，如果当初插件内存在需要通过动画变更的 state 值，则通过此方法可以得到中间状态
+         */
+        getCurrentState(): PluginState;
+        /**
+         * 插件自身DOM添加到父容器
+         * @param wrapper - Element元素
+         */
+        appendTo?(wrapper: Element): void;
+        /**
+         * 展示UI
+         */
+        show?(options?: BaseOptions): Promise<void> | void;
+        /**
+         * 隐藏UI
+         */
+        hide?(options?: BaseOptions): Promise<void> | void;
+        /**
+         * 设置state
+         * @param state  - 插件的目标状态
+         * @param options  - 配置项
+         */
+        setState?(state: Partial<PluginState>, options?: BaseOptions): void;
+        /**
+         * @description 获取静态资源的url
+         */
+        absoluteUrl(url: string): string;
+        /**
+         * 启用插件，让插件能够响应交互
+         */
+        abstract enable(options?: BaseOptions): void;
+        /**
+         * 禁用插件，让插件停止响应交互
+         */
+        abstract disable(options?: BaseOptions): void;
+        /**
+         * 插件进行销毁
+         */
+        abstract dispose(): void;
+    }
+}
+
+/** 插件配置 */
+declare interface Config {
+}
+
+/** 插件事件 */
+declare interface EventMap extends BasePlugin.EventMap<State, ServerData> {
+}
+
+export declare class ItemMaskController extends BasePlugin.Controller<ItemMaskPluginType.State, ItemMaskPluginType.EventMap, ItemMaskPluginType.ServerData, ItemMaskPluginType.PluginData> {
+    /** 当前使用的数据 */
+    data?: ItemMaskPluginType.PluginData;
+    /** 插件当前状态 */
+    state: ItemMaskPluginType.State;
+    /** config 的原始值 */
+    private _config;
+    get config(): {};
+    private canvas;
+    private group;
+    private updateState;
+    private wrapper;
+    private style;
+    private tapPosition?;
+    private stopAnimation?;
+    private itemMaskMesh;
+    constructor(five: Five, params?: ItemMaskPluginType.Params);
+    load(data: ItemMaskPluginType.ServerData): Promise<void>;
+    private onFivePanoArrived;
+    private onFiveWantsMoveToPano;
+    private loadPanoMask;
+    private onFiveMouseMove;
+    private onFiveTapGesture;
+    private changeTapScreenPosition;
+    private onFiveCameraUpdate;
+    /** 更改插件 State */
+    setState(state: Partial<ItemMaskPluginType.State>, options?: BasePlugin.BaseOptions): void;
+    setMode(mode: ItemMaskPluginType.State['mode']): void;
+    select(name?: string, options?: {
+        userAction: boolean;
+    }): void;
+    selectAll(bool?: boolean): void;
+    private _enable;
+    private _disable;
+    /**
+     * 启用插件，让插件能够响应交互
+     */
+    enable(options?: BasePlugin.BaseOptions): void;
+    /**
+     * 禁用插件，让插件停止响应交互
+     */
+    disable(options?: BasePlugin.BaseOptions): void;
+    /** 销毁插件，移除所有副作用，销毁后将不响应任何 API */
+    dispose: () => void;
+}
+
+export declare const ItemMaskPlugin: (five: Five, params?: ItemMaskPluginType.Params) => ItemMaskController;
+
+declare namespace ItemMaskPluginType {
+    export {
+        ItemType,
+        MaskType,
+        PluginData,
+        ServerData,
+        Config,
+        Params,
+        State,
+        EventMap
+    }
+}
+export { ItemMaskPluginType }
+
+declare interface ItemType {
+    category_name: string;
+    category_cn: string;
+    index: number;
+    derived_id: string;
+    longitude: number;
+    latitude: number;
+    fov: number;
+    width: number;
+    height: number;
+    position: {
+        start: number[];
+        end: number[];
+        rotation: number[];
+    };
+    mask_color: number[];
+    visible_viewpoint: {
+        [key: string]: Record<any, any>;
+    };
+}
+
+declare interface MaskType {
+    derived_id: string;
+    index: number;
+    object_mask_url: string;
+}
+
+/** 插件初始化参数 */
+declare interface Params {
+    config?: Partial<Config>;
+    initialState?: Partial<State>;
+}
+
+declare type PluginData = {
+    data_list: ItemType[];
+    object_mask_list: MaskType[];
+};
+
+declare type ServerData = {
+    data_list: ItemType[];
+    object_mask_list: MaskType[];
+};
+
+/** 插件状态 */
+declare interface State extends BasePlugin.State {
+    /** 插件是否启用 */
+    enabled: boolean;
+    /** 插件整体是否可见 */
+    visible: boolean;
+    /** 插件模式 */
+    mode: 'mask' | 'box';
+    /** 选中ID */
+    selectedId: string | null;
+    /** 全选 */
+    selectAll: boolean;
+}
+
+export { }