@realsee/dnalogel 2.1.2-alpha.9 → 2.2.0

package/dist/shared-utils/Object3DHelper/index.d.ts

@@ -0,0 +1,71 @@
+import type { OutlineHelper } from './Helper';
+import type { Object3DHelperEventMap, Object3DHelperState } from './typings';
+import type { MoveController } from './Controller/MoveController';
+import type { RotateController } from './Controller/RotateController';
+import type { BaseController } from './Base/BaseController';
+import { Subscribe } from '../Subscribe';
+interface Controllers {
+    moveController?: MoveController;
+    rotateController?: RotateController;
+    scaleController?: BaseController;
+}
+interface Helpers {
+    outlineHelper?: OutlineHelper;
+}
+export declare class Object3DHelper {
+    controllers: Controllers;
+    state: Object3DHelperState;
+    hooks: Subscribe<Object3DHelperEventMap>;
+    private helpers;
+    private eventListener;
+    constructor(controllers?: Controllers, helpers?: Helpers);
+    /**
+     * @description Show guide line
+     */
+    show(options?: {
+        userAction?: boolean;
+    }): Promise<void>;
+    /**
+     * @description Hide guide line
+     */
+    hide(options?: {
+        userAction?: boolean;
+    }): Promise<void>;
+    /**
+     * @description Enable
+     */
+    enable(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Disable
+     */
+    disable(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Dispose
+     */
+    dispose(): void;
+    setState(state: Partial<Object3DHelperState>, options?: {
+        userAction?: boolean;
+    } & Record<string, any>): void;
+    addControllers(controllers: Controllers): void;
+    addHelpers(helpers: Partial<{
+        [K in keyof Helpers]: Helpers[K];
+    }>): void;
+    getCurrentState(): Object3DHelperState;
+    private addEventListener;
+    private handleEnd;
+    private handleStart;
+    private setOtherHelpersVisible;
+    private handlePositionUpdate;
+    private handleScaleUpdate;
+    private handleRotateUpdate;
+    private handleEnable;
+    private handleVisible;
+    private everyControllerDo;
+    private handleDispose;
+    private actionIfStateIsEnabled;
+}
+export {};

package/dist/shared-utils/Object3DHelper/typings/Direction.d.ts

@@ -0,0 +1,2 @@
+export declare type Direction = 'x' | 'y' | 'z';
+export declare type Direction4 = 'nesw' | 'nwse' | 'ns' | 'ew';

package/dist/shared-utils/Object3DHelper/typings/Hooks.d.ts

@@ -0,0 +1,45 @@
+import type * as THREE from 'three';
+export declare type HelperEventMap = {
+    moveStart: () => void;
+    rotateStart: () => void;
+    scaleStart: () => void;
+    positionUpdate: (position: {
+        matrix4?: THREE.Matrix4;
+    } | undefined) => void;
+    rotateUpdate: (rotate: {
+        quaternion?: THREE.Quaternion;
+        origin: THREE.Vector3;
+    } | undefined) => void;
+    scaleUpdate: (scale: {
+        matrix4?: THREE.Matrix4;
+        origin?: THREE.Vector3;
+        helperOrigin: THREE.Vector3;
+    } | undefined) => void;
+    moveEnd: () => void;
+    rotateEnd: () => void;
+    scaleEnd: () => void;
+};
+export interface Object3DHelperState {
+    enabled: boolean;
+    visible: boolean;
+    disposed: boolean;
+}
+export declare type Object3DHelperEventMap = {
+    show: (options?: {
+        userAction?: boolean;
+    }) => void;
+    hide: (options?: {
+        userAction?: boolean;
+    }) => void;
+    enable: (options?: {
+        userAction?: boolean;
+    }) => void;
+    disable: (options?: {
+        userAction?: boolean;
+    }) => void;
+    dispose: () => void;
+    stateChange: (params: {
+        state: Object3DHelperState;
+        prevState?: Object3DHelperState;
+    }) => void;
+};

package/dist/shared-utils/Object3DHelper/typings/Scissor.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 显示区域裁剪参数
+ * @description
+ * 可通过初始化，或者 setScissor 方式设置
+ * `scissor` 是将屏幕中的内容渲染到 `renderer` 的指定区域。
+ * 页面整体长宽均为 `1`。通过类似 css 的 `left` `bottom` `width` `height` 来确定区域。
+ */
+export interface Scissor {
+    /** 距离左侧 */
+    left: number;
+    /** 距离下侧 */
+    bottom: number;
+    /** 宽度 */
+    width: number;
+    /** 高度 */
+    height: number;
+}

package/dist/shared-utils/Object3DHelper/typings/index.d.ts

@@ -0,0 +1,5 @@
+import type * as THREE from 'three';
+export * from './Scissor';
+export * from './Direction';
+export * from './Hooks';
+export declare type Color = THREE.Color | string | number;

package/dist/shared-utils/Object3DHelper/utils/calculateThreeMouse.d.ts

@@ -0,0 +1,14 @@
+import * as THREE from 'three';
+/**
+ * 计算 three 中的 mouse 的值
+ * @param  mouseXY - 鼠标相对屏幕位置
+ * @param  element - canvas元素（three的展示元素）
+ * @param  scissor - 屏幕剪裁
+ */
+export declare function calculateThreeMouse(originMouse: {
+    x: number;
+    y: number;
+}, element: HTMLElement): THREE.Vector2 & {
+    x: number;
+    y: number;
+};

package/dist/shared-utils/Object3DHelper/utils/direction.d.ts

@@ -0,0 +1,14 @@
+import type { Direction } from '../typings';
+import * as THREE from 'three';
+export declare class DirectionGroup extends THREE.Group {
+    direction: Direction;
+    constructor(direction?: Direction);
+}
+export declare class DirectionLine<T extends THREE.Geometry, K extends THREE.Material> extends THREE.Line<T, K> {
+    direction: Direction;
+    constructor(geometry?: T, material?: K, direction?: Direction);
+}
+export declare class DirectionMesh<T extends THREE.Geometry, K extends THREE.Material> extends THREE.Mesh<T, K> {
+    direction: Direction;
+    constructor(geometry?: T, material?: K, direction?: Direction);
+}

package/dist/shared-utils/Object3DHelper/utils/filterNotColinearPoints.d.ts

@@ -0,0 +1,2 @@
+import type { Vector3 } from 'three';
+export declare function filterNotColinearPoints(positions: Vector3[]): [Vector3, Vector3, Vector3] | void;

package/dist/shared-utils/Object3DHelper/utils/getMouseRaycaster.d.ts

@@ -0,0 +1,5 @@
+import * as THREE from 'three';
+export declare function getMouseRaycaster(camera: THREE.Camera, mouse: {
+    x: number;
+    y: number;
+}, element: HTMLElement): THREE.Raycaster;

package/dist/shared-utils/Object3DHelper/utils/getPoint.d.ts

@@ -0,0 +1,3 @@
+import * as THREE from 'three';
+export default function getPoint(position?: THREE.Vector3, colorIndex?: number): THREE.Mesh<THREE.SphereGeometry, THREE.MeshBasicMaterial>;
+export declare function getAllMesh(): any[];

package/dist/shared-utils/Object3DHelper/utils/index.d.ts

@@ -0,0 +1,8 @@
+export * from '../../../CSS3DRenderPlugin/utils';
+export * from './direction';
+export * from './calculateThreeMouse';
+export * from './normalPositionToPositions';
+export * from './object3DBoundingPosition';
+export * from './getMouseRaycaster';
+export * from './filterNotColinearPoints';
+export * from './vectorIsEqual';

package/dist/shared-utils/Object3DHelper/utils/normalPositionToPositions.d.ts

@@ -0,0 +1,5 @@
+import type { Vector3 } from 'three';
+export declare function normalPositionToPositions(cameraPosition: Vector3, position: Vector3, normal: Vector3, config?: {
+    width?: number;
+    height?: number;
+}): [Vector3, Vector3, Vector3, Vector3];

package/dist/shared-utils/Object3DHelper/utils/object3DBoundingPosition.d.ts

@@ -0,0 +1 @@
+export declare function object3DBoundingPosition(): void;

package/dist/shared-utils/Object3DHelper/utils/threex/domevents/index.d.ts

@@ -0,0 +1,34 @@
+import type * as THREE from 'three'
+
+type EventName =
+  | 'click'
+  | 'dblclick'
+  | 'mouseover'
+  | 'mouseout'
+  | 'mousemove'
+  | 'mousedown'
+  | 'mouseup'
+  | 'contextmenu'
+  | 'touchstart'
+  | 'touchend'
+
+declare class DomEvents {
+  public constructor(camera: THREE.Camera, domElement: HTMLElement)
+
+  public addEventListener<T extends EventName, K extends THREE.Object3D>(
+    object: K,
+    eventName: T,
+    callback: (params: {
+      type: T
+      target: K
+      origDomEvent: Event
+      intersect: THREE.Intersection & { object: K }
+      stopPropagation: () => void
+    }) => void,
+    useCapture?: boolean,
+  ): void
+
+  public removeEventListener(object: THREE.Object3D, eventName: EventName, callback: (params: any) => void, useCapture?: boolean): void
+}
+
+export default DomEvents

package/dist/shared-utils/Object3DHelper/utils/vectorIsEqual.d.ts

@@ -0,0 +1,2 @@
+import type * as THREE from 'three';
+export declare function vectorIsEqual(vector1: THREE.Vector3, vector2: THREE.Vector3): boolean;

package/dist/shared-utils/Subscribe.d.ts

@@ -0,0 +1,60 @@
+interface EventMap {
+    [name: string]: (...args: any[]) => void | boolean;
+}
+/**
+ * 监听者模式
+ * @template T - 预设的监听回调类型
+ * @example
+ * ```
+ * new Subscribe<{
+ * "foo": [arg1: number, arg2: string],
+ * "bar": [arg: boolean],
+ * }>()
+ * ```
+ */
+declare class Subscribe<T extends EventMap> {
+    /**
+     * 判断是否注册了事件
+     * @param name - 事件类型
+     */
+    hasListener(name: keyof T): boolean;
+    /**
+     * 注册事件
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @param once - 是否只执行一次
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
+     */
+    on<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
+    /**
+     * 注册事件(是否只执行一次)
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
+     */
+    once<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
+    /**
+     * 解除事件
+     *
+     * 如果 name 不传的话解除对应所有事件
+     * 如果 name, callback 不传的话解除所有name的所有事件
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @template K - 预设的监听事件名称
+     */
+    off<K extends keyof T>(name?: K, callback?: (...args: Parameters<T[K]>) => ReturnType<T[K]>): void;
+    /**
+     * 触发事件
+     * @param name - 事件类型
+     * @param data - 触发事件的数据
+     * @returns canceled 是否被触发取消
+     * @template K - 预设的监听事件名称
+     */
+    emit<K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
+}
+export { Subscribe };
+export type { EventMap as SubscribeEventMap };

package/dist/shared-utils/animationFrame/BetterTween.d.ts

@@ -0,0 +1,11 @@
+import TWEEN from '@tweenjs/tween.js';
+export declare class BetterTween<G> extends TWEEN.Tween<G> {
+    private disposeMethods;
+    private animationFrameDisposer?;
+    onDispose: (callback: () => void) => this;
+    play: () => this;
+    dispose: () => void;
+}
+export declare function tweenProgress(duration?: number, easing?: (amount: number) => number): BetterTween<{
+    progress: number;
+}>;

package/dist/shared-utils/animationFrame/calculateProgress.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 线性过程插值
+ */
+export declare function progressNumber(from: number, to: number, pst: number): number;
+/**
+ * 弧度过程插值值,会取锐角进行插值
+ */
+export declare function progressRad(from: number, to: number, pst: number): number;

package/dist/shared-utils/animationFrame/formatRad.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 把一个任意角度的弧度值转换为一个 [0, 2PI] 的弧度值
+ * @param rad 弧度值
+ */
+export declare function formatLongitude(rad: number): number;
+/**
+ * 把一个任意角度的弧度值转换为一个 [-2PI, 2PI] 的弧度值
+ * @param rad 弧度值
+ */
+export declare function formatLatitude(rad: number): number;
+/**
+ * 把一个任意角度的弧度值转换为一个 [0, 2PI] 的弧度值
+ * @param rad 弧度值
+ */
+export declare const formatRad: typeof formatLongitude;

package/dist/shared-utils/animationFrame/index.d.ts

@@ -0,0 +1,16 @@
+declare const _requestAnimationFrame: ((callback: FrameRequestCallback) => number) & typeof requestAnimationFrame;
+export default _requestAnimationFrame;
+export declare function nextFrame(fn: FrameRequestCallback, delay?: number): void;
+/**
+ * 在每个 AnimationFrame 中调用传入的函数
+ * @param callback 每次 AnimationFrame 中调用的函数
+ * @param frame 每秒运行多少次
+ * @returns 返回一个函数，调用可以停止 AnimationFrameLoop
+ */
+export declare function requestAnimationFrameInterval(callback?: (time: number) => any, frame?: number): () => void;
+/**
+ * 获取两个 AnimationFrame 间隔的时间
+ * @returns 返回一个 Promise，resolve 的结果是两个 AnimationFrame 间隔的时间
+ */
+export declare function getFrameTime(): Promise<unknown>;
+export * from './BetterTween';

package/dist/shared-utils/animationFrame/tween.d.ts

@@ -0,0 +1,75 @@
+import * as TWEEN from '@tweenjs/tween.js';
+export declare const Easing: {
+    Linear: {
+        None: (amount: number) => number;
+    };
+    Quadratic: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Cubic: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Quartic: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Quintic: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Sinusoidal: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Exponential: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Circular: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Elastic: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Back: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+    Bounce: {
+        In: (amount: number) => number;
+        Out: (amount: number) => number;
+        InOut: (amount: number) => number;
+    };
+};
+interface ITween<T> extends TWEEN.Tween<T> {
+    onDestroy: (fn: () => void) => TWEEN.Tween<T>;
+    destroy: () => void;
+}
+/**
+ * 对象变化的补间动画
+ * 1. 应用 requestAnimationFrameInterval 做 update
+ * 2. 在原生 tween 上新增 destroy 方法和 onDestroy 监听
+ * DOC： https://github.com/tweenjs/tween.js
+ * @param from 对象起始状态
+ * @param to 对象末尾状态
+ * @param duration 经历时间（s）
+ * @param easing 过程动画，默认是 Easing.Linear.None
+ */
+export default function tween<T>(from: T, to: T, duration: number, easing?: (amount: number) => number): ITween<T>;
+export declare function tweenProgress(duration: number, easing: typeof Easing.Linear.None): ITween<{
+    progress: number;
+}>;
+export {};

package/dist/shared-utils/changeModelCanvasOpacity.d.ts

@@ -0,0 +1,2 @@
+import type { Five } from '@realsee/five';
+export default function changeModelCanvasOpacity(five: Five, opacity: number, duration?: number): void;

package/dist/shared-utils/createCanvasTextTexture.d.ts

@@ -0,0 +1,8 @@
+import { CanvasTexture } from 'three';
+export default function createCanvasTextTexture(text: string, config?: {
+    size?: number;
+    fontSize?: number;
+    backgroundColor?: string;
+    fontColor?: string;
+    textAlign?: CanvasTextAlign;
+}): CanvasTexture;

package/dist/shared-utils/createLine/index.d.ts

@@ -0,0 +1,3 @@
+import { Line } from '@realsee/five/line';
+import { Vector3 } from 'three';
+export default function createLine(point1: Vector3, point2: Vector3, color?: Vector3, dashed?: boolean): Line;

package/dist/shared-utils/debounce.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 创建一个防抖动函数，该函数会在 wait 毫秒后调用 func 方法
+ * @param func - 要防抖动的函数
+ * @param [wait=0] - 需要延迟的毫秒数
+ */
+export default function debounce<T extends (...args: any[]) => any>(func: T, wait?: number): (...args: Parameters<T>) => void;

package/dist/shared-utils/equal.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 对象比较
+ * @param {*} value 第一个比较的值
+ * @param {*} other 第二个比较的值
+ * @param {Object} options 可选参数，可选项包括：<br />
+ *    deep {Boolean} 是否深比较<br />
+ * @returns {boolean} 是否相等
+ */
+export default function equal(value: any, other: any, opt?: {
+    deep: boolean;
+}): boolean;

package/dist/shared-utils/filter.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 对象属性筛选函数。
+ * 基于已有对象生成一个满足条件(属性)新的对象。
+ * @param {object} object
+ * @param {Function} check
+ */
+export declare function filter<T, K extends keyof T>(object: T, check: (key: K, value: T[K]) => boolean): Record<K, T[K]>;
+/**
+ * 对象镜子函数。
+ * 生成一个"镜子"对象：对象的属性名与其值相同。
+ * @param  {string[]} strings 对象属性
+ */
+export declare function mirror(strings: string[]): Record<string, string>;
+/**
+ * 过滤掉不需要的对象字段函数：实现从一个对象中排除某些指定属性后生成的新对象。
+ * @param object
+ * @param props 排除的属性
+ * @return
+ */
+export declare function omit<T, K extends keyof T>(object: T, props: Extract<K[], string[]>): Omit<T, K>;
+/**
+ * 筛选需要的对象字段：实现从一个对象中选择某些指定属性生成新的对象（与`omit()`功能相反）。
+ * @param  {object}    object
+ * @param  {string[]} props
+ * @return {object}
+ */
+export declare function pick<T, K extends keyof T>(object: T, props: K[]): Pick<T, K>;

package/dist/shared-utils/five/changeMode.d.ts

@@ -0,0 +1,5 @@
+import type { Five } from '@realsee/five';
+/** 等待 five changeMode 结束
+ * @description Promise 的状态只代表 mode 与预期是否一致，不保证参数的一致性
+ */
+export default function changeMode(five: Five, changeModeParams: Parameters<Five['changeMode']>): Promise<void>;

package/dist/shared-utils/getPxmm.d.ts

@@ -0,0 +1,19 @@
+import type { Five } from '@realsee/five';
+import { FLOOR_PLAN_ATTACHED_TO } from '../floorplan/constant';
+interface GetPxmmOption {
+    attachedTo: FLOOR_PLAN_ATTACHED_TO;
+}
+/** 获取当前楼层地面的 Y 值 */
+export declare function getFloorY(five: Five, floorIndex: number): number;
+/** 获取当前吸附类型的 Y 值
+ * * FLOOR_PLAN_ATTACHED_TO.FLOOR：当前楼层地板的 Y
+ * * FLOOR_PLAN_ATTACHED_TO.BOUNDING_CENTER：当前模型中心的 Y
+ * * FLOOR_PLAN_ATTACHED_TO.BOUNDING_CENTER：当前楼层天花板的 Y
+*/
+export declare function getAttachedY(five: Five, floorIndex: number, attachedTo?: FLOOR_PLAN_ATTACHED_TO): number;
+/**
+ * 获取「在俯视图」状态下，模型 mm 与屏幕像素 px 的对应关系，即每 mm 对应多少 px
+ * @param five five
+ */
+export default function getPxmm(five: Five, container: Element, floorIndex: number, options?: GetPxmmOption): number;
+export {};

package/dist/shared-utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './math';
+export * from './three';
+export * from './isNil';
+export * from './animationFrame';

package/dist/shared-utils/isNil.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 判断对象是否为`null`或`undefined`。
+ * @param
+ * @return
+ */
+export declare function isNil<T>(value: T): value is Extract<T, undefined | null>;
+/**
+ * 判断对象不为`null`或`undefined`。
+ */
+export declare function notNil<T>(value: T | null | undefined): value is T;

package/dist/shared-utils/isTruelyObject.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 检查一个值是否是狭义上的对象
+ * @param {any} value 要检查的值
+ *
+ * isTruelyObject({})
+ * // => true
+ *
+ * isObjectLike([1, 2, 3])
+ * // => false
+ *
+ * isObjectLike(Function)
+ * // => false
+ *
+ * isObjectLike(null)
+ * // => false
+ *
+ */
+export default function isTruelyObject(value: any): boolean;

package/dist/shared-utils/math/Interval.d.ts

@@ -0,0 +1,13 @@
+/** 一维区间 */
+declare class Interval {
+    min: number;
+    max: number;
+    isInterval: boolean;
+    constructor(min?: number, max?: number);
+    fromArray(array: number[]): Interval;
+    /** 两个区间是否重叠 */
+    isOverlap(target: Interval): boolean;
+    /** 是否包含区间 */
+    contains(target: Interval): boolean;
+}
+export { Interval };

package/dist/shared-utils/math/Rectangle.d.ts

@@ -0,0 +1,27 @@
+import { Interval } from './';
+/** 矩形的数学方法合集 */
+declare class Rectangle {
+    min: {
+        x: number;
+        y: number;
+    };
+    max: {
+        x: number;
+        y: number;
+    };
+    xInterval: Interval;
+    yInterval: Interval;
+    isRectangle: boolean;
+    constructor(min: {
+        x: number;
+        y: number;
+    }, max: {
+        x: number;
+        y: number;
+    });
+    /** 是否与矩形是否重叠 */
+    isOverlapWithRectangle(target: Rectangle): boolean;
+    /** 是否包含目标矩形 */
+    containsRect(target: Rectangle): boolean;
+}
+export { Rectangle };

package/dist/shared-utils/math/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Interval';
+export * from './Rectangle';