earthsdk3 3.0.8-beta.9 → 3.2.0-beta.2

package/dist/types/ESObjects/general/ESPipeline.d.ts

@@ -1,22 +1,56 @@
-import { BooleanProperty, ColorProperty, EnumProperty, ESJResource, GroupProperty, NumberProperty } from "../../ESJTypes";
 import { UniteChanged } from "xbsj-base";
+import { BooleanProperty, ColorProperty, EnumProperty, ESJResource, GroupProperty, NumberProperty } from "../../ESJTypes";
 import { ESGeoLineString } from "./ESGeoLineString";
 /**
- * 管线
- * https://www.wolai.com/earthsdk/2X9zwccAfriMJiogcgNwep
+ * ESPipeline 管线类
+ *
+ * 用于创建和管理三维场景中的管线对象，继承自 ESGeoLineString 类。
+ * 管线是一种特殊的线性几何体，具有圆形截面和可配置的材质效果。
+ *
+ * 核心功能：
+ * - 创建具有圆形截面的三维管线
+ * - 支持自定义管线半径和圆边细分数
+ * - 提供丰富的材质配置，包括纹理、动画速度和模式
+ * - 继承线性几何体的所有基础功能（坐标点管理、样式设置等）
+ *
+ * 使用示例：
+ *
+ * @param id - 可选的管线唯一标识符，用于管线对象的识别和管理
+ *
+ * 注意事项：
+ * - 管线默认启用填充效果，禁用描边效果
+ * - 部分属性已被标记为弃用（如旧版本的 materialMode 值和 show 属性）
+ * - 管线需要至少两个坐标点才能正确显示
+ * - 材质图片配置需要提供有效的图片资源URL
  */
 export declare class ESPipeline extends ESGeoLineString {
+    /**
+     * 注册管线类型，包含类型名称、类、中文名称、标签和描述信息
+     */
     static readonly type: string;
+    /**
+     * 获取类型名称
+     * @returns 类型名称 'ESPipeline'
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性
+     * @returns 默认属性对象
+     */
     get defaultProps(): {
+        /** 管线的半径，默认值为 10 */
         radius: number;
+        /** 管线圆边的数量，默认值为 10 */
         sides: number;
+        /** 材质模式，默认值为 'singleArrow' */
         materialMode: string;
+        /** 材质图片和重复度信息，使用 reactJson 包装默认值 */
         materialImage: import("xbsj-base").ReactiveVariable<{
             url: string | ESJResource;
             uDis: number;
             vDis: number;
         }>;
+        /** 材质的移动速度，默认值为 1 */
         speed: number;
         stroked: boolean;
         strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
@@ -38,15 +72,23 @@ export declare class ESPipeline extends ESGeoLineString {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 管线的默认属性配置，继承自 ESGeoLineString 的默认属性，并添加了管线特有的属性
+     */
     static defaults: {
+        /** 管线的半径，默认值为 10 */
         radius: number;
+        /** 管线圆边的数量，默认值为 10 */
         sides: number;
+        /** 材质图片和重复度信息，包含图片URL、u方向重复距离和v方向重复距离 */
         materialImage: {
             url: string | ESJResource;
             uDis: number;
             vDis: number;
         };
+        /** 材质的移动速度，默认值为 1 */
         speed: number;
+        /** 材质模式的选项，包含名称和对应的值 */
         materialModes: [name: string, value: string][];
         strokeStyle: import("../../ESJTypes").ESJStrokeStyle;
         stroked: boolean;
@@ -61,14 +103,28 @@ export declare class ESPipeline extends ESGeoLineString {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 已弃用的属性列表，包含属性的映射和单个属性
+     */
     _deprecated: (string | {
         materialMode: {
             blue: string;
             purple: string;
         };
     })[];
+    /**
+     * 弃用警告函数，调用 _deprecatedWarning 方法
+     */
     private _deprecatedWarningFunc;
+    /**
+     * 构造函数
+     * @param id - 管线的可选ID
+     */
     constructor(id?: string);
+    /**
+     * 获取 ES 属性配置
+     * @returns ES 属性配置对象
+     */
     getESProperties(): {
         defaultMenu: string;
         basic: import("../../ESJTypes").Property[];
@@ -78,18 +134,32 @@ export declare class ESPipeline extends ESGeoLineString {
         dataSource: import("../../ESJTypes").Property[];
         location: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取属性配置
+     * @param language - 可选的语言参数
+     * @returns 属性配置数组
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
 export declare namespace ESPipeline {
+    /**
+     * 创建默认属性对象
+     * @returns 默认属性对象
+     */
     const createDefaultProps: () => {
+        /** 管线的半径，默认值为 10 */
         radius: number;
+        /** 管线圆边的数量，默认值为 10 */
         sides: number;
+        /** 材质模式，默认值为 'singleArrow' */
         materialMode: string;
+        /** 材质图片和重复度信息，使用 reactJson 包装默认值 */
         materialImage: import("xbsj-base").ReactiveVariable<{
             url: string | ESJResource;
             uDis: number;
             vDis: number;
         }>;
+        /** 材质的移动速度，默认值为 1 */
         speed: number;
         stroked: boolean;
         strokeStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJStrokeStyle>;
@@ -112,6 +182,9 @@ export declare namespace ESPipeline {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义 ESPipeline 接口，继承自 UniteChanged 类型
+ */
 export interface ESPipeline extends UniteChanged<ReturnType<typeof ESPipeline.createDefaultProps>> {
 }
 //# sourceMappingURL=ESPipeline.d.ts.map

package/dist/types/ESObjects/general/ESPipeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESPipeline.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAgB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACxI,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,eAAe;IAC3C,gBAAyB,IAAI,SAA0I;IACvK,IAAa,QAAQ,WAA2B;IAChD,IAAa,YAAY;;;;;iBAOO,MAAM,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;MAPmB;IAEvE,OAAgB,QAAQ;;;;iBAKQ,MAAM,GAAG,WAAW;;;;;uBAEsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;;;;;MACxG;IACS,WAAW;;;;;SAQnB;IACF,OAAO,CAAC,sBAAsB,CAA4C;gBAC9D,EAAE,CAAC,EAAE,MAAM;IAMd,eAAe;;;;;;;;;IAgCf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAa3C;AAED,yBAAiB,UAAU,CAAC;IACjB,MAAM,kBAAkB;;;;;iBApEC,MAAM,GAAG,WAAW;;;;;;;;;;;;;;;;;;;;;;;;KA4ElD,CAAC;CACN;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESPipeline.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAgB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACxI,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,UAAW,SAAQ,eAAe;IAC3C;;OAEG;IACH,gBAAyB,IAAI,SAA0I;IAEvK;;;OAGG;IACH,IAAa,QAAQ,WAA2B;IAEhD;;;OAGG;IACH,IAAa,YAAY;QAqHrB,oBAAoB;;QAEpB,sBAAsB;;QAEtB,8BAA8B;;QAE9B,oCAAoC;;iBA9GR,MAAM,GAAG,WAAW;;;;QAgHhD,qBAAqB;;;;;;;;;;;;;;;;;;;;;MA7H8C;IAEvE;;OAEG;IACH,OAAgB,QAAQ;QAGpB,oBAAoB;;QAEpB,sBAAsB;;QAEtB,yCAAyC;;iBACb,MAAM,GAAG,WAAW;;;;QAChD,qBAAqB;;QAErB,wBAAwB;uBAC8C,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;;;;;MACxG;IAED;;OAEG;IACO,WAAW;;;;;SAQnB;IAEF;;OAEG;IACH,OAAO,CAAC,sBAAsB,CAA4C;IAE1E;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAUvB;;;OAGG;IACM,eAAe;;;;;;;;;IAiCxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAa3C;AAED,yBAAiB,UAAU,CAAC;IACxB;;;OAGG;IACI,MAAM,kBAAkB;QAG3B,oBAAoB;;QAEpB,sBAAsB;;QAEtB,8BAA8B;;QAE9B,oCAAoC;;iBA9GR,MAAM,GAAG,WAAW;;;;QAgHhD,qBAAqB;;;;;;;;;;;;;;;;;;;;;KAEvB,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESPipeserTileset.d.ts

@@ -1,12 +1,45 @@
 import { Event, UniteChanged } from "xbsj-base";
 import { ES3DTileset } from "./ES3DTileset";
 /**
- * https://www.wolai.com/earthsdk/oTfNEhFjwzUwkKHrHvSG2H
- * https://c0yh9tnn0na.feishu.cn/wiki/V8LkwTrnkij5q8kFieEcxDLMngd
+ * ESPipeserTileset 是一个专门用于处理 PipeSer 管线数据的 3D 瓦片集图层类。
+ *
+ * 该类继承自 ES3DTileset，专门用于管理和渲染管线系统的三维数据，提供了管线图层的
+ * 可见性控制、颜色设置等功能。主要用于工程管线、地下管网等场景的可视化展示。
+ *
+ * 核心功能：
+ * - 管线图层可见性控制（setLayerVisible）
+ * - 管线图层颜色设置（setLayerColor）
+ * - 支持多种颜色模式（default、color、blend）
+ * - 事件驱动的图层属性更新机制
+ *
+ * 使用示例：
+ *
+ * @param id - 可选的图层标识符，用于唯一标识该 PipeSer 图层实例
+ *
+ * 注意事项：
+ * - 该类专门用于 PipeSer 管线数据，不适用于其他类型的 3D 数据
+ * - layerJson 参数可以是 JSON 字符串或对象数组格式
+ * - 颜色模式的切换会影响整个图层的渲染效果
  */
 export declare class ESPipeserTileset extends ES3DTileset {
+    /**
+     * 注册类类型，设置中文名称、标签和描述。
+     *
+     * @readonly
+     * @type {any}
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @override
+     * @returns {string} 类型名称 'ESPipeserTileset'。
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @override
+     * @returns {any} 默认属性对象。
+     */
     get defaultProps(): {
         url: string | import("../../ESJTypes").ESJResource;
         actorTag: string;
@@ -38,6 +71,7 @@ export declare class ESPipeserTileset extends ES3DTileset {
         allowPicking: boolean;
         materialOverrideMap: import("xbsj-base").ReactiveVariable<undefined>;
         featureIdLabel: number;
+        splitDirection: import(".").ESJSplitDirectionType;
         show: boolean;
         collision: boolean;
         flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
@@ -49,29 +83,84 @@ export declare class ESPipeserTileset extends ES3DTileset {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * 颜色模式，默认为'default'。
+         * [["default", 'default'], ['color', 'color'], ['blend', 'blend']]
+         */
         colorMode: string;
     };
+    /**
+     * 颜色模式的描述信息，包含可选的颜色模式及其对应描述。
+     *
+     *  颜色模式的可选值及对应描述，格式为 [值, 描述] 数组。
+     */
     static description: {
         colorMode: [string, string][];
     };
+    /**
+     * 设置图层可见性的事件。
+     * @private
+     * @type {Event<[name: string, layerJson: string | ({ [key: string]: any }[])]>}
+     */
     private _setLayerVisibleEvent;
+    /**
+     * 获取设置图层可见性的事件。
+     * @returns {Event<[name: string, layerJson: string | ({ [key: string]: any }[])]>} 设置图层可见性的事件。
+     */
     get setLayerVisibleEvent(): Event<[name: string, layerJson: string | {
         [key: string]: any;
     }[]]>;
+    /**
+     * 触发设置图层可见性的事件。
+     * @param {string} name - 图层名称。
+     * @param {string | ({ [key: string]: any }[])} layerJson - 图层的JSON数据，可以是字符串或对象数组。
+     */
     setLayerVisible(name: string, layerJson: string | ({
         [key: string]: any;
     }[])): void;
+    /**
+     * 设置图层颜色的事件。
+     * @private
+     * @type {Event<[name: string, layerJson: string | ({ [key: string]: any }[])]>}
+     */
     private _setLayerColorEvent;
+    /**
+     * 获取设置图层颜色的事件。
+     * @returns {Event<[name: string, layerJson: string | ({ [key: string]: any }[])]>} 设置图层颜色的事件。
+     */
     get setLayerColorEvent(): Event<[name: string, layerJson: string | {
         [key: string]: any;
     }[]]>;
+    /**
+     * 触发设置图层颜色的事件。
+     * @param {string} name - 图层名称。
+     * @param {string | ({ [key: string]: any }[])} layerJson - 图层的JSON数据，可以是字符串或对象数组。
+     */
     setLayerColor(name: string, layerJson: string | ({
         [key: string]: any;
     }[])): void;
+    /**
+     * 构造函数。
+     * @param {string} [id] - 可选的ID参数。
+     */
     constructor(id?: string);
+    /**
+     * 获取属性列表。
+     * @override
+     * @param {string} [language] - 可选的语言参数。
+     * @returns {any[]} 属性列表。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * @namespace ESPipeserTileset
+ *  ESPipeserTileset类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESPipeserTileset {
+    /**
+     * 创建默认属性对象。
+     * @returns {any} 默认属性对象，包含颜色模式和父类的默认属性。
+     */
     const createDefaultProps: () => {
         url: string | import("../../ESJTypes").ESJResource;
         actorTag: string;
@@ -103,6 +192,7 @@ export declare namespace ESPipeserTileset {
         allowPicking: boolean;
         materialOverrideMap: import("xbsj-base").ReactiveVariable<undefined>;
         featureIdLabel: number;
+        splitDirection: import(".").ESJSplitDirectionType;
         show: boolean;
         collision: boolean;
         flyToParam: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJFlyToParam | undefined>;
@@ -114,9 +204,16 @@ export declare namespace ESPipeserTileset {
         execOnceFuncStr: string | undefined;
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
+        /**
+         * 颜色模式，默认为'default'。
+         * [["default", 'default'], ['color', 'color'], ['blend', 'blend']]
+         */
         colorMode: string;
     };
 }
+/**
+ *  扩展ESPipeserTileset类，使其具有UniteChanged接口的特性，返回值为createDefaultProps函数的返回类型。
+ */
 export interface ESPipeserTileset extends UniteChanged<ReturnType<typeof ESPipeserTileset.createDefaultProps>> {
 }
 //# sourceMappingURL=ESPipeserTileset.d.ts.map

package/dist/types/ESObjects/general/ESPipeserTileset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESPipeserTileset.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeserTileset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAoB,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC7C,gBAAyB,IAAI,SAAsJ;IACnL,IAAa,QAAQ,WAAiC;IACtD,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAoD;IAE7E,MAAM,CAAC,WAAW;mBACiE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;MACpG;IAED,OAAO,CAAC,qBAAqB,CAAwF;IACrH,IAAI,oBAAoB;;UAAyC;IACjE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;IAE5E,OAAO,CAAC,mBAAmB,CAAwF;IACnH,IAAI,kBAAkB;;UAAuC;IAC7D,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;gBAE9D,EAAE,CAAC,EAAE,MAAM;IAId,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAU3C;AAED,yBAAiB,gBAAgB,CAAC;IACvB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAG7B,CAAC;CACN;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESPipeserTileset.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeserTileset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAoB,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC7C;;;;;OAKG;IACH,gBAAyB,IAAI,SAAsJ;IAEnL;;;;OAIG;IACH,IAAa,QAAQ,WAAiC;IAEtD;;;;OAIG;IACH,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAuFrB;;;WAGG;;MA1FsE;IAE7E;;;;OAIG;IACH,MAAM,CAAC,WAAW;mBACiE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;MACpG;IAED;;;;OAIG;IACH,OAAO,CAAC,qBAAqB,CAAwF;IAErH;;;OAGG;IACH,IAAI,oBAAoB;;UAAyC;IAEjE;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;IAE5E;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAAwF;IAEnH;;;OAGG;IACH,IAAI,kBAAkB;;UAAuC;IAE7D;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAAE,CAAC;IAE1E;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAIvB;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAU3C;AAED;;;GAGG;AACH,yBAAiB,gBAAgB,CAAC;IAC9B;;;OAGG;IACI,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAC3B;;;WAGG;;KAGL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

package/dist/types/ESObjects/general/ESPit.d.ts

@@ -1,22 +1,82 @@
 import { UniteChanged } from "xbsj-base";
 import { BooleanProperty, ColorProperty, EnumProperty, GroupProperty, NumberProperty } from "../../ESJTypes";
 import { ESGeoPolygon } from "./ESGeoPolygon";
+/**
+ * 定义ESJTexture类型，用于描述纹理信息。
+ * @typedef {Object} ESJTexture
+ * @property {string} url - 纹理图片的URL地址。
+ * @property {number} uDis - 纹理在u方向上的距离。
+ * @property {number} vDis - 纹理在v方向上的距离。
+ */
 export type ESJTexture = {
     url: string;
     uDis: number;
     vDis: number;
 };
 /**
- * https://c0yh9tnn0na.feishu.cn/wiki/Y2jewrGzSih6ojktXqqcTG44nmb
+ * ESPit 坑对象类
+ *
+ * 这个类用于创建和管理三维场景中的坑洞对象，继承自ESGeoPolygon。
+ * 坑对象具有深度、侧面纹理、底面纹理等属性，可以模拟真实世界中的坑洞效果。
+ *
+ * 核心功能：
+ * - 创建具有深度的多边形坑洞
+ * - 支持自定义坑的深度和插值距离
+ * - 可配置侧面和底面的纹理贴图
+ * - 支持透明度和样式设置
+ * - 默认关闭碰撞检测和拾取功能
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param id - 可选的对象唯一标识符，用于在场景中识别和管理该坑对象
+ *
+ * 注意事项：
+ * - 该对象默认关闭碰撞检测和拾取功能，适用于视觉展示场景
+ * - 坑的深度和插值距离会影响渲染性能，建议根据实际需求合理设置
+ * - 纹理图片路径依赖于环境变量配置，请确保资源路径正确
  */
 export declare class ESPit extends ESGeoPolygon {
+    /**
+     * 静态属性，用于注册类的类型信息。
+     * @static
+     * @readonly
+     * @type {any}
+     */
     static readonly type: string;
+    /**
+     * 获取对象的类型名称。
+     * @override
+     * @returns {string} - 对象的类型名称。
+     */
     get typeName(): string;
+    /**
+     * 获取对象的默认属性。
+     * @override
+     * @returns {any} - 对象的默认属性。
+     */
     get defaultProps(): {
+        /**
+         * 坑深度（米） 默认10
+         */
         depth: number;
+        /**
+         * 侧面图片纹理
+         * @type {ESJTexture}
+         */
         sideImage: import("xbsj-base").ReactiveVariable<ESJTexture>;
+        /**
+         * 底面图片纹理
+         * @type {ESJTexture}
+         */
         bottomImage: import("xbsj-base").ReactiveVariable<ESJTexture>;
+        /**
+         * 透明度 默认1
+         */
         opacity: number;
+        /**
+         * 插值距离（米） 默认50
+         */
         interpolation: number;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -38,7 +98,22 @@ export declare class ESPit extends ESGeoPolygon {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 构造函数，初始化ESPit对象。
+     * @param {string} [id] - 对象的ID，可选参数。
+     */
     constructor(id?: string);
+    /**
+     * 静态属性，定义ESPit对象的默认参数。
+     * @static
+     * @override
+     * @type {Object}
+     * @property {number} depth - 坑的深度，单位为米，默认值为100。
+     * @property {ESJTexture} sideImage - 坑侧面的图片信息，包括URL和uv距离。
+     * @property {ESJTexture} bottomImage - 坑底面的图片信息，包括URL和uv距离。
+     * @property {number} opacity - 坑的透明度，默认值为1。
+     * @property {number} interpolation - 插值距离，单位为米，默认值为50。
+     */
     static defaults: {
         depth: number;
         sideImage: ESJTexture;
@@ -58,6 +133,11 @@ export declare class ESPit extends ESGeoPolygon {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 获取ES属性信息。
+     * @override
+     * @returns {Object} - ES属性信息。
+     */
     getESProperties(): {
         basic: import("../../ESJTypes").Property[];
         style: (BooleanProperty | NumberProperty | ColorProperty | GroupProperty | EnumProperty<string>)[];
@@ -67,14 +147,44 @@ export declare class ESPit extends ESGeoPolygon {
         dataSource: import("../../ESJTypes").Property[];
         location: import("../../ESJTypes").Property[];
     };
+    /**
+     * 获取对象的属性信息。
+     * @override
+     * @param {string} language - 语言信息。
+     * @returns {any[]} - 对象的属性信息数组。
+     */
     getProperties(language: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESPit类的命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESPit {
+    /**
+     * 创建ESPit对象的默认属性。
+     * @returns {Object} - ESPit对象的默认属性。
+     */
     const createDefaultProps: () => {
+        /**
+         * 坑深度（米） 默认10
+         */
         depth: number;
+        /**
+         * 侧面图片纹理
+         * @type {ESJTexture}
+         */
         sideImage: import("xbsj-base").ReactiveVariable<ESJTexture>;
+        /**
+         * 底面图片纹理
+         * @type {ESJTexture}
+         */
         bottomImage: import("xbsj-base").ReactiveVariable<ESJTexture>;
+        /**
+         * 透明度 默认1
+         */
         opacity: number;
+        /**
+         * 插值距离（米） 默认50
+         */
         interpolation: number;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -97,6 +207,9 @@ export declare namespace ESPit {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 定义ESPit类的扩展接口，继承自UniteChanged。
+ */
 export interface ESPit extends UniteChanged<ReturnType<typeof ESPit.createDefaultProps>> {
 }
 //# sourceMappingURL=ESPit.d.ts.map

package/dist/types/ESObjects/general/ESPit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ESPit.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPit.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAgB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE3H,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,MAAM,MAAM,UAAU,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAA;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACnC,gBAAyB,IAAI,SAA2H;IACxJ,IAAa,QAAQ,WAAsB;IAC3C,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;MAAyC;gBAEtD,EAAE,CAAC,EAAE,MAAM;IAUvB,OAAgB,QAAQ;;mBAGuH,UAAU;qBACN,UAAU;;;;;;;;;;;;;;;MAG5J;IAEQ,eAAe;;;;;;;;;IA+Bf,aAAa,CAAC,QAAQ,EAAE,MAAM;CAY1C;AAED,yBAAiB,KAAK,CAAC;IACZ,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;KAO7B,CAAA;CACL;AAGD,MAAM,WAAW,KAAM,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESPit.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPit.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,YAAY,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAgB,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE3H,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,KAAM,SAAQ,YAAY;IACnC;;;;;OAKG;IACH,gBAAyB,IAAI,SAA2H;IAExJ;;;;OAIG;IACH,IAAa,QAAQ,WAAsB;IAE3C;;;;OAIG;IACH,IAAa,YAAY;QAuGrB;;WAEG;;QAEH;;;WAGG;;QAEH;;;WAGG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;MA3H2D;IAElE;;;OAGG;gBACS,EAAE,CAAC,EAAE,MAAM;IAUvB;;;;;;;;;;OAUG;IACH,OAAgB,QAAQ;;mBAGuH,UAAU;qBACN,UAAU;;;;;;;;;;;;;;;MAG5J;IAED;;;;OAIG;IACM,eAAe;;;;;;;;;IAgCxB;;;;;OAKG;IACM,aAAa,CAAC,QAAQ,EAAE,MAAM;CAY1C;AAED;;GAEG;AACH,yBAAiB,KAAK,CAAC;IACnB;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;WAEG;;QAEH;;;WAGG;;QAEH;;;WAGG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;KAEL,CAAA;CACL;AAKD;;GAEG;AACH,MAAM,WAAW,KAAM,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAAI"}