earthsdk3 3.0.6 → 3.0.7-beta.11

package/dist/types/ESObjects/general/ESCameraViewCollection/index.d.ts

@@ -1,177 +1,296 @@
-import { ObservableArray, UniteChanged, UniteJson } from "xbsj-base";
-import { ESJViewInfo } from "../../../ESJTypes";
-import { ESSceneObject } from "../../base";
-import { ViewWrapper } from "./ViewWrapper";
-/**
- * https://www.wolai.com/earthsdk/eV1jsaXWLWjaetTVCeSvww
- * https://c0yh9tnn0na.feishu.cn/wiki/VYnPwLAY4iUVQfkAuXWcuFKDnmh
- */
-export declare class ESCameraViewCollection extends ESSceneObject {
-    static readonly type: string;
-    get typeName(): string;
-    get defaultProps(): {
-        playing: boolean;
-        loop: boolean;
-        intervalTime: number;
-        flyMode: "default" | "uniform";
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-    get json(): JsonType;
-    set json(value: JsonType);
-    private _currentViewIndex;
-    get currentViewIndex(): number;
-    get currentViewIndexChanged(): import("xbsj-base").Listener<[number, number]>;
-    private _viewWrappers;
-    private _currentViewWrapper;
-    emitViewsWarpper(): void;
-    private _container;
-    get container(): HTMLDivElement | undefined;
-    get containerChanged(): import("xbsj-base").Listener<[HTMLDivElement | undefined, HTMLDivElement | undefined]>;
-    set container(value: HTMLDivElement | undefined);
-    get views(): ESJViewInfo[];
-    get viewsChanged(): import("xbsj-base").Event<[target: ObservableArray<ViewWrapper>]>;
-    set views(value: ESJViewInfo[]);
-    /**
-     * 获取当前视角的index
-     * @param viewWrapper 当前选中的视角
-     * @returns 选中视角的index
-     */
-    private _getIndex;
-    /**
-     * 删除所有视角
-     */
-    clearAllViews(): void;
-    /**
-     * 添加视角
-     * @param name 视角名称 string | undefined ,默认 `视角${views.length+ 1}`
-     * @param size 截图尺寸 [number, number]  | undefined,默认[64, 64]
-     */
-    add(name?: string, size?: [number, number]): void;
-    /**
-     * 更新视角
-     * @param index 更新指定位置的视角 number
-     * @param name 视角名称 string | undefined
-     * @param size 截图尺寸 [number, number]  | undefined,默认[64, 64]
-     */
-    update(index: number, name?: string, size?: [number, number]): false | undefined;
-    /**
-     * 添加视角
-     */
-    addView(): void;
-    /**
-     * 插入视角
-     * @param index 当前视角的index
-     * @returns
-     */
-    insertView(index: number): void;
-    /**
-     * 设置当前视角
-     * @param index 当前视角的index
-     * @returns
-     */
-    setCurrentView(index: number): boolean;
-    /**
-     * 重置视角
-     * @param index 当前视角的index
-     * @returns
-     */
-    resetView(index: number): void;
-    /**
-     * 重置视角名称
-     * @param index 当前视角的index
-     * @returns
-     */
-    resetViewName(index: number, value: string): void;
-    /**
-     * 修改指定视角
-     * @param index 当前视角的index
-     * @returns
-     */
-    updateView(index: number, val: ESJViewInfo): false | undefined;
-    /**
-     * 飞入指定视角
-     * @param index
-     */
-    flyToView(index: number): void;
-    /**
-     * 上一个视角
-     * @returns
-     */
-    flyToPrevView(): boolean;
-    /**
-    * 当前视角移动到上一个视角
-    * @returns
-    */
-    moveToPreView(): void;
-    /**
-   * 当前视角移动到下一个视角
-   * @returns
-   */
-    moveToNextView(): void;
-    /**
-     * 下一个视角
-     * @returns
-     */
-    flyToNextView(): boolean;
-    /**
-     * 停止
-     */
-    stop(): void;
-    /**
-     * 删除指定视角
-     * @param index 要删除视角的index
-     * @returns
-     */
-    deleteView(index: number): void;
-    /**
-     * 删除当前视角
-     * @returns
-     */
-    deleteCurrentView(): void;
-    /**
-     * 转换图片路径
-     * @param url 图片路径
-     * @returns 转化以后的图片路径
-     */
-    transitionImageUrl(url: string): string;
-    constructor(id?: string);
-    static defaults: {
-        loop: boolean;
-        playing: boolean;
-        intervalTime: number;
-        duration: number;
-        views: never[];
-        flyMode: "default" | "uniform";
-        flyModes: [name: string, value: string][];
-    };
-    getProperties(language?: string): import("../../../ESJTypes").Property[];
-}
-export declare namespace ESCameraViewCollection {
-    const createDefaultProps: () => {
-        playing: boolean;
-        loop: boolean;
-        intervalTime: number;
-        flyMode: "default" | "uniform";
-        name: string;
-        ref: string | undefined;
-        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
-        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
-        execOnceFuncStr: string | undefined;
-        updateFuncStr: string | undefined;
-        toDestroyFuncStr: string | undefined;
-    };
-}
-export interface ESCameraViewCollection extends UniteChanged<ReturnType<typeof ESCameraViewCollection.createDefaultProps>> {
-}
-type JsonType = UniteJson<ReturnType<typeof ESCameraViewCollection.createDefaultProps> & {
-    type: string;
-} & {
-    views: ESJViewInfo[];
-}>;
-export {};
+import { ObservableArray, UniteChanged, UniteJson } from "xbsj-base";
+import { ESJViewInfo } from "../../../ESJTypes";
+import { ESSceneObject } from "../../base";
+import { ViewWrapper } from "./ViewWrapper";
+/**
+ * ESCameraViewCollection 类用于管理和控制一组相机视角。它继承自 ESSceneObject 类，提供了一系列方法来添加、删除、更新和切换相机视角。
+ *
+ * 核心功能包括：
+ * - 管理一组相机视角（添加、删除、更新视角信息）
+ * - 切换当前视角
+ * - 飞行到指定视角
+ * - 播放视角序列
+ * - 停止播放
+ * - 获取和设置视角集合的 JSON 表示
+ *
+ * 使用示例：
+ * https://www.wolai.com/earthsdk/eV1jsaXWLWjaetTVCeSvww
+ * https://c0yh9tnn0na.feishu.cn/wiki/VYnPwLAY4iUVQfkAuXWcuFKDnmh
+ * 构造函数参数：
+ * - `id`：对象的 ID，可选。
+ *
+ * 特殊使用限制或潜在的副作用：
+ * - 在设置视角信息时，如果视角信息数组与当前视角包装器数组长度相同且内容相同，则不会触发更新。
+ * - 在删除视角时，如果索引超出范围，会打印警告信息。
+ * - 在飞行到视角时，如果当前视角包装器为空，会抛出错误。
+ *
+ * 默认属性：
+ * - `loop`：是否循环播放视角序列，默认为 true。
+ * - `playing`：是否正在播放视角序列，默认为 false。
+ * - `intervalTime`：视角之间的间隔时间（秒），默认为 5。
+ * - `duration`：视角的飞行时间（秒），默认为 1。
+ * - `views`：视角信息数组，默认为空数组。
+ * - `flyMode`：飞行模式，默认为 'default'，可选值  [['默认', 'default'], ['直线飞行', 'uniform']]。
+ */
+export declare class ESCameraViewCollection extends ESSceneObject {
+    /**
+     * 静态属性，用于注册该类的类型信息，包含中文名称、标签和描述。
+     */
+    static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns 类型名称字符串。
+     */
+    get typeName(): string;
+    /**
+     * 重写方法，获取默认属性。
+     * @returns 默认属性对象。
+     */
+    get defaultProps(): {
+        /**开始播放 */
+        playing: boolean;
+        /**是否循环 */
+        loop: boolean;
+        /**间隔时间 */
+        intervalTime: number;
+        /**飞行模式 默认为相机飞行，uniform为两点直线飞行*/
+        flyMode: "default" | "uniform";
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+    /**
+     * 重写方法，获取对象的 JSON 表示。
+     * @returns 包含视图信息的 JSON 对象。
+     */
+    get json(): JsonType;
+    /**
+     * 重写方法，设置对象的 JSON 表示。
+     * @param value 要设置的 JSON 对象。
+     */
+    set json(value: JsonType);
+    /**
+     * 私有属性，当前视角的索引。
+     */
+    private _currentViewIndex;
+    /**
+     * 获取当前视角的索引。
+     * @returns 当前视角的索引。
+     */
+    get currentViewIndex(): number;
+    /**
+     * 获取当前视角索引变化的可观察对象。
+     * @returns 当前视角索引变化的可观察对象。
+     */
+    get currentViewIndexChanged(): import("xbsj-base").Listener<[number, number]>;
+    /**
+     * 私有属性，视角包装器的可观察数组。
+     */
+    private _viewWrappers;
+    /**
+     * 私有属性，当前视角的包装器。
+     */
+    private _currentViewWrapper;
+    /**
+     * 触发视图包装器变化的事件。
+     */
+    emitViewsWarpper(): void;
+    /**
+     * 私有属性，容器元素。
+     */
+    private _container;
+    /**
+     * 获取容器元素。
+     * @returns 容器元素。
+     */
+    get container(): HTMLDivElement | undefined;
+    /**
+     * 获取容器元素变化的可观察对象。
+     * @returns 容器元素变化的可观察对象。
+     */
+    get containerChanged(): import("xbsj-base").Listener<[HTMLDivElement | undefined, HTMLDivElement | undefined]>;
+    /**
+     * 设置容器元素。
+     * @param value 要设置的容器元素。
+     */
+    set container(value: HTMLDivElement | undefined);
+    /**
+     * 获取所有视角的信息。
+     * @returns 视角信息数组。
+     */
+    get views(): ESJViewInfo[];
+    /**
+     * 获取视图信息变化的事件。
+     * @returns 视图信息变化的事件。
+     */
+    get viewsChanged(): import("xbsj-base").Event<[target: ObservableArray<ViewWrapper>]>;
+    /**
+     * 设置视图信息。
+     * @param value 要设置的视图信息数组。
+     */
+    set views(value: ESJViewInfo[]);
+    /**
+     * 获取指定视角包装器的索引。
+     * @param viewWrapper 当前选中的视角包装器。
+     * @returns 选中视角的索引。
+     */
+    private _getIndex;
+    /**
+     * 删除所有视角。
+     */
+    clearAllViews(): void;
+    /**
+     * 添加视角。
+     * @param name 视角名称，默认为 `视角${views.length+ 1}`。
+     * @param size 截图尺寸，默认为[64, 64]。
+     */
+    add(name?: string, size?: [number, number]): void;
+    /**
+     * 更新指定位置的视角。
+     * @param index 更新指定位置的视角索引。
+     * @param name 视角名称，可选。
+     * @param size 截图尺寸，默认为[64, 64]。
+     * @returns 更新是否成功。
+     */
+    update(index: number, name?: string, size?: [number, number]): boolean;
+    /**
+     * 添加视角。
+     */
+    addView(): void;
+    /**
+     * 插入视角。
+     * @param index 当前视角的索引。
+     */
+    insertView(index: number): void;
+    /**
+     * 设置当前视角。
+     * @param index 当前视角的索引。
+     * @returns 设置是否成功。
+     */
+    setCurrentView(index: number): boolean;
+    /**
+     * 重置指定位置的视角。
+     * @param index 当前视角的索引。
+     */
+    resetView(index: number): void;
+    /**
+     * 重置指定位置视角的名称。
+     * @param index 当前视角的索引。
+     * @param value 要设置的视角名称。
+     */
+    resetViewName(index: number, value: string): void;
+    /**
+     * 修改指定位置的视角信息。
+     * @param index 当前视角的索引。
+     * @param val 要设置的视角信息。
+     * @returns 修改是否成功。
+     */
+    updateView(index: number, val: ESJViewInfo): boolean;
+    /**
+     * 飞入指定视角。
+     * @param index 要飞入的视角索引。
+     */
+    flyToView(index: number): void;
+    /**
+     * 飞入上一个视角。
+     * @returns 飞入是否成功。
+     */
+    flyToPrevView(): boolean;
+    /**
+     * 将当前视角移动到上一个位置。
+     */
+    moveToPreView(): void;
+    /**
+     * 将当前视角移动到下一个位置。
+     */
+    moveToNextView(): void;
+    /**
+     * 飞入下一个视角。
+     * @returns 飞入是否成功。
+     */
+    flyToNextView(): boolean;
+    /**
+     * 停止播放。
+     */
+    stop(): void;
+    /**
+     * 删除指定视角。
+     * @param index 要删除视角的索引。
+     */
+    deleteView(index: number): void;
+    /**
+     * 删除当前视角。
+     */
+    deleteCurrentView(): void;
+    /**
+     * 转换图片路径。
+     * @param url 图片路径。
+     * @returns 转换后的图片路径。
+     */
+    transitionImageUrl(url: string): string;
+    /**
+     * 构造函数。
+     * @param id 对象的 ID，可选。
+     */
+    constructor(id?: string);
+    /**
+     * 静态属性，默认配置。
+     */
+    static defaults: {
+        loop: boolean;
+        playing: boolean;
+        intervalTime: number;
+        duration: number;
+        views: never[];
+        flyMode: "default" | "uniform";
+        flyModes: [name: string, value: string][];
+    };
+    /**
+     * 获取对象的属性列表。
+     * @param language 语言，可选。
+     * @returns 属性列表。
+     */
+    getProperties(language?: string): import("../../../ESJTypes").Property[];
+}
+export declare namespace ESCameraViewCollection {
+    /**
+     * 创建默认属性对象。
+     * @returns 默认属性对象。
+     */
+    const createDefaultProps: () => {
+        /**开始播放 */
+        playing: boolean;
+        /**是否循环 */
+        loop: boolean;
+        /**间隔时间 */
+        intervalTime: number;
+        /**飞行模式 默认为相机飞行，uniform为两点直线飞行*/
+        flyMode: "default" | "uniform";
+        name: string;
+        ref: string | undefined;
+        extras: import("xbsj-base").ReactiveVariable<import("xbsj-base").JsonValue>;
+        devTags: import("xbsj-base").ReactiveVariable<string[] | undefined>;
+        execOnceFuncStr: string | undefined;
+        updateFuncStr: string | undefined;
+        toDestroyFuncStr: string | undefined;
+    };
+}
+/**
+ * 定义 ESCameraViewCollection 类的扩展接口，包含属性变化的相关方法。
+ */
+export interface ESCameraViewCollection extends UniteChanged<ReturnType<typeof ESCameraViewCollection.createDefaultProps>> {
+}
+/**
+ * 定义 JSON 类型，包含默认属性、类型和视图信息。
+ */
+type JsonType = UniteJson<ReturnType<typeof ESCameraViewCollection.createDefaultProps> & {
+    type: string;
+} & {
+    views: ESJViewInfo[];
+}>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ESObjects/general/ESCameraViewCollection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/ESObjects/general/ESCameraViewCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,eAAe,EAAgB,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACpI,OAAO,EAAiC,WAAW,EAAqF,MAAM,mBAAmB,CAAC;AAElK,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,sBAAuB,SAAQ,aAAa;IACrD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAkJ;IAEtK;;;OAGG;IACH,IAAI,QAAQ,WAAuC;IAEnD;;;OAGG;IACH,IAAa,YAAY;QA2drB,UAAU;;QAEV,UAAU;;QAEV,UAAU;;QAEV,gCAAgC;iBACV,SAAS,GAAG,SAAS;;;;;;;;MAleoC;IAEnF;;;OAGG;IACH,IAAa,IAAI,IAMQ,QAAQ,CANsE;IAEvG;;;OAGG;IACH,IAAa,IAAI,CAAC,KAAK,EAAE,QAAQ,EAA0D;IAE3F;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAA8B;IAEvD;;;OAGG;IACH,IAAI,gBAAgB,WAA2C;IAE/D;;;OAGG;IACH,IAAI,uBAAuB,mDAA6C;IAExE;;OAEG;IACH,OAAO,CAAC,aAAa,CAA+C;IAEpE;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAsD;IAEjF;;OAEG;IACH,gBAAgB;IAEhB;;OAEG;IACH,OAAO,CAAC,UAAU,CAAyD;IAE3E;;;OAGG;IACH,IAAI,SAAS,IAYQ,cAAc,GAAG,SAAS,CAZE;IAEjD;;;OAGG;IACH,IAAI,gBAAgB,2FAAsC;IAE1D;;;OAGG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,EAAoC;IAEnF;;;OAGG;IACH,IAAI,KAAK,IAYQ,WAAW,EAAE,CAZkC;IAEhE;;;OAGG;IACH,IAAI,YAAY,sEAA8C;IAE9D;;;OAGG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,EAa7B;IAED;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,aAAa;IAOb;;;;OAIG;IACH,GAAG,CAAC,IAAI,GAAE,MAAqC,EAAE,IAAI,GAAE,CAAC,MAAM,EAAE,MAAM,CAAY;IAIlF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,GAAE,CAAC,MAAM,EAAE,MAAM,CAAY;IAYtE;;OAEG;IACH,OAAO;IAEP;;;OAGG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;IAQxB;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM;IAU5B;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM;IAUvB;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAS1C;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW;IAc1C;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM;IAQvB;;;OAGG;IACH,aAAa;IAoBb;;OAEG;IACH,aAAa;IASb;;OAEG;IACH,cAAc;IASd;;;OAGG;IACH,aAAa;IAoBb;;OAEG;IACH,IAAI;IAKJ;;;OAGG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;IAUxB;;OAEG;IACH,iBAAiB;IAcjB;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM;IAI9B;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAqDvB;;OAEG;IACH,OAAgB,QAAQ;;;;;;iBAOE,SAAS,GAAG,SAAS;kBACW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;MACvF;IAEF;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CA+B3C;AAED,yBAAiB,sBAAsB,CAAC;IACpC;;;OAGG;IACI,MAAM,kBAAkB;QAE3B,UAAU;;QAEV,UAAU;;QAEV,UAAU;;QAEV,gCAAgC;iBACV,SAAS,GAAG,SAAS;;;;;;;;KAC7C,CAAC;CACN;AAID;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CAAI;AAE9H;;GAEG;AACH,KAAK,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,kBAAkB,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,WAAW,EAAE,CAAA;CAAE,CAAC,CAAC"}