@realsee/dnalogel 3.24.3 → 3.25.1

package/dist/CruisePlugin/Move.d.ts

@@ -1,32 +1,47 @@
 import type { Five } from '@realsee/five';
 import CruiseController from './BaseController';
-import type { PluginState } from './typing';
+import type { Config, GuildLineConfig, PluginState } from './typing';
 import type { PartialDeep } from 'type-fest';
 import * as THREE from 'three';
 import { type AnyPosition } from '../shared-utils/positionToVector3';
-type Data = {
+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;
         z: number;
     }>;
-};
-export type Config = {
+}
+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, Config> {
+}
+export default class MoveController extends CruiseController<Data, MoveConfig> {
     private curve;
     private baseCurveOffset;
     private curveOffset;
     private playStartedTime;
     private duration;
-    constructor(five: Five, config?: Config);
+    constructor(five: Five, config?: MoveConfig);
     load(data: Data, state?: PartialDeep<PluginState>): Promise<void>;
     changeSpeed: (speed: number, userAction?: boolean) => void;
     moveToStart: () => void;

package/dist/CruisePlugin/index.d.ts

@@ -1,7 +1,7 @@
 import type { FivePlugin } from '@realsee/five';
 import * as CruisePluginTypes from './typing';
 import type { Config } from './typing';
-import type { Config as MovePluginConfig } from './Move';
+import type { MoveConfig as MovePluginConfig } from './Move';
 import WalkController from './Work';
 import MoveController from './Move';
 export declare const CruisePlugin: FivePlugin<Config | undefined, InstanceType<typeof WalkController>>;

package/dist/CruisePlugin/typing.d.ts

@@ -24,18 +24,20 @@ export interface CruiseKeyframe {
     end?: number;
     data: CruiseData;
 }
-export interface PluginData {
+export interface GuildLineConfig {
+    /**
+     * @description: 是否使用引导路线
+     * @default: false
+     */
+    useGuildLine?: boolean;
+    /** 传递给 GuildPlugin 的参数 */
+    guildPluginOptions?: GuideLinePluginData['config'];
+}
+export interface PluginData extends GuildLineConfig {
     keyframesId: string;
     keyframes: CruiseKeyframe[];
-    useGuildLine?: boolean;
-    guildPluginOptions?: {
-        arrowTextureUrl?: string;
-        skipPanoIndexMesh?: boolean;
-        unitWidth?: number;
-        unitHeight?: number;
-    };
 }
-export interface MoveAction {
+export interface MoveAction extends GuildLineConfig {
     /** five走点动画 */
     moveEffect?: MoveEffect;
     /** 到第一个点的走点动画 / 续播到暂停处的走点动画 */
@@ -46,10 +48,6 @@ export interface MoveAction {
     moveType?: 'justMove' | 'moveAndRotate';
     /** 停留时长 */
     stay?: number;
-    /** 是否自动使用引导路线 */
-    useGuildLine?: boolean;
-    /** 传递给 GuildPlugin 的参数 */
-    guildPluginOptions?: GuideLinePluginData['config'];
 }
 export interface MoveWithPanoIndexAction extends MoveAction {
     /** 点位列表 */
@@ -139,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/index.d.ts

@@ -205,4 +205,8 @@ export declare class Sculpt extends Subscribe<Event> {
     private createItem;
     private needsRender;
 }
+/**
+ * @description: Sculpt 插件
+ */
+export declare const SculptPlugin: (five: Five) => Sculpt;
 export {};