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

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

@@ -1,43 +1,210 @@
-import { Player } from "../../utils";
-import { ESObjectWithLocation } from "../base";
 import { ReactivePropsToNativePropsAndChanged, SceneObjectKey } from "xbsj-base";
 import { ESJColor, ESJParticleEmitterJsonType, ESJVector2D, ESJVector3D } from "../../ESJTypes";
+import { Player } from "../../utils";
+import { ESObjectWithLocation } from "../base";
+/**
+ * ESParticleSystemPrimitive - 粒子系统基元类
+ *
+ * 这个类基于Cesium的Primitive API实现了粒子特效系统，继承自ESObjectWithLocation，
+ * 提供了完整的粒子系统功能，包括粒子的生成、运动、生命周期管理和播放控制。
+ *
+ * 核心功能：
+ * - 粒子发射和管理：支持多种发射器类型（如圆形发射器）
+ * - 播放控制：内置播放器支持播放、暂停、循环、速度控制等
+ * - 粒子属性：可配置粒子的生命周期、颜色、大小、速度等属性
+ * - 视觉效果：支持粒子的缩放、颜色变化、图像纹理等
+ * - 物理模拟：支持粒子质量、重力等物理属性
+ *
+ * 使用示例：
+ *
+ * 构造函数参数：
+ * @param id - 可选的场景对象键，用于唯一标识该粒子系统实例
+ *
+ * 注意事项：
+ * - 粒子系统的性能取决于发射率和粒子数量，建议根据设备性能调整参数
+ * - 图像资源路径需要确保可访问，默认使用烟雾纹理
+ * - 播放器的时间控制会影响粒子的生成和更新频率
+ * - 某些属性（如发射器类型）的修改可能需要重新初始化粒子系统
+ */
 export declare class ESParticleSystemPrimitive extends ESObjectWithLocation {
+    /**
+     * 注册ESParticleSystemPrimitive类，指定类型名称、中文名称、标签和描述。
+     */
     static readonly type: string;
+    /**
+     * 获取类型名称。
+     * @returns 类型名称 'ESParticleSystemPrimitive'。
+     */
     get typeName(): string;
+    /**
+     * 获取默认属性。
+     * @returns 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 粒子发射器配置（JSON 格式）
+         * @type {ESJParticleEmitterJsonType | undefined}
+         */
         emitter: import("xbsj-base").ReactiveVariable<ESJParticleEmitterJsonType | undefined>;
+        /**
+         * 粒子爆发配置数组（每个元素为 [时间, 最小数量, 最大数量]）
+         * @type {[time?: number, minimum?: number, maximum?: number] | undefined}
+         */
         bursts: import("xbsj-base").ReactiveVariable<[time?: number | undefined, minimum?: number | undefined, maximum?: number | undefined][] | undefined>;
+        /**
+         * 三维空间偏移量（x, y, z）
+         * @type {ESJVector3D | undefined}
+         */
         translation: import("xbsj-base").ReactiveVariable<ESJVector3D | undefined>;
+        /**
+         * 是否启用位置编辑模式
+         * @type {boolean | undefined}
+         */
         positionEditing: boolean | undefined;
+        /**
+         * 粒子贴图地址（URI 或字符串）
+         * @type {string | undefined}
+         */
         image: string | undefined;
+        /**
+         * 粒子图片尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         imageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子图片最小尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         minimumImageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子图片最大尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         maximumImageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子更新回调函数字符串（每帧执行）
+         * @type {string | undefined}
+         */
         updateCallback: string | undefined;
+        /**
+         * 粒子发射率（每秒发射数量）
+         * @type {number | undefined}
+         */
         emissionRate: number | undefined;
+        /**
+         * 是否循环播放粒子系统
+         * @type {boolean | undefined}
+         */
         loop: boolean | undefined;
+        /**
+         * 粒子整体缩放等级
+         * @type {number | undefined}
+         */
         particleScale: number | undefined;
+        /**
+         * 粒子初始缩放等级（生命周期开始时）
+         * @type {number | undefined}
+         */
         startScale: number | undefined;
+        /**
+         * 粒子结束缩放等级（生命周期结束时）
+         * @type {number | undefined}
+         */
         endScale: number | undefined;
+        /**
+         * 粒子生命周期内的颜色（RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         color: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 粒子初始颜色（生命周期开始时的 RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         startColor: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 粒子结束颜色（生命周期结束时的 RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         endColor: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 尺寸单位是否为米（`true` 为米，`false` 为像素）
+         * @type {boolean | undefined}
+         */
         sizeInMeters: boolean | undefined;
+        /**
+         * 粒子速度（覆盖最小/最大速度，单位：米/秒）
+         * @type {number | undefined}
+         */
         speed: number | undefined;
+        /**
+         * 粒子最小速度（随机速度范围下限，单位：米/秒）
+         * @type {number | undefined}
+         */
         minimumSpeed: number | undefined;
+        /**
+         * 粒子最大速度（随机速度范围上限，单位：米/秒）
+         * @type {number | undefined}
+         */
         maximumSpeed: number | undefined;
+        /**
+         * 粒子系统生命周期（总发射时间，单位：秒）
+         * @type {number | undefined}
+         */
         lifetime: number | undefined;
+        /**
+         * 粒子生命周期（固定值，覆盖最小/最大生命周期，单位：秒）
+         * @type {number | undefined}
+         */
         particleLife: number | undefined;
+        /**
+         * 粒子最小生命周期（随机生命周期范围下限，单位：秒）
+         * @type {number | undefined}
+         */
         minimumParticleLife: number | undefined;
+        /**
+         * 粒子最大生命周期（随机生命周期范围上限，单位：秒）
+         * @type {number | undefined}
+         */
         maximumParticleLife: number | undefined;
+        /**
+         * 粒子质量（固定值，覆盖最小/最大质量，单位：千克）
+         * @type {number | undefined}
+         */
         mass: number | undefined;
+        /**
+         * 粒子最小质量（随机质量范围下限，单位：千克）
+         * @type {number | undefined}
+         */
         minimumMass: number | undefined;
+        /**
+         * 粒子最大质量（随机质量范围上限，单位：千克）
+         * @type {number | undefined}
+         */
         maximumMass: number | undefined;
+        /**
+         * 播放器是否循环播放
+         * @type {boolean | undefined}
+         */
         playingLoop: boolean | undefined;
+        /**
+         * 播放器当前时间（单位：毫秒）
+         * @type {number | undefined}
+         */
         currentTime: number | undefined;
+        /**
+         * 播放器过渡时间（动画切换时长，单位：毫秒）
+         * @type {number | undefined}
+         */
         duration: number | undefined;
+        /**
+         * 播放器播放速度（1 为正常速度）
+         * @type {number | undefined}
+         */
         playingSpeed: number | undefined;
+        /**
+         * 播放器是否正在播放
+         * @type {boolean | undefined}
+         */
         playing: boolean | undefined;
         position: import("xbsj-base").ReactiveVariable<ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
@@ -57,12 +224,38 @@ export declare class ESParticleSystemPrimitive extends ESObjectWithLocation {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 播放器实例。
+     */
     private _player;
+    /**
+     * 获取播放器实例。
+     * @returns 播放器实例。
+     */
     get player(): Player;
+    /**
+     * 获取播放比率。
+     * @returns 播放比率。
+     */
     get ratio(): number;
+    /**
+     * 设置播放比率。
+     * @param value - 要设置的播放比率。
+     */
     set ratio(value: number);
+    /**
+     * 获取播放比率改变事件。
+     * @returns 播放比率改变事件。
+     */
     get ratioChanged(): import("xbsj-base").Listener<[number, number]>;
+    /**
+     * 构造函数，初始化ESParticleSystemPrimitive实例。
+     * @param id - 场景对象的键，可选参数。
+     */
     constructor(id?: SceneObjectKey);
+    /**
+     * 默认属性值。
+     */
     static defaults: {
         playingLoop: boolean;
         currentTime: number;
@@ -82,42 +275,186 @@ export declare class ESParticleSystemPrimitive extends ESObjectWithLocation {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 获取粒子系统的属性列表。
+     * @param language - 语言，可选参数。
+     * @returns 属性列表。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
+/**
+ * ESParticleSystemPrimitive命名空间，包含创建默认属性的方法。
+ */
 export declare namespace ESParticleSystemPrimitive {
+    /**
+     * 创建默认属性对象。
+     * @returns 默认属性对象。
+     */
     const createDefaultProps: () => {
+        /**
+         * 粒子发射器配置（JSON 格式）
+         * @type {ESJParticleEmitterJsonType | undefined}
+         */
         emitter: import("xbsj-base").ReactiveVariable<ESJParticleEmitterJsonType | undefined>;
+        /**
+         * 粒子爆发配置数组（每个元素为 [时间, 最小数量, 最大数量]）
+         * @type {[time?: number, minimum?: number, maximum?: number] | undefined}
+         */
         bursts: import("xbsj-base").ReactiveVariable<[time?: number | undefined, minimum?: number | undefined, maximum?: number | undefined][] | undefined>;
+        /**
+         * 三维空间偏移量（x, y, z）
+         * @type {ESJVector3D | undefined}
+         */
         translation: import("xbsj-base").ReactiveVariable<ESJVector3D | undefined>;
+        /**
+         * 是否启用位置编辑模式
+         * @type {boolean | undefined}
+         */
         positionEditing: boolean | undefined;
+        /**
+         * 粒子贴图地址（URI 或字符串）
+         * @type {string | undefined}
+         */
         image: string | undefined;
+        /**
+         * 粒子图片尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         imageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子图片最小尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         minimumImageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子图片最大尺寸（宽, 高）
+         * @type {ESJVector2D}
+         */
         maximumImageSize: import("xbsj-base").ReactiveVariable<ESJVector2D | undefined>;
+        /**
+         * 粒子更新回调函数字符串（每帧执行）
+         * @type {string | undefined}
+         */
         updateCallback: string | undefined;
+        /**
+         * 粒子发射率（每秒发射数量）
+         * @type {number | undefined}
+         */
         emissionRate: number | undefined;
+        /**
+         * 是否循环播放粒子系统
+         * @type {boolean | undefined}
+         */
         loop: boolean | undefined;
+        /**
+         * 粒子整体缩放等级
+         * @type {number | undefined}
+         */
         particleScale: number | undefined;
+        /**
+         * 粒子初始缩放等级（生命周期开始时）
+         * @type {number | undefined}
+         */
         startScale: number | undefined;
+        /**
+         * 粒子结束缩放等级（生命周期结束时）
+         * @type {number | undefined}
+         */
         endScale: number | undefined;
+        /**
+         * 粒子生命周期内的颜色（RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         color: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 粒子初始颜色（生命周期开始时的 RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         startColor: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 粒子结束颜色（生命周期结束时的 RGBA 格式）
+         * @type {ESJColor | undefined}
+         */
         endColor: import("xbsj-base").ReactiveVariable<ESJColor | undefined>;
+        /**
+         * 尺寸单位是否为米（`true` 为米，`false` 为像素）
+         * @type {boolean | undefined}
+         */
         sizeInMeters: boolean | undefined;
+        /**
+         * 粒子速度（覆盖最小/最大速度，单位：米/秒）
+         * @type {number | undefined}
+         */
         speed: number | undefined;
+        /**
+         * 粒子最小速度（随机速度范围下限，单位：米/秒）
+         * @type {number | undefined}
+         */
         minimumSpeed: number | undefined;
+        /**
+         * 粒子最大速度（随机速度范围上限，单位：米/秒）
+         * @type {number | undefined}
+         */
         maximumSpeed: number | undefined;
+        /**
+         * 粒子系统生命周期（总发射时间，单位：秒）
+         * @type {number | undefined}
+         */
         lifetime: number | undefined;
+        /**
+         * 粒子生命周期（固定值，覆盖最小/最大生命周期，单位：秒）
+         * @type {number | undefined}
+         */
         particleLife: number | undefined;
+        /**
+         * 粒子最小生命周期（随机生命周期范围下限，单位：秒）
+         * @type {number | undefined}
+         */
         minimumParticleLife: number | undefined;
+        /**
+         * 粒子最大生命周期（随机生命周期范围上限，单位：秒）
+         * @type {number | undefined}
+         */
         maximumParticleLife: number | undefined;
+        /**
+         * 粒子质量（固定值，覆盖最小/最大质量，单位：千克）
+         * @type {number | undefined}
+         */
         mass: number | undefined;
+        /**
+         * 粒子最小质量（随机质量范围下限，单位：千克）
+         * @type {number | undefined}
+         */
         minimumMass: number | undefined;
+        /**
+         * 粒子最大质量（随机质量范围上限，单位：千克）
+         * @type {number | undefined}
+         */
         maximumMass: number | undefined;
+        /**
+         * 播放器是否循环播放
+         * @type {boolean | undefined}
+         */
         playingLoop: boolean | undefined;
+        /**
+         * 播放器当前时间（单位：毫秒）
+         * @type {number | undefined}
+         */
         currentTime: number | undefined;
+        /**
+         * 播放器过渡时间（动画切换时长，单位：毫秒）
+         * @type {number | undefined}
+         */
         duration: number | undefined;
+        /**
+         * 播放器播放速度（1 为正常速度）
+         * @type {number | undefined}
+         */
         playingSpeed: number | undefined;
+        /**
+         * 播放器是否正在播放
+         * @type {boolean | undefined}
+         */
         playing: boolean | undefined;
         position: import("xbsj-base").ReactiveVariable<ESJVector3D>;
         rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
@@ -138,6 +475,9 @@ export declare namespace ESParticleSystemPrimitive {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * ESParticleSystemPrimitive接口，继承自ReactivePropsToNativePropsAndChanged。
+ */
 export interface ESParticleSystemPrimitive extends ReactivePropsToNativePropsAndChanged<ReturnType<typeof ESParticleSystemPrimitive.createDefaultProps>> {
 }
 //# sourceMappingURL=ESParticleSystemPrimitive.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESParticleSystemPrimitive.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESParticleSystemPrimitive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAsF,oCAAoC,EAA0B,cAAc,EAAE,MAAM,WAAW,CAAC;AAC7L,OAAO,EAAkC,QAAQ,EAAE,0BAA0B,EAAE,WAAW,EAAE,WAAW,EAAsK,MAAM,gBAAgB,CAAC;AAEpS,qBAAa,yBAA0B,SAAQ,oBAAoB;IAC/D,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA8K;IAClM,IAAI,QAAQ,WAA0C;IACtD,IAAa,YAAY;;;;yBAsGS,OAAO,GAAG,SAAS;eAC7B,MAAM,GAAG,SAAS;;;;wBAKT,MAAM,GAAG,SAAS;sBACpB,MAAM,GAAG,SAAS;cAC1B,OAAO,GAAG,SAAS;uBACV,MAAM,GAAG,SAAS;oBACrB,MAAM,GAAG,SAAS;kBACpB,MAAM,GAAG,SAAS;;;;sBAId,OAAO,GAAG,SAAS;eAC1B,MAAM,GAAG,SAAS;sBACX,MAAM,GAAG,SAAS;sBAClB,MAAM,GAAG,SAAS;kBACtB,MAAM,GAAG,SAAS;sBACd,MAAM,GAAG,SAAS;6BACX,MAAM,GAAG,SAAS;6BAClB,MAAM,GAAG,SAAS;cACjC,MAAM,GAAG,SAAS;qBACX,MAAM,GAAG,SAAS;qBAClB,MAAM,GAAG,SAAS;qBAElB,OAAO,GAAG,SAAS;qBACnB,MAAM,GAAG,SAAS;kBACrB,MAAM,GAAG,SAAS;sBACd,MAAM,GAAG,SAAS;iBACvB,OAAO,GAAG,SAAS;;;;;;;;;;;;;;;;;;MArIyC;IAEtF,OAAO,CAAC,OAAO,CAAyB;IACxC,IAAI,MAAM,WAA2B;IAErC,IAAI,KAAK,IACQ,MAAM,CADmB;IAC1C,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAAiC;IACxD,IAAI,YAAY,mDAAwC;gBAE5C,EAAE,CAAC,EAAE,cAAc;IAa/B,OAAgB,QAAQ;;;;;;;;;;mBAaG,WAAW;;iBAK7B,0BAA0B;;;;;;MAClC;IAEQ,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAiD3C;AAED,yBAAiB,yBAAyB,CAAC;IAChC,MAAM,kBAAkB;;;;yBAOG,OAAO,GAAG,SAAS;eAC7B,MAAM,GAAG,SAAS;;;;wBAKT,MAAM,GAAG,SAAS;sBACpB,MAAM,GAAG,SAAS;cAC1B,OAAO,GAAG,SAAS;uBACV,MAAM,GAAG,SAAS;oBACrB,MAAM,GAAG,SAAS;kBACpB,MAAM,GAAG,SAAS;;;;sBAId,OAAO,GAAG,SAAS;eAC1B,MAAM,GAAG,SAAS;sBACX,MAAM,GAAG,SAAS;sBAClB,MAAM,GAAG,SAAS;kBACtB,MAAM,GAAG,SAAS;sBACd,MAAM,GAAG,SAAS;6BACX,MAAM,GAAG,SAAS;6BAClB,MAAM,GAAG,SAAS;cACjC,MAAM,GAAG,SAAS;qBACX,MAAM,GAAG,SAAS;qBAClB,MAAM,GAAG,SAAS;qBAElB,OAAO,GAAG,SAAS;qBACnB,MAAM,GAAG,SAAS;kBACrB,MAAM,GAAG,SAAS;sBACd,MAAM,GAAG,SAAS;iBACvB,OAAO,GAAG,SAAS;;;;;;;;;;;;;;;;;;KAC3C,CAAC;CACN;AAED,MAAM,WAAW,yBAA0B,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESParticleSystemPrimitive.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESParticleSystemPrimitive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsF,oCAAoC,EAA0B,cAAc,EAAE,MAAM,WAAW,CAAC;AAC7L,OAAO,EAAkC,QAAQ,EAAE,0BAA0B,EAAE,WAAW,EAAE,WAAW,EAAsK,MAAM,gBAAgB,CAAC;AACpS,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,yBAA0B,SAAQ,oBAAoB;IAC/D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA8K;IAElM;;;OAGG;IACH,IAAI,QAAQ,WAA0C;IAEtD;;;OAGG;IACH,IAAa,YAAY;QA4IrB;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;yBAC2B,OAAO,GAAG,SAAS;QAEjD;;;WAGG;eACiB,MAAM,GAAG,SAAS;QAEtC;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;wBAC0B,MAAM,GAAG,SAAS;QAE/C;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;cACgB,OAAO,GAAG,SAAS;QAEtC;;;WAGG;uBACyB,MAAM,GAAG,SAAS;QAE9C;;;WAGG;oBACsB,MAAM,GAAG,SAAS;QAE3C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;sBACwB,OAAO,GAAG,SAAS;QAE9C;;;WAGG;eACiB,MAAM,GAAG,SAAS;QAEtC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;6BAC+B,MAAM,GAAG,SAAS;QAEpD;;;WAGG;6BAC+B,MAAM,GAAG,SAAS;QAEpD;;;WAGG;cACgB,MAAM,GAAG,SAAS;QAErC;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;qBACuB,OAAO,GAAG,SAAS;QAE7C;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;iBACmB,OAAO,GAAG,SAAS;;;;;;;;;;;;;;;;;;MAhVyC;IAEtF;;OAEG;IACH,OAAO,CAAC,OAAO,CAAyB;IAExC;;;OAGG;IACH,IAAI,MAAM,WAA2B;IAErC;;;OAGG;IACH,IAAI,KAAK,IAMQ,MAAM,CANmB;IAE1C;;;OAGG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAAiC;IAExD;;;OAGG;IACH,IAAI,YAAY,mDAAwC;IAExD;;;OAGG;gBACS,EAAE,CAAC,EAAE,cAAc;IAc/B;;OAEG;IACH,OAAgB,QAAQ;;;;;;;;;;mBAaG,WAAW;;iBAK7B,0BAA0B;;;;;;MAClC;IAED;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAiD3C;AAED;;GAEG;AACH,yBAAiB,yBAAyB,CAAC;IACvC;;;OAGG;IACI,MAAM,kBAAkB;QAG3B;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;yBAC2B,OAAO,GAAG,SAAS;QAEjD;;;WAGG;eACiB,MAAM,GAAG,SAAS;QAEtC;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;wBAC0B,MAAM,GAAG,SAAS;QAE/C;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;cACgB,OAAO,GAAG,SAAS;QAEtC;;;WAGG;uBACyB,MAAM,GAAG,SAAS;QAE9C;;;WAGG;oBACsB,MAAM,GAAG,SAAS;QAE3C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;;QAGH;;;WAGG;sBACwB,OAAO,GAAG,SAAS;QAE9C;;;WAGG;eACiB,MAAM,GAAG,SAAS;QAEtC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;6BAC+B,MAAM,GAAG,SAAS;QAEpD;;;WAGG;6BAC+B,MAAM,GAAG,SAAS;QAEpD;;;WAGG;cACgB,MAAM,GAAG,SAAS;QAErC;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;qBACuB,OAAO,GAAG,SAAS;QAE7C;;;WAGG;qBACuB,MAAM,GAAG,SAAS;QAE5C;;;WAGG;kBACoB,MAAM,GAAG,SAAS;QAEzC;;;WAGG;sBACwB,MAAM,GAAG,SAAS;QAE7C;;;WAGG;iBACmB,OAAO,GAAG,SAAS;;;;;;;;;;;;;;;;;;KAC3C,CAAC;CACN;AAKD;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oCAAoC,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC,CAAC;CAAI"}

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

@@ -2,15 +2,58 @@ import { UniteChanged } from "xbsj-base";
 import { ESJEditingBindModeType, ESJFillStyle, ESJStrokeStyle } from "../../ESJTypes";
 import { ESGeoVector } from "../base";
 /**
- * https://www.wolai.com/earthsdk/KumomxD1tKHbq242aFVwz
+ * 管道电子围栏类
+ *
+ * ESPipeFence 是一个用于创建和管理管道电子围栏的地理矢量对象类，继承自 ESGeoVector。
+ * 该类主要用于在地图或三维场景中绘制和管理管道状的电子围栏，具有可视化显示、编辑和属性配置功能。
+ *
+ * 核心功能：
+ * - 支持线串的追加和插入编辑模式
+ * - 自动计算和追踪管道的总长度距离
+ * - 提供丰富的样式配置选项（描边、填充、材质等）
+ * - 支持多种材质模式（单箭头、多箭头）
+ * - 响应式的距离计算和更新
+ *
+ * 使用示例：
+ *
+ * @param id 可选参数，围栏对象的唯一标识符，用于区分不同的围栏实例
+ *
+ * 注意事项：
+ * - 需要至少2个点才能计算距离
+ * - 部分旧版本的属性（如某些materialMode值）已被弃用，使用时会触发警告
+ * - 该类支持 Cesium 和 UE 平台的实现
  */
 export declare class ESPipeFence extends ESGeoVector {
+    /**
+     * 静态属性，用于注册类类型，包含类名、中文名称、标签和描述信息。
+     */
     static readonly type: string;
+    /**
+     * 获取类的类型名称。
+     * @returns 类的类型名称，固定为 'ESPipeFence'。
+     */
     get typeName(): string;
+    /**
+     * 重写方法，获取默认属性。
+     * @returns 默认属性对象。
+     */
     get defaultProps(): {
+        /**
+         * 围栏的高度。默认10
+         */
         height: number;
+        /**
+         * 围栏的宽度。默认10
+         */
         width: number;
+        /**
+         * 围栏的材质模式。默认'singleArrow'
+         * 可选值：'singleArrow' | 'multipleArrows'
+         */
         materialMode: string;
+        /**
+         * 围栏是否填充。默认true
+         */
         filled: boolean;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -31,11 +74,31 @@ export declare class ESPipeFence extends ESGeoVector {
         updateFuncStr: string | undefined;
         toDestroyFuncStr: string | undefined;
     };
+    /**
+     * 静态属性，重写支持的编辑模式，包含 ESGeoVector 的编辑模式以及新增的线串追加和插入模式。
+     */
     static supportEditingModes: string[];
+    /**
+     * 重写的编辑绑定模式，固定为 'lineString'。
+     */
     editingBindMode: ESJEditingBindModeType;
+    /**
+     * 私有属性，存储围栏的距离值，使用 react 进行响应式处理。
+     */
     private _distance;
+    /**
+     * 获取围栏的距离值。
+     * @returns 围栏的距离值。
+     */
     get distance(): number;
+    /**
+     * 获取距离值变化的响应式对象。
+     * @returns 距离值变化的响应式对象。
+     */
     get distanceChanged(): import("xbsj-base").Listener<[number, number]>;
+    /**
+     * 静态属性，重写默认值，包含笔画样式、填充样式、填充和笔画标志以及材质模式等信息。
+     */
     static defaults: {
         strokeStyle: ESJStrokeStyle;
         fillStyle: ESJFillStyle;
@@ -51,14 +114,28 @@ export declare class ESPipeFence extends ESGeoVector {
         flyToParam: import("../../ESJTypes").ESJFlyToParam;
         flyInParam: import("../../ESJTypes").ESJFlyInParam;
     };
+    /**
+     * 重写的已弃用属性列表，包含一些旧的材质模式映射和 'show' 属性。
+     */
     _deprecated: (string | {
         materialMode: {
             blue: string;
             purple: string;
         };
     })[];
+    /**
+     * 私有属性，用于触发已弃用属性的警告信息。
+     */
     private _deprecatedWarningFunc;
+    /**
+     * 构造函数，初始化围栏对象。
+     * @param id 可选参数，围栏对象的唯一标识符。
+     */
     constructor(id?: string);
+    /**
+     * 重写方法，获取 ES 属性。
+     * @returns ES 属性对象，包含默认菜单、基本属性和坐标属性等信息。
+     */
     getESProperties(): {
         defaultMenu: string;
         basic: import("../../ESJTypes").Property[];
@@ -68,13 +145,35 @@ export declare class ESPipeFence extends ESGeoVector {
         dataSource: import("../../ESJTypes").Property[];
         location: import("../../ESJTypes").Property[];
     };
+    /**
+     * 重写方法，获取属性列表。
+     * @param language 可选参数，语言类型。
+     * @returns 属性列表，包含父类的属性和 ESPipeFence 特有的属性组。
+     */
     getProperties(language?: string): import("../../ESJTypes").Property[];
 }
 export declare namespace ESPipeFence {
+    /**
+     * 创建默认属性对象的静态方法。
+     * @returns 默认属性对象，包含高度、宽度、材质模式和填充标志等信息。
+     */
     const createDefaultProps: () => {
+        /**
+         * 围栏的高度。默认10
+         */
         height: number;
+        /**
+         * 围栏的宽度。默认10
+         */
         width: number;
+        /**
+         * 围栏的材质模式。默认'singleArrow'
+         * 可选值：'singleArrow' | 'multipleArrows'
+         */
         materialMode: string;
+        /**
+         * 围栏是否填充。默认true
+         */
         filled: boolean;
         pointed: boolean;
         pointStyle: import("xbsj-base").ReactiveVariable<import("../../ESJTypes").ESJPointStyle>;
@@ -96,6 +195,9 @@ export declare namespace ESPipeFence {
         toDestroyFuncStr: string | undefined;
     };
 }
+/**
+ * 接口定义，用于联合变更类型，确保类实例与默认属性的变更类型一致。
+ */
 export interface ESPipeFence extends UniteChanged<ReturnType<typeof ESPipeFence.createDefaultProps>> {
 }
 //# sourceMappingURL=ESPipeFence.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ESPipeFence.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeFence.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAgB,sBAAsB,EAAkB,YAAY,EAAE,cAAc,EAAiC,MAAM,gBAAgB,CAAC;AACnJ,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IACxC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA2I;IAC/J,IAAI,QAAQ,WAA4B;IACxC,IAAa,YAAY;;;;;;;;;;;;;;;;;;;;;;;MAA+C;IACxE,OAAgB,mBAAmB,WAIjC;IACO,eAAe,EAAE,sBAAsB,CAAgB;IAChE,OAAO,CAAC,SAAS,CAAqB;IACtC,IAAI,QAAQ,WAAmC;IAC/C,IAAI,eAAe,mDAAqC;IACxD,OAAgB,QAAQ;qBAQf,cAAc;mBAKd,YAAY;;;uBAGqD,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE;;;;;;;;;MACxG;IACS,WAAW;;;;;SAQnB;IACF,OAAO,CAAC,sBAAsB,CAA4C;gBAC9D,EAAE,CAAC,EAAE,MAAM;IAed,eAAe;;;;;;;;;IAiBf,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAW3C;AAED,yBAAiB,WAAW,CAAC;IAClB,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;KAM7B,CAAC;CACN;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}
+{"version":3,"file":"ESPipeFence.d.ts","sourceRoot":"","sources":["../../../../src/ESObjects/general/ESPipeFence.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,YAAY,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,EAAgB,sBAAsB,EAAkB,YAAY,EAAE,cAAc,EAAiC,MAAM,gBAAgB,CAAC;AAEnJ,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,WAAY,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,SAA2I;IAE/J;;;OAGG;IACH,IAAI,QAAQ,WAA4B;IAExC;;;OAGG;IACH,IAAa,YAAY;QA4IrB;;WAEG;;QAEH;;WAEG;;QAEH;;;WAGG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;MA3JiE;IAExE;;OAEG;IACH,OAAgB,mBAAmB,WAIjC;IAEF;;OAEG;IACM,eAAe,EAAE,sBAAsB,CAAgB;IAEhE;;OAEG;IACH,OAAO,CAAC,SAAS,CAAqB;IAEtC;;;OAGG;IACH,IAAI,QAAQ,WAAmC;IAE/C;;;OAGG;IACH,IAAI,eAAe,mDAAqC;IAExD;;OAEG;IACH,OAAgB,QAAQ;qBAQf,cAAc;mBAKd,YAAY;;;uBAGqD,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;IAgBvB;;;OAGG;IACM,eAAe;;;;;;;;;IAkBxB;;;;OAIG;IACM,aAAa,CAAC,QAAQ,CAAC,EAAE,MAAM;CAW3C;AAED,yBAAiB,WAAW,CAAC;IACzB;;;OAGG;IACI,MAAM,kBAAkB;QAE3B;;WAEG;;QAEH;;WAEG;;QAEH;;;WAGG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;KAEL,CAAC;CACN;AAOD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,kBAAkB,CAAC,CAAC;CAAI"}