@realsee/dnalogel 3.25.0 → 3.25.2

package/dist/CruisePlugin/Move.d.ts

@@ -5,7 +5,14 @@ import type { PartialDeep } from 'type-fest';
 import * as THREE from 'three';
 import { type AnyPosition } from '../shared-utils/positionToVector3';
 interface Data extends GuildLineConfig {
+    /**
+     * @description: 组成路径的空间坐标点
+     */
     path: THREE.CurvePath<THREE.Vector3> | AnyPosition[];
+    /**
+     * @description: 漫游镜头偏移量，注意会与插件初始化时的 config.offset 叠加
+     * @default: { x: 0, y: 0, z: 0 }
+     */
     offset?: Partial<{
         x: number;
         y: number;
@@ -13,11 +20,19 @@ interface Data extends GuildLineConfig {
     }>;
 }
 export interface MoveConfig extends Config {
+    /**
+     * @description: 漫游时镜头基于路径的偏移量
+     * @default: { x: 0, y: 2, z: 0 }
+     */
     offset?: Partial<{
         x: number;
         y: number;
         z: number;
     }>;
+    /**
+     * @description: 滑动屏幕时允许打断漫游
+     * @default: true
+     */
     allowBroke?: boolean;
 }
 export default class MoveController extends CruiseController<Data, MoveConfig> {

package/dist/CruisePlugin/typing.d.ts

@@ -137,7 +137,9 @@ export interface EventMap extends BasePluginWithData.EventMap<PluginState, Plugi
     progressChange: (progress: number) => void;
 }
 export interface Config extends BasePlugin.Config {
-    /** 漫游时是否加载路线 */
+    /**
+     * @description: 漫游时是否加载路线
+     */
     useGuideLine?: boolean;
 }
 export type CruisePluginExportType = ReturnType<typeof CruisePlugin>;

package/dist/Sculpt/Objects/Base/index.d.ts

@@ -5,7 +5,13 @@ import type { RequiredDeep } from 'type-fest';
 import type { ImportDataToExportData } from '../../typings/utils.type';
 import type * as THREE from 'three';
 export interface BaseImportData {
+    /**
+     * @description: 唯一标识
+     */
     id?: string;
+    /**
+     * @description: 物体类型
+     */
     type: string;
 }
 export interface BaseExportData extends RequiredDeep<BaseImportData> {

package/dist/Sculpt/index.d.ts

@@ -1,6 +1,6 @@
 import type { Five } from '@realsee/five';
 import type * as THREE from 'three';
-import type { BaseObject, BaseObjectConfig } from './Objects/Base';
+import type { BaseObjectConfig } from './Objects/Base';
 import { Subscribe } from '../shared-utils/Subscribe';
 import { IObject3D } from '../shared-utils/three/IObject3D';
 import type { PartialDeep } from 'type-fest';
@@ -13,6 +13,7 @@ import { Circle } from './Objects/Circle';
 import { Cylinder } from './Objects/Cylinder';
 import { Box } from './Objects/Box';
 import type { PolylineImportData, PointImportData, PolygonImportData, PrismImportData, RectangleImportData, CircleImportData, CylinderImportData, BoxImportData } from './typings';
+export type { SculptData } from './typings';
 import type { AreaStyle, PointStyle, PolylineStyle, PrismStyle, RectangleStyle, CircleStyle, CylinderStyle, BoxStyle } from './typings';
 type BuiltInData = PolylineImportData | PointImportData | PolygonImportData | PrismImportData | RectangleImportData | CircleImportData | CylinderImportData | BoxImportData;
 type BuiltInItem = Polyline | Point | Polygon | Prism | Rectangle | Circle | Cylinder | Box;
@@ -137,59 +138,35 @@ export declare class Sculpt extends Subscribe<Event> {
     /**
      * @description: 开始绘制点
      */
-    createPoint(params?: Parameters<Point['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createPoint(params?: Parameters<Point['create']>[0]): Promise<Point>;
     /**
      * @description: 开始绘制空间折线
      */
-    createPolyline(params?: Parameters<Polyline['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createPolyline(params?: Parameters<Polyline['create']>[0]): Promise<Polyline>;
     /**
      * @description: 开始绘制平面多边形
      */
-    createPolygon(params?: Parameters<Polygon['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createPolygon(params?: Parameters<Polygon['create']>[0]): Promise<Polygon>;
     /**
      * @description: 开始绘制多棱柱
      */
-    createPrism(params?: Parameters<Prism['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createPrism(params?: Parameters<Prism['create']>[0]): Promise<Prism>;
     /**
      * @description: 开始绘制矩形
      */
-    createRectangle(params?: Parameters<Rectangle['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createRectangle(params?: Parameters<Rectangle['create']>[0]): Promise<Rectangle>;
     /**
      * @description: 开始绘制圆形
      */
-    createCircle(params?: Parameters<Circle['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createCircle(params?: Parameters<Circle['create']>[0]): Promise<Circle>;
     /**
      * @description: 开始绘制圆柱
      */
-    createCylinder(params?: Parameters<Cylinder['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createCylinder(params?: Parameters<Cylinder['create']>[0]): Promise<Cylinder>;
     /**
      * @description: 开始绘制 Box
      */
-    createBox(params?: Parameters<Box['create']>[0]): Promise<BaseObject<any, {
-        [x: string]: any;
-        id: string | number;
-    }, BaseObjectConfig>>;
+    createBox(params?: Parameters<Box['create']>[0]): Promise<Box>;
     /**
      * @description: 撤销
      */
@@ -205,4 +182,7 @@ export declare class Sculpt extends Subscribe<Event> {
     private createItem;
     private needsRender;
 }
-export {};
+/**
+ * @description: Sculpt 插件
+ */
+export declare const SculptPlugin: (five: Five) => Sculpt;

package/dist/Sculpt/typings/index.d.ts

@@ -1,3 +1,22 @@
+import type { SimplifyDeep } from 'type-fest/source/merge-deep';
+import type { PolylineImportData } from '../Objects/Polyline';
+import type { PointImportData } from '../Objects/Point';
+import type { PolygonImportData } from '../Objects/Polygon';
+import type { PrismImportData } from '../Objects/Prism';
+import type { RectangleImportData } from '../Objects/Rectangle';
+import type { CircleImportData } from '../Objects/Circle';
+import type { CylinderImportData } from '../Objects/Cylinder';
+import type { BoxImportData } from '../Objects/Box';
+export declare namespace SculptData {
+    type PolylineData = SimplifyDeep<PolylineImportData>;
+    type PointData = SimplifyDeep<PointImportData>;
+    type PolygonData = SimplifyDeep<PolygonImportData>;
+    type PrismData = SimplifyDeep<PrismImportData>;
+    type RectangleData = SimplifyDeep<RectangleImportData>;
+    type CircleData = SimplifyDeep<CircleImportData>;
+    type CylinderData = SimplifyDeep<CylinderImportData>;
+    type BoxData = SimplifyDeep<BoxImportData>;
+}
 export type { Polyline, PolylineImportData } from '../Objects/Polyline';
 export type { Point, PointImportData } from '../Objects/Point';
 export type { Polygon, PolygonImportData } from '../Objects/Polygon';