@realsee/dnalogel 2.9.2 → 2.10.0

package/dist/PanoVideoPlugin/Controller.d.ts

@@ -0,0 +1,31 @@
+import type { Five } from '@realsee/five';
+import type { LoadParams, PluginEventMap, PluginState, PluginData, VideoItem } from './typings';
+import * as BasePlugin from '../base/BasePlugin';
+export declare class PanoVideoPluginController extends BasePlugin.Controller<PluginState, PluginEventMap> {
+    /** 插件 State */
+    get state(): {
+        enabled: boolean;
+    };
+    /** 插件是否已被销毁 */
+    get disposed(): boolean;
+    private enabled;
+    private controllerMap;
+    private _disposed;
+    constructor(five: Five);
+    /** 加载点位视频数据，加载数据并不代表会加载点位视频。 */
+    load(data: PluginData, params?: LoadParams): void;
+    /** 开启插件功能。 */
+    enable(options?: BasePlugin.BaseOptions): void;
+    /** 禁用插件功能。 */
+    disable(options?: BasePlugin.BaseOptions): void;
+    /** 为一个点位添加视频（可以是多条）。 */
+    add(panoIndex: number, videoItems: VideoItem[]): void;
+    /** 根据 VideoItem render_id 删除某个视频。 */
+    removeByRenderID(id: string): void;
+    /** 清空现有数据 */
+    clear(): void;
+    /** 销毁插件 */
+    dispose(): void;
+    /** 控制台打印警告 */
+    private logWarning;
+}

package/dist/PanoVideoPlugin/VideoMeshController.d.ts

@@ -0,0 +1,85 @@
+import type { Five } from '@realsee/five';
+import type { VideoMeshParams } from './typings';
+/** 点位视频控制器
+ * @description 控制器存在副作用，包括：
+ * - 对 Five 事件的监听。
+ * - 对 DOM 原生事件的监听。
+ * - 用于播放视频的模型。
+ * - 视频实例。
+ * @description 清除副作用的力度从弱到强：
+ * - 隐藏：hide，用于隐藏 UI 元素；不销毁多媒体资源。用于临时隐藏。
+ * - 取消挂载：unmount，销毁视频资源；移除模型。用于不符合自身展示条件时执行。
+ * - 禁用：disable，销毁视频资源；移除模型；取消监听。用于外部条件变换导致的功能禁用。
+ * - 销毁：dispose，用于彻底销毁实例，dispose 之后将不响应任何事件。
+ */
+export declare class VideoMeshController {
+    /** 传入的 ID，不可更改 */
+    get renderID(): string;
+    /** 是否已经销毁 */
+    get disposed(): boolean;
+    /** 是否已经启用 */
+    get enabled(): boolean;
+    private _id;
+    /** 视频资源地址 */
+    private url;
+    /** Five Instance */
+    private five;
+    /** 视频对应的点位 */
+    private panoIndex;
+    /** 视频在球面的 uv：[left, top, width, height] */
+    private origin;
+    /** Video DOM */
+    private video;
+    /** Video Mesh */
+    private videoMesh;
+    private _enabled;
+    private _disposed;
+    /** 视频是否曾经播放过 */
+    private hasVideoEverPlayed;
+    /** 自动 render five 的销毁函数
+     * @remark 由于 render video 依赖 Five render，因此需要自动 render five。
+     */
+    private renderFiveDisposer?;
+    /** 初始化视频、模型以及相关事件监听。 */
+    constructor(five: Five, params: VideoMeshParams);
+    /** 彻底销毁，不响应之后的任何事件 */
+    dispose(): void;
+    enable(): void;
+    /** 禁用插件 */
+    disable(): void;
+    /** 添加时间监听 */
+    private addEventListeners;
+    /** 移除事件监听 */
+    private removeEventListeners;
+    /** 如果满足 mount 条件，mount */
+    private mountIfNeeded;
+    /** 挂载：加载视频资源；添加模型。 */
+    private mount;
+    /** 卸载：销毁视频资源；移除模型。 */
+    private unmount;
+    /** 暂停视频，去除模型。 */
+    private hide;
+    /** Five 数据加载后需要根据点位位姿调整点位模型位置 */
+    private onFiveDataLoaded;
+    /** 兼容视频播放 */
+    private onFiveWantsMoveToPano;
+    /** 走到某个点位上时，挂载/卸载视频 */
+    private onFivePanoArrived;
+    private onFivePanoWillArrive;
+    /** Five 模型变化 */
+    private onFiveModeChange;
+    /** Five mode change 动画结束 */
+    private onFiveInitAnimationEnded;
+    /** video playing 事件触发
+     * @remarks
+     * 事件触发时机：
+     * - video is ready to start after having been paused.
+     * - video is ready to play after delayed due to lack of data.
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video
+     */
+    private onVideoPlaying;
+    /** video pause 事件触发 */
+    private onVideoPaused;
+    /** 控制台打印警告 */
+    private logWarning;
+}

package/dist/PanoVideoPlugin/index.d.ts

@@ -0,0 +1,16 @@
+import type { FivePlugin } from '@realsee/five';
+import { PanoVideoPluginController } from './Controller';
+import * as _PanoVideoPluginType from './typings';
+/** 点位视频播放插件
+ * - 支持一次性加载多组数据。
+ * - 走到点位上时播放视频（可能是多个）。
+ * - 走出点位时销毁视频。
+ * - 允许动态开启和禁用功能。
+ * - 视频只能在全景模式且点位一致时才会播放。不满足条件会自动销毁。
+ * - 不做多媒体缓存，缓解内存占用。
+ */
+export declare const PanoVideoPlugin: FivePlugin<undefined, PanoVideoPluginController>;
+export { _PanoVideoPluginType as PanoVideoPluginType };
+export declare type PanoVideoPluginParameterType = undefined;
+export declare type PanoVideoPluginReturnType = InstanceType<typeof PanoVideoPluginController>;
+export default PanoVideoPlugin;

package/dist/PanoVideoPlugin/typings.d.ts

@@ -0,0 +1,64 @@
+import type * as BasePlugin from '../base/BasePlugin';
+/** 单个视频元素 */
+export interface VideoItem {
+    /** client render ID
+     * @remarks 为什么不用 id 作为唯一标识？
+     * - id 是后端生成的，而 render_id 是前端生成的，在编辑时为了保证在请求后端数据之前也能进行渲染，使用额外的 id 进行渲染。
+     * - 为了保证两端的数据一致性，插件里使用 render_id 作为唯一 ID。
+     */
+    render_id: string;
+    /** 文件地址 */
+    url: string;
+    /** 算法处理的视频 uv 信息
+     * @description [left, top, width, height]
+     */
+    origin: number[];
+}
+/** 点位视频元素 */
+export interface PanoVideoItem {
+    /** client render ID */
+    render_id: string;
+    /** 视频播放点位 */
+    pano_index: number;
+    /** 视频列表 */
+    video_list: VideoItem[];
+}
+/** 点位视频模型参数 */
+export interface VideoMeshParams {
+    /** client render ID */
+    renderID: string;
+    /** video 文件地址 */
+    url: string;
+    /** 算法处理的视频 uv 信息
+     * @description [left, top, width, height]
+     */
+    origin: number[];
+    /** 视频播放点位 */
+    panoIndex: number;
+    /** 初始状态 */
+    initialState?: {
+        enabled?: boolean;
+    };
+}
+/** 加载数据时的额外参数 */
+export interface LoadParams {
+    initialState?: {
+        enabled?: boolean;
+    };
+}
+export interface PluginState {
+    enabled: boolean;
+}
+export interface PluginData {
+    list: PanoVideoItem[];
+}
+export interface PluginEventMap extends BasePlugin.EventMap<PluginState> {
+    /** 点位视频模型开启 */
+    enable: (params: {
+        userAction: boolean;
+    }) => void;
+    /** 点位视频模型关闭 */
+    disable: (params: {
+        userAction: boolean;
+    }) => void;
+}

package/dist/PanoVideoPlugin/utils/shader.d.ts

@@ -0,0 +1,2 @@
+export declare const vertexShader = "\nvarying vec2 vUv;\nvoid main() {\n  vUv = uv;\n  vec4 mvPosition = modelViewMatrix * vec4(position, 1);\n  gl_Position = projectionMatrix * mvPosition;\n}\n";
+export declare const fragmentShader = "\nuniform sampler2D map;\nuniform vec4 size;\nvarying vec2 vUv;\n\nvoid main() {\n  vec2 uv = vec2((vUv.x - size[0]) / size[2], (vUv.y - size[1]) / size[3]);\n  float a = 0.1;\n  float transX = uv.x < a ? 1.0 / a * uv.x : (uv.x > (1.0 - a) ? 1.0 / a * (1.0 - uv.x) : 1.0);\n  float transY = uv.y < a ? 1.0 / a * uv.y : (uv.y > (1.0 - a) ? 1.0 / a * (1.0 - uv.y) : 1.0);\n\tfloat match = (1.0 - step(0.5, abs(uv.x - 0.5))) * (1.0 - step(0.5, abs(uv.y - 0.5))) * (transX < transY ? transX : transY);\n  gl_FragColor = vec4(texture2D(map, uv).xyz, match);\n}\n";

package/dist/base/BasePlugin.d.ts

@@ -83,6 +83,12 @@ declare abstract class Controller<PluginState extends State, PluginEventMap exte
      * 隐藏UI
      */
     hide?(options?: BaseOptions): Promise<void>;
+    /**
+     * 设置state
+     * @param state 插件的目标状态
+     * @param options 配置项
+     */
+    setState?(state: Partial<PluginState>, options?: BaseOptions): void;
     /**
      * 启用插件，让插件能够响应交互
      */
@@ -95,12 +101,6 @@ declare abstract class Controller<PluginState extends State, PluginEventMap exte
      * 插件进行销毁
      */
     abstract dispose(): void;
-    /**
-     * 设置state
-     * @param state 插件的目标状态
-     * @param options 配置项
-     */
-    abstract setState(state: Partial<PluginState>, options?: BaseOptions): void;
 }
 export type { State, EventMap, BaseOptions };
 export { Controller };