@aibee/owlly 1.0.26 → 1.0.29

package/lib/prod/src/owlly/overlay/poi-overlay.d.ts

@@ -0,0 +1,277 @@
+import { NS_THREE } from '../stage/externals';
+import { Overlay } from './overlay';
+import { View } from '../view/view';
+/**
+ * POI元素, 包含一个图标与一段文字
+ * @example
+ * ```typescript
+ * const poiOverlay = new PoiOverlay();
+ * const poi = poiOverlay.createPoi(new Vector3(0, 0, 0));
+ * ```
+ */
+interface Rect {
+    xMin: number;
+    xMax: number;
+    yMin: number;
+    yMax: number;
+}
+/**
+ * POI覆盖层, 可以展示POI图标与文字, 存在图标时以图标中心为中心, 否则为文字中心
+ * @example
+ * ```typescript
+ * const poiOverlay = new PoiOverlay();
+ * // 任意View
+ * view.addOverlay(poiOverlay);
+ * ```
+ */
+declare class PoiOverlay extends Overlay {
+    static canvas: HTMLCanvasElement;
+    static ctx: CanvasRenderingContext2D;
+    private parent;
+    private rectMap;
+    private pois;
+    private mouseState;
+    private mousePositionBuffer;
+    private eventTarget;
+    private enabled;
+    private renderThisFrame;
+    private visible;
+    camera: NS_THREE.Camera;
+    scene: NS_THREE.Scene;
+    renderCamera: NS_THREE.OrthographicCamera;
+    renderer: NS_THREE.WebGL1Renderer;
+    orderPois: Function;
+    prevPosition: NS_THREE.Vector3 | null;
+    prevQuaternion: NS_THREE.Quaternion | null;
+    prevZoom: any;
+    private needRender;
+    private listeners;
+    constructor(canvas?: HTMLCanvasElement);
+    init(parent: View): void;
+    update(): boolean;
+    forceRenderInThisFrame(): void;
+    render(): void;
+    orderPoisByLevel(): void;
+    recalculateVisibilities(pois: Poi[]): void;
+    checkUpdate(): void;
+    dispose(): void;
+    private onPointerDown;
+    private onPointerUp;
+    private onTouchStart;
+    private onTouchEnd;
+    private onNodePointerDown;
+    /**
+     * 新建POI
+     * @param position POI在3D空间中的位置
+     */
+    createPoi(position: NS_THREE.Vector3): Poi;
+    setRectMap(rect: Rect, ele: Poi): void;
+    /**
+     * 删除POI
+     * @param poi 待删除的POI
+     */
+    removePoi(poi: Poi): void;
+    clearPoi(): void;
+    /**
+     * 设置覆盖层可见性 兼容旧poi
+     * @param visible 覆盖层是否可见
+     */
+    setVisibility(visible: boolean): void;
+    setEnabled(value: boolean): void;
+    resize(viewWidth: number, viewHeight: number): void;
+    private updateCameraAspect;
+}
+declare class Poi {
+    static ImageMaterialMap: Map<any, any>;
+    private position;
+    private screenPosition;
+    private visible;
+    private hide;
+    private parent;
+    private subHide;
+    private textVisibility;
+    private iconVisibility;
+    private animationEnabled;
+    isInFrustum: boolean;
+    private textPosInfo;
+    private iconPosInfo;
+    private autoRotation;
+    private rotation;
+    collision: boolean;
+    private boundingBox;
+    private overlapArea;
+    collisionMode: string;
+    private withBoundingBox;
+    private subAreaOpacity;
+    private abandonedAreaOpacity;
+    private visiblePartWhenCollision;
+    private boundingRect;
+    private outerRect;
+    private iconCircleOptions;
+    private iconInCircle;
+    private iconRect;
+    private textRect;
+    private visibilityAnimation;
+    private textWidth;
+    private textHeight;
+    private iconSize;
+    private textMaterial;
+    private iconMaterial;
+    private iconCircleMaterial;
+    private rectMaterial;
+    private text;
+    private icon;
+    group: NS_THREE.Group | null;
+    poiId: number;
+    private iconOptions;
+    private labelOptions;
+    private rectOptions;
+    private withRect;
+    private rect;
+    private level;
+    private dpr;
+    private isFlipY;
+    private _renderThisFrame;
+    private labelOpacity;
+    private iconOpacity;
+    private set renderThisFrame(value);
+    private get renderThisFrame();
+    constructor(position?: NS_THREE.Vector3);
+    dispose(): void;
+    setParent(parent: PoiOverlay): void;
+    setPosition(position: NS_THREE.Vector3, tolerance?: number): void;
+    setOpacity(labelOpacity?: number, iconOpacity?: number): void;
+    /**
+     * 设置旋转角度
+     * @param rotation 旋转角度
+     */
+    setRotation(rotation: number, tolerance?: number): void;
+    /**
+     * 设置是否碰撞
+     * @param collision 是否碰撞
+     */
+    setCollision(collision: boolean): void;
+    /**
+     * 设置碰撞模式
+     * @param mode 碰撞模式 label || icon || outer(默认)
+     */
+    setCollisionMode(mode: string): void;
+    setLabelVisibility(visible: boolean): void;
+    setIconVisiblity(visible: boolean): void;
+    setHideModeWhenCollision(mode: string): void;
+    setVisiblePartWhenCollision(part: string): void;
+    setCollisionOverlap(x: number, y: number): void;
+    /**
+       * 设置POI层级
+       * @param level 层级
+       */
+    setLevel(level: number, forceOrder?: boolean): void;
+    /**
+       * 获取POI层级
+       */
+    getLevel(): number;
+    /**
+       * 设置POI可见性
+       * @param visible 可见性
+       */
+    setVisibility(visible: boolean): void;
+    /**
+       * 设置POI是否暂时隐藏
+       * @param hide true 全部隐藏 false: 根据 hideModeWhenCollision 做显隐判断
+       */
+    setHidden(hide: boolean, subHide?: boolean): void;
+    /**
+       * 设置Rect是否可见
+       * @param withRect 可见性
+       */
+    setRect(withRect: boolean): void;
+    /**
+       * 设置Rect默认宽高 未废弃, 不发挥作用
+       * @param withRect 可见性
+       */
+    private setRectDefSize;
+    /**
+       * 设置Rect背景色 未废弃, 不发挥作用
+       * @param color
+       */
+    setRectFill(color: number | string): void;
+    /**
+       * 设置Rect偏移 未废弃, 不发挥作用
+       * @param x
+       * @param y
+       */
+    setRectOffset(x?: number, y?: number): void;
+    setIconImage(src: string): void;
+    setIconSize(width: number, height: number): void;
+    /**
+     * 设置POI中icon的显示
+     */
+    setIconShowInCircle(lineWidth: number, lineColor: string): void;
+    drawIcon(): void;
+    private clearIcon;
+    /**
+       * 设置图标相对(0,0)的位置
+       * @param  direction: x / y  value: + / - 表示方向
+       * x = 2 的时候, 表示label 中心 和 icon 中心 同一条y轴, label 右边框 距离 icon 左边框2个单位
+       */
+    setIconAnchor(anchor: 'center' | 'left' | 'right' | 'top' | 'bottom' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright'): void;
+    /**
+     * 设置图标反转
+     */
+    setIconFlipY(flipY: boolean): void;
+    setIconOffset(x: number, y: number): void;
+    /**
+       * 设置文字字体大小
+       * @param fontSize 字号, 单位为px
+       */
+    setFontSize(fontSize: number): void;
+    setFontPadding(fPadding: number): void;
+    setLabelText(text: string): void;
+    drawText(): void;
+    recalcOffset(width: number, height: number, anchor: string, anchorOffsetX: number, anchorOffsetY: number): {
+        offsetX: number;
+        offsetY: number;
+    };
+    /**
+       * 设置POI文字相对(0,0)的位置。在有icon 和 无icon时锚点不同
+       * @param  direction: x / y  value: + / - 表示方向
+       * x = 2 的时候, 表示label 中心 和 icon 中心 同一条y轴, label 右边框 距离 icon 左边框2个单位
+       */
+    setLabelAnchor(anchor: 'center' | 'left' | 'right' | 'top' | 'bottom' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright'): void;
+    setLabelOffset(x: number, y: number): void;
+    getLabelAnchor(): 'center' | 'left' | 'right' | 'top' | 'bottom' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright';
+    getLabelOffset(): {
+        x: number;
+        y: number;
+    };
+    calcBoundingSize(): void;
+    private drawRect;
+    private drawBoundingBox;
+    setBoundingBox(): void;
+    /** @ignore */
+    getBoundingRect(): {
+        xMin: number;
+        yMin: number;
+        xMax: number;
+        yMax: number;
+    };
+    /** @ignore */
+    getOuterRect(): {
+        xMin: number;
+        yMin: number;
+        xMax: number;
+        yMax: number;
+    };
+    setAnimationEnabled(value: boolean): void;
+    private calcPoiRotation;
+    getVisibility(): boolean;
+    calcPosAndSize(frustum: NS_THREE.Frustum, widthHalf: number, heightHalf: number): {
+        isInFrustum: boolean;
+    };
+    draw(): void;
+    updatePosition(// 根据已计算出的position, offset, visible 等更新渲染位置, 显隐
+    widthHalf: number, heightHalf: number, index: number): void;
+    update(): boolean;
+    setPoiId(poiId: number): void;
+}
+export { PoiOverlay, Poi };

package/lib/prod/src/owlly/owlly-2d/index.d.ts

@@ -0,0 +1,28 @@
+import { NS_KONVA } from '../stage/externals';
+/**
+ * 为统一2D渲染所提供的解决方案，将会在一段时间后弃用（不再依赖 Konva）
+ */
+declare class Owlly2D {
+    private static containerMap;
+    private konvaContainer;
+    stage: NS_KONVA.Stage;
+    private constructor();
+    static getInstance(container: HTMLElement): Owlly2D;
+    static get initialized(): boolean;
+    static resize(): void;
+    static dispose(): void;
+    static disposeStage(container: HTMLElement): void;
+    resize(containerWidth: number, containerHeight: number): void;
+    addLayer(): NS_KONVA.Layer;
+    /**
+     * 打开交互
+     * pointer-events = auto
+     */
+    openInteraction(): void;
+    /**
+     * 关闭交互
+     * pointer-events = none
+     */
+    closeInteraction(): void;
+}
+export { Owlly2D };

package/lib/prod/src/owlly/screen/index.d.ts

@@ -0,0 +1 @@
+export * from './screen';

package/lib/prod/src/owlly/screen/screen.d.ts

@@ -0,0 +1,73 @@
+import { NS_THREE } from '../stage/externals';
+import { EventHubClassic } from '../utils/event-hub';
+import { View } from '../view/view';
+/** 窗口, 用于描述一个 Canvas / Renderer @ignore */
+declare class Screen extends EventHubClassic {
+    private views;
+    private listeners;
+    renderer: NS_THREE.WebGL1Renderer | NS_THREE.WebGLRenderer;
+    container: HTMLElement;
+    canvas: HTMLCanvasElement;
+    width: number;
+    height: number;
+    enabled: boolean;
+    eventOnContainer: boolean;
+    eventEnable: boolean;
+    constructor(container?: HTMLElement, options?: {
+        isCanvas?: boolean;
+        preserveDrawingBuffer?: boolean;
+        logarithmicDepthBuffer?: boolean;
+        width?: number;
+        height?: number;
+        eventOnContainer?: boolean;
+    });
+    private createRenderer;
+    /**
+     * 设置清屏时的颜色
+     * @param color 颜色
+     * @param alpha 不透明度
+     */
+    setClearColor(color: number | string, alpha?: number): void;
+    private getRenderParams;
+    /**
+     * 设置事件在容器上
+     * @param eventOnContainer 事件在容器S
+     */
+    setEventOnContainer(eventOnContainer: boolean): void;
+    /**
+     * 设置事件有效
+     * @param enable 有效
+     */
+    setEventEnable(enable: boolean): void;
+    private registerEvents;
+    private unregisterEvents;
+    mouseDown(e: MouseEvent): void;
+    mouseMove(e: MouseEvent): void;
+    mouseUp(e: MouseEvent): void;
+    mouseWheel(e: WheelEvent): void;
+    touchStart(e: TouchEvent): void;
+    touchMove(e: TouchEvent): void;
+    touchEnd(e: TouchEvent): void;
+    contextMenu(e: MouseEvent): void;
+    dblclick(e: MouseEvent): void;
+    dispose(): void;
+    resize(width?: number, height?: number): void;
+    /**
+     * 添加 View
+     * @param view 需要添加到 Screen 的 View
+     */
+    addView(view: View): void;
+    /**
+     * 删除 View
+     * @param view 需要删除的 View
+     */
+    removeView(view: View): void;
+    update(): boolean;
+    renderScreen(): void;
+    /**
+     * 设置当前 Screen 是否工作
+     * @param value 开关值
+     */
+    setEnabled(value: boolean): void;
+}
+export { Screen };

package/lib/prod/src/owlly/stage/__test__/stage.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/prod/src/owlly/stage/externals.d.ts

@@ -0,0 +1,19 @@
+import * as THREE from 'three';
+import Konva from 'konva';
+import * as GLTFLoader from 'three/examples/jsm/loaders/GLTFLoader';
+/**
+ * 外部库
+ */
+declare class Externals {
+    private static instance;
+    Konva: typeof Konva;
+    THREE: typeof THREE;
+    setKonvaInstance(konva: typeof Konva): void;
+    setThreeInstance(three: typeof THREE): void;
+    static getInstance(): Externals;
+}
+declare function SetExternal(three: typeof THREE, optionals?: {
+    konva?: typeof Konva;
+    gltfLoader?: typeof GLTFLoader;
+}): void;
+export { Externals, THREE as NS_THREE, Konva as NS_KONVA, SetExternal, };

package/lib/prod/src/owlly/stage/index.d.ts

@@ -0,0 +1,3 @@
+export * from './stage';
+export { Externals, SetExternal, } from './externals';
+export { updateTick } from './owlly';

package/lib/prod/src/owlly/stage/owlly.d.ts

@@ -0,0 +1,38 @@
+import { Stage } from './stage';
+import { Screen } from '../screen/screen';
+import { Controller } from '../controller/controller';
+declare class Owlly {
+    private static SHARED_INSTANCE;
+    private static RequestAnimationFrame;
+    private stages;
+    private screens;
+    private controllers;
+    private timeProfiler;
+    private statsEnabled;
+    private selfManageTick;
+    private forceRender;
+    private listeners;
+    private constructor();
+    static GetSharedInstance(): Owlly;
+    /**
+     * 时钟函数
+     * @param time 距离上一帧的时间, ms
+     */
+    tick(time: number): void;
+    private registerEvents;
+    private onWindowResize;
+    private beforeWindowUnload;
+    registerStage(stage: Stage): void;
+    unregisterStage(stage: Stage): void;
+    registerScreen(screen: Screen): void;
+    unregisterScreen(screen: Screen): void;
+    registerController(controller: Controller): void;
+    unregisterController(controller: Controller): void;
+    setStatsEnabled(value: boolean): void;
+    setRequestAnimationFrameFunction(requestAnimationFrame: Function): void;
+    toggleTickSelfManagement(value: boolean): void;
+    renderNextFrame(): void;
+}
+declare function updateTick(): void;
+declare function forceRender(): void;
+export { Owlly, updateTick, forceRender };

package/lib/prod/src/owlly/stage/stage.d.ts

@@ -0,0 +1,108 @@
+import { NS_THREE } from './externals';
+import { Element } from '../element/element';
+import { View } from '../view';
+import { Controller } from '../controller';
+/**
+ * 场景类, 所有元素应当置于场景中, 视图与场景绑定后可渲染内容
+ */
+declare class Stage {
+    /**
+     * Stage 所使用的 THREE Scene
+     */
+    scene: NS_THREE.Scene;
+    private elements;
+    private lights;
+    private axesHelper;
+    private stageListeners;
+    private disposed;
+    constructor();
+    private registerEvents;
+    private initLights;
+    /**
+     * 旧的时钟函数, 后期应删除
+     * @deprecated
+     */
+    tick(): boolean;
+    /**
+     * 时钟钩子函数
+     * @returns 是否需要重新渲染
+     */
+    update(): boolean;
+    private handleElementUpdate;
+    /**
+     * 绑定视图至场景
+     * @param view 需要添加的视图
+     */
+    bindView(view: View): void;
+    /**
+     * 销毁视图
+     * @param view 需要销毁的视图
+     */
+    disposeView(view: View): void;
+    /**
+     * 绑定一个新的控制器到场景
+     * @param controller 添加的控制器
+     */
+    bindController(controller: Controller): void;
+    /**
+     * 销毁控制器
+     * @param controller 销毁的控制器
+     */
+    disposeController(controller?: Controller): Promise<void>;
+    /**
+     * 绑定元素至场景
+     * @param element 需要绑定的元素
+     */
+    bindElement(element: Element): void;
+    /**
+     * 销毁元素
+     * @param element 需要销毁的元素
+     */
+    disposeElement(element: Element): void;
+    /**
+     * 解绑元素, 元素仅会从 Stage 中移除而非销毁
+     * @param element 需要解绑的元素
+     */
+    unbindElement(element: Element): void;
+    /**
+     * (调试用) 开关性能统计
+     * @param value 开关值
+     */
+    setStatsEnabled(value: boolean): void;
+    /**
+     * (调试用) 开关场景xyz轴指示器
+     * @param value 开关值
+     */
+    setAxesEnabled(value: boolean): void;
+    /**
+     * 强制渲染
+     * @deprecated
+     */
+    render(): void;
+    /**
+     * 销毁场景
+     */
+    dispose(): void;
+    resizeElements(viewWidth: number, viewHeight: number): void;
+    renderElements(): void;
+    /**
+     * 强制重新计算绘制区域
+     * @deprecated
+     */
+    forceResize(): void;
+    /**
+     * 设置全场景背景色
+     * @param hexColor 颜色, 可以使用字符串
+     */
+    setBackgroundColor(hexColor: number | string): void;
+    /**
+     * 设置帧函数
+     * @param requestAnimationFrame
+     */
+    setFrameTickFunction(requestAnimationFrame: Function): void;
+    /**
+     * @ignore
+     */
+    toggleTickSelfManagement(value: boolean): void;
+}
+export { Stage };

package/lib/prod/src/owlly/utils/alignment-utils.d.ts

@@ -0,0 +1,20 @@
+import { View } from '../view/view';
+declare class AlignmentUtils {
+    /**
+     * 获取2d与3d之间的对齐参数
+     * @param view 基准视图
+     * @param baseImageScale 底图缩放等级, 绝对值
+     * @param offset 底图整体偏移, 结构为 [ number, number ], 对应x, y轴偏移值
+     * @param imageSize 底图图片尺寸, 结构为 [ number, number ], 对应宽度, 高度
+     * @returns { upTrans: number[]; downTrans: number[]; matrixWorld: number[]; } 三个矩阵,
+     *  uptrans: 2d转3d, downTrans: 3d转2d, matrixWorld: 相机自身参数, 重设时使用
+     */
+    static getTransformMatrices(view: View, baseImageScale: number, offset: [number, number], imageSize: [number, number]): {
+        upTransOrigin: number[];
+        downTransOrigin: number[];
+        upTrans: number[];
+        downTrans: number[];
+        matrixWorld: number[];
+    };
+}
+export { AlignmentUtils };

package/lib/prod/src/owlly/utils/basic-calc.d.ts

@@ -0,0 +1,18 @@
+interface Coord2d {
+    x: number;
+    y: number;
+}
+interface TurningInfo {
+    point: number[];
+    angle: number;
+    startTPoint: number[];
+    endTPoint: number[];
+    startIndex: number;
+    endIndex: number;
+}
+declare class BasicCalcTool {
+    static getLineCross(line1_p1: Coord2d, line1_p2: Coord2d, line2_p1: Coord2d, line2_p2: Coord2d): boolean;
+    static calcTurning(linePoints: [number, number][], turningStandard?: number[]): TurningInfo[];
+    static chunk(items: any[], size: number): any[][];
+}
+export { BasicCalcTool, TurningInfo };

package/lib/prod/src/owlly/utils/basic-tools.d.ts

@@ -0,0 +1,71 @@
+import { NS_THREE } from '../stage/externals';
+import { Element } from '../element/element';
+import { View } from '../view/view';
+declare class BasicTools {
+    /**
+     * 销毁工具
+     * @param o 对象
+     * @param recursive 递归销毁
+     */
+    static dispose(o: NS_THREE.Object3D, recursive?: boolean): void;
+    /**
+     * 鼠标碰撞工具函数
+     * @param objects 需要检测碰撞的 Element
+     * @param param1 鼠标点击坐标
+     * @param camera 使用的相机
+     * @param candidates 候选者, candidate 存在于 object 中
+     * @param maxWorldDistance 世界中点击时的距离
+     * @returns 碰撞对象
+     */
+    static getMouseIntersection(objects: Element[], { x, y }: {
+        x: number;
+        y: number;
+    }, camera: NS_THREE.Camera, candidates?: Element[], maxWorldDistance?: number): NS_THREE.Intersection | null;
+    /**
+     * 获取屏幕空间的点击碰撞
+     * @param objects 需要检查的对象
+     * @param param1 点击坐标
+     * @param param2 屏幕尺寸
+     * @param maxDistance 最大检测距离
+     * @param camera 相机
+     * @param candidates 候选对象, 可能在 object 内
+     * @param maxWorldDistance 最大世界空间坐标检测距离
+     * @param boundingBoxes 候选的碰撞盒, 可选
+     * @returns 碰撞到的对象
+     */
+    static getMouseIntersectionOnScreen(objects: NS_THREE.Object3D[] | Element[], { x, y }: {
+        x: number;
+        y: number;
+    }, { screenWidth, screenHeight }: {
+        screenWidth: number;
+        screenHeight: number;
+    }, maxDistance: number, camera: NS_THREE.Camera, candidates?: NS_THREE.Object3D[] | Element[], maxWorldDistance?: number, boundingBoxes?: Map<NS_THREE.Object3D | Element, [number, number]>): NS_THREE.Object3D | Element | null;
+    /**
+     * 转换俯视图屏幕坐标为三维坐标
+     * @param {x, y} 屏幕坐标
+     * @param view 视图
+     * @param camera 相机
+     */
+    static getHorizontalPlaneCoordinate({ x, y }: {
+        x: number;
+        y: number;
+    }, view: View, camera: NS_THREE.Camera | undefined): NS_THREE.Vector2 | null;
+    static getHorizontalPlaneCoordinate3({ x, y }: {
+        x: number;
+        y: number;
+    }, view: View, camera: NS_THREE.Camera | undefined): NS_THREE.Vector3 | null;
+    /**
+     * 将坐标投影到屏幕空间
+     * @param position 世界坐标
+     * @param view 视图
+     * @param camera 相机
+     * @returns 转换后的屏幕坐标
+     */
+    static projectToScreenCoordinate(position: NS_THREE.Vector3, view: View, camera: NS_THREE.Camera | undefined): {
+        x: number;
+        y: number;
+    } | null;
+    private static getMesh;
+    static debounce(fn: Function, delay: number): Function;
+}
+export { BasicTools };