earthsdk3 3.0.7-beta.9 → 3.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/README.md +20 -0
  2. package/dist/earthsdk3.iife.js +38 -43
  3. package/dist/earthsdk3.js +5937 -2623
  4. package/dist/earthsdk3.umd.cjs +34 -39
  5. package/dist/types/ESJTypes/pickedInfos/index.d.ts +13 -49
  6. package/dist/types/ESJTypes/pickedInfos/index.d.ts.map +1 -1
  7. package/dist/types/ESObjectManager/index.d.ts +19 -2
  8. package/dist/types/ESObjectManager/index.d.ts.map +1 -1
  9. package/dist/types/ESObjects/base/ESGeoVector.d.ts +18 -2
  10. package/dist/types/ESObjects/base/ESGeoVector.d.ts.map +1 -1
  11. package/dist/types/ESObjects/base/ESLabel.d.ts +18 -1
  12. package/dist/types/ESObjects/base/ESLabel.d.ts.map +1 -1
  13. package/dist/types/ESObjects/base/ESLocalVector.d.ts +18 -4
  14. package/dist/types/ESObjects/base/ESLocalVector.d.ts.map +1 -1
  15. package/dist/types/ESObjects/base/ESLocalVector2D.d.ts +15 -2
  16. package/dist/types/ESObjects/base/ESLocalVector2D.d.ts.map +1 -1
  17. package/dist/types/ESObjects/base/ESObjectWithLocation.d.ts +19 -2
  18. package/dist/types/ESObjects/base/ESObjectWithLocation.d.ts.map +1 -1
  19. package/dist/types/ESObjects/base/ESSceneObject/index.d.ts +18 -1
  20. package/dist/types/ESObjects/base/ESSceneObject/index.d.ts.map +1 -1
  21. package/dist/types/ESObjects/base/ESVisualObject.d.ts +22 -6
  22. package/dist/types/ESObjects/base/ESVisualObject.d.ts.map +1 -1
  23. package/dist/types/ESObjects/general/ES3DTileset/index.d.ts +488 -49
  24. package/dist/types/ESObjects/general/ES3DTileset/index.d.ts.map +1 -1
  25. package/dist/types/ESObjects/general/ES3DTileset/type.d.ts +103 -0
  26. package/dist/types/ESObjects/general/ES3DTileset/type.d.ts.map +1 -1
  27. package/dist/types/ESObjects/general/ESAlarm.d.ts +76 -1
  28. package/dist/types/ESObjects/general/ESAlarm.d.ts.map +1 -1
  29. package/dist/types/ESObjects/general/ESApertureEffect.d.ts +65 -1
  30. package/dist/types/ESObjects/general/ESApertureEffect.d.ts.map +1 -1
  31. package/dist/types/ESObjects/general/ESAreaMeasurement.d.ts +66 -1
  32. package/dist/types/ESObjects/general/ESAreaMeasurement.d.ts.map +1 -1
  33. package/dist/types/ESObjects/general/ESBlastParticleSystem.d.ts +72 -0
  34. package/dist/types/ESObjects/general/ESBlastParticleSystem.d.ts.map +1 -1
  35. package/dist/types/ESObjects/general/ESBoxClipping.d.ts +66 -3
  36. package/dist/types/ESObjects/general/ESBoxClipping.d.ts.map +1 -1
  37. package/dist/types/ESObjects/general/ESCameraView.d.ts +117 -8
  38. package/dist/types/ESObjects/general/ESCameraView.d.ts.map +1 -1
  39. package/dist/types/ESObjects/general/ESCameraViewCollection/ViewWrapper.d.ts +29 -0
  40. package/dist/types/ESObjects/general/ESCameraViewCollection/ViewWrapper.d.ts.map +1 -1
  41. package/dist/types/ESObjects/general/ESCameraViewCollection/index.d.ts +168 -50
  42. package/dist/types/ESObjects/general/ESCameraViewCollection/index.d.ts.map +1 -1
  43. package/dist/types/ESObjects/general/ESCameraVisibleRange.d.ts +86 -1
  44. package/dist/types/ESObjects/general/ESCameraVisibleRange.d.ts.map +1 -1
  45. package/dist/types/ESObjects/general/ESCar.d.ts +69 -1
  46. package/dist/types/ESObjects/general/ESCar.d.ts.map +1 -1
  47. package/dist/types/ESObjects/general/ESCityBasePoint.d.ts +73 -3
  48. package/dist/types/ESObjects/general/ESCityBasePoint.d.ts.map +1 -1
  49. package/dist/types/ESObjects/general/ESClassification.d.ts +77 -0
  50. package/dist/types/ESObjects/general/ESClassification.d.ts.map +1 -1
  51. package/dist/types/ESObjects/general/ESClippingPlane.d.ts +101 -1
  52. package/dist/types/ESObjects/general/ESClippingPlane.d.ts.map +1 -1
  53. package/dist/types/ESObjects/general/ESCustomDiv/index.d.ts +132 -0
  54. package/dist/types/ESObjects/general/ESCustomDiv/index.d.ts.map +1 -1
  55. package/dist/types/ESObjects/general/ESCustomDiv/instance.d.ts +29 -0
  56. package/dist/types/ESObjects/general/ESCustomDiv/instance.d.ts.map +1 -1
  57. package/dist/types/ESObjects/general/ESCzml.d.ts +102 -0
  58. package/dist/types/ESObjects/general/ESCzml.d.ts.map +1 -1
  59. package/dist/types/ESObjects/general/ESDataMesh.d.ts +115 -0
  60. package/dist/types/ESObjects/general/ESDataMesh.d.ts.map +1 -1
  61. package/dist/types/ESObjects/general/ESDatasmithRuntimeModel.d.ts +86 -0
  62. package/dist/types/ESObjects/general/ESDatasmithRuntimeModel.d.ts.map +1 -1
  63. package/dist/types/ESObjects/general/ESDirectionMeasurement.d.ts +64 -1
  64. package/dist/types/ESObjects/general/ESDirectionMeasurement.d.ts.map +1 -1
  65. package/dist/types/ESObjects/general/ESDistanceMeasurement.d.ts +65 -1
  66. package/dist/types/ESObjects/general/ESDistanceMeasurement.d.ts.map +1 -1
  67. package/dist/types/ESObjects/general/ESDynamicWater.d.ts +84 -3
  68. package/dist/types/ESObjects/general/ESDynamicWater.d.ts.map +1 -1
  69. package/dist/types/ESObjects/general/ESEntityCluster.d.ts +134 -4
  70. package/dist/types/ESObjects/general/ESEntityCluster.d.ts.map +1 -1
  71. package/dist/types/ESObjects/general/ESExcavate.d.ts +59 -2
  72. package/dist/types/ESObjects/general/ESExcavate.d.ts.map +1 -1
  73. package/dist/types/ESObjects/general/ESFireParticleSystem.d.ts +66 -0
  74. package/dist/types/ESObjects/general/ESFireParticleSystem.d.ts.map +1 -1
  75. package/dist/types/ESObjects/general/ESForestTileset.d.ts +95 -0
  76. package/dist/types/ESObjects/general/ESForestTileset.d.ts.map +1 -1
  77. package/dist/types/ESObjects/general/ESGaussianSplatting.d.ts +74 -1
  78. package/dist/types/ESObjects/general/ESGaussianSplatting.d.ts.map +1 -1
  79. package/dist/types/ESObjects/general/ESGeoDiv/index.d.ts +117 -2
  80. package/dist/types/ESObjects/general/ESGeoDiv/index.d.ts.map +1 -1
  81. package/dist/types/ESObjects/general/ESGeoDivTextPoi.d.ts +158 -16
  82. package/dist/types/ESObjects/general/ESGeoDivTextPoi.d.ts.map +1 -1
  83. package/dist/types/ESObjects/general/ESGeoJson/index.d.ts +508 -3
  84. package/dist/types/ESObjects/general/ESGeoJson/index.d.ts.map +1 -1
  85. package/dist/types/ESObjects/general/ESGeoJson/type.d.ts +65 -0
  86. package/dist/types/ESObjects/general/ESGeoJson/type.d.ts.map +1 -1
  87. package/dist/types/ESObjects/general/ESImageryLayer/index.d.ts +112 -4
  88. package/dist/types/ESObjects/general/ESImageryLayer/index.d.ts.map +1 -1
  89. package/dist/types/ESObjects/general/ESImageryLayer/types.d.ts +280 -0
  90. package/dist/types/ESObjects/general/ESImageryLayer/types.d.ts.map +1 -1
  91. package/dist/types/ESObjects/general/ESMsTileset/index.d.ts +132 -30
  92. package/dist/types/ESObjects/general/ESMsTileset/index.d.ts.map +1 -1
  93. package/dist/types/ESObjects/general/ESPath/ESPathImpl/CurrentInfoType.d.ts +21 -0
  94. package/dist/types/ESObjects/general/ESPath/ESPathImpl/CurrentInfoType.d.ts.map +1 -1
  95. package/dist/types/ESObjects/general/ESPath/ESPathImpl/GetCurrentFuncType.d.ts +7 -0
  96. package/dist/types/ESObjects/general/ESPath/ESPathImpl/GetCurrentFuncType.d.ts.map +1 -1
  97. package/dist/types/ESObjects/general/ESPath/ESPathImpl/RotLerpModeType.d.ts +3 -0
  98. package/dist/types/ESObjects/general/ESPath/ESPathImpl/RotLerpModeType.d.ts.map +1 -1
  99. package/dist/types/ESObjects/general/ESPath/ESPathImpl/computeRotIfUndefined.d.ts +32 -4
  100. package/dist/types/ESObjects/general/ESPath/ESPathImpl/computeRotIfUndefined.d.ts.map +1 -1
  101. package/dist/types/ESObjects/general/ESPath/ESPathImpl/getCurrent.d.ts +13 -6
  102. package/dist/types/ESObjects/general/ESPath/ESPathImpl/getCurrent.d.ts.map +1 -1
  103. package/dist/types/ESObjects/general/ESPath/ESPathImpl/index.d.ts +262 -7
  104. package/dist/types/ESObjects/general/ESPath/ESPathImpl/index.d.ts.map +1 -1
  105. package/dist/types/ESObjects/general/ESPath/ESPathImpl/parseData.d.ts +8 -0
  106. package/dist/types/ESObjects/general/ESPath/ESPathImpl/parseData.d.ts.map +1 -1
  107. package/dist/types/ESObjects/general/ESPath/ESPathImpl/subPath.d.ts +10 -0
  108. package/dist/types/ESObjects/general/ESPath/ESPathImpl/subPath.d.ts.map +1 -1
  109. package/dist/types/ESObjects/general/ESPath/index.d.ts +146 -0
  110. package/dist/types/ESObjects/general/ESPath/index.d.ts.map +1 -1
  111. package/dist/types/ESObjects/general/ESPlayer/AbsolutePlayer.d.ts +58 -0
  112. package/dist/types/ESObjects/general/ESPlayer/AbsolutePlayer.d.ts.map +1 -1
  113. package/dist/types/ESObjects/general/ESPlayer/index.d.ts +76 -1
  114. package/dist/types/ESObjects/general/ESPlayer/index.d.ts.map +1 -1
  115. package/dist/types/ESObjects/general/ESPoi2D.d.ts +27 -17
  116. package/dist/types/ESObjects/general/ESPoi2D.d.ts.map +1 -1
  117. package/dist/types/ESObjects/general/ESRtsFeatureEditing/index.d.ts +101 -23
  118. package/dist/types/ESObjects/general/ESRtsFeatureEditing/index.d.ts.map +1 -1
  119. package/dist/types/ESObjects/general/ESRtsTileset/index.d.ts +166 -7
  120. package/dist/types/ESObjects/general/ESRtsTileset/index.d.ts.map +1 -1
  121. package/dist/types/ESObjects/general/ESRtsTileset/types.d.ts +53 -9
  122. package/dist/types/ESObjects/general/ESRtsTileset/types.d.ts.map +1 -1
  123. package/dist/types/ESObjects/general/ESSeparateFoliage/CallFunc.d.ts +152 -1
  124. package/dist/types/ESObjects/general/ESSeparateFoliage/CallFunc.d.ts.map +1 -1
  125. package/dist/types/ESObjects/general/ESSeparateFoliage/index.d.ts +208 -0
  126. package/dist/types/ESObjects/general/ESSeparateFoliage/index.d.ts.map +1 -1
  127. package/dist/types/ESObjects/general/ESSkylineAnalysis/index.d.ts +109 -4
  128. package/dist/types/ESObjects/general/ESSkylineAnalysis/index.d.ts.map +1 -1
  129. package/dist/types/ESObjects/general/ESSubmergingAnalysis/bufferUtils.d.ts +88 -0
  130. package/dist/types/ESObjects/general/ESSubmergingAnalysis/bufferUtils.d.ts.map +1 -1
  131. package/dist/types/ESObjects/general/ESSubmergingAnalysis/index.d.ts +153 -12
  132. package/dist/types/ESObjects/general/ESSubmergingAnalysis/index.d.ts.map +1 -1
  133. package/dist/types/ESObjects/general/ESSubmergingAnalysis/parseGlb.d.ts +25 -0
  134. package/dist/types/ESObjects/general/ESSubmergingAnalysis/parseGlb.d.ts.map +1 -1
  135. package/dist/types/ESObjects/general/ESSunshineAnalysis/index.d.ts +98 -0
  136. package/dist/types/ESObjects/general/ESSunshineAnalysis/index.d.ts.map +1 -1
  137. package/dist/types/ESObjects/general/ESUEWidget.d.ts +5 -1
  138. package/dist/types/ESObjects/general/ESUEWidget.d.ts.map +1 -1
  139. package/dist/types/ESObjects/general/ESUnrealActor.d.ts +5 -1
  140. package/dist/types/ESObjects/general/ESUnrealActor.d.ts.map +1 -1
  141. package/dist/types/ESViewer/ESViewer.d.ts +30 -3
  142. package/dist/types/ESViewer/ESViewer.d.ts.map +1 -1
  143. package/dist/types/EngineObject/index.d.ts +22 -5
  144. package/dist/types/EngineObject/index.d.ts.map +1 -1
  145. package/dist/types/utils/turf/geoArea.d.ts +1 -1
  146. package/dist/types/utils/turf/geoCenterOfMass.d.ts +1 -1
  147. package/package.json +4 -2
@@ -1,50 +1,178 @@
1
1
  import { ESJColor, ESJEnvironmentMapManagerType, ESJMaterialType, ESJResource, ESJsonObjectType, ESJVector2D, ESJVector3D, ESJVector4D } from "../../../ESJTypes";
2
2
  import { ESVisualObject } from "../../../ESObjects";
3
- import { Event, JsonValue, UniteChanged } from "xbsj-base";
3
+ import { Event, JsonValue, SceneObjectKey, UniteChanged } from "xbsj-base";
4
4
  import { ESJFeatureStyleType, FeatureColorJsonType, FeatureVisableJsonType } from "./type";
5
5
  /**
6
6
  * https://www.wolai.com/earthsdk/scb9Mm6X1zR4GypJQreRvK
7
7
  * https://c0yh9tnn0na.feishu.cn/wiki/F5bDwHVrOiHHI3kk6QjcZF6engc
8
+ *
9
+ * ES3DTileset 类,继承自 ESVisualObject,用于处理 3D Tileset 数据。
10
+ */
11
+ /**
12
+ * ES3DTileset 类用于管理和操作 3D Tileset 数据。
13
+ * 该类继承自 ESVisualObject,提供了对 3D Tileset 的各种操作和事件处理功能。
14
+ * https://www.wolai.com/earthsdk/scb9Mm6X1zR4GypJQreRvK
15
+ * https://c0yh9tnn0na.feishu.cn/wiki/F5bDwHVrOiHHI3kk6QjcZF6engc
16
+ * 主要功能包括:
17
+ * - 注册和获取类型信息
18
+ * - 支持编辑模式(平移和旋转)
19
+ * - 刷新 Tileset
20
+ * - 处理 Tileset 准备就绪事件
21
+ * - 高亮和飞行到特定特征
22
+ * - 获取和设置特征表
23
+ * - 获取和设置材质名称列表
24
+ * - 设置特征样式和颜色
25
+ * - 设置特征可见性
26
+ * - 还原特征样式
27
+ * - 设置材质
28
+ * - 裁剪平面和扁平化处理
29
+ * - 获取和设置各种属性
30
+ *
31
+ * 使用示例:
32
+ *
33
+ * 构造函数参数:
34
+ * 无特殊构造函数参数,继承自 ESVisualObject。
35
+ *
36
+ * 特殊使用限制或潜在的副作用:
37
+ * - 在设置特征样式和颜色时,需要确保提供的 JSON 格式正确,否则可能会引发错误。
38
+ * - 设置裁剪平面 ID 和挖坑 ID 时,需要确保 ID 的有效性和正确性。
8
39
  */
9
40
  export declare class ES3DTileset extends ESVisualObject {
41
+ /**
42
+ * 注册 ES3DTileset 类型,设置其名称、标签和描述。
43
+ */
10
44
  static readonly type: string;
45
+ /**
46
+ * 获取类型名称。
47
+ * @returns 类型名称字符串。
48
+ */
11
49
  get typeName(): string;
50
+ /**
51
+ * 重写默认属性,返回 ES3DTileset 创建的默认属性。
52
+ * @returns 默认属性对象。
53
+ */
12
54
  get defaultProps(): {
55
+ /**
56
+ * 服务地址,支持字符串或 ESJResource 类型。
57
+ */
13
58
  url: string | ESJResource;
59
+ /**
60
+ * actorTag 标签,适用于 UE 引擎,用于绑定或创建场景中的对象。
61
+ */
14
62
  actorTag: string;
63
+ /**
64
+ * 材质模式,可选择 'normal'(常规模式) 或 'technology'(科技感模式)。
65
+ */
15
66
  materialMode: "normal" | "technology";
67
+ /**
68
+ * 是否高亮,该属性仅在 UE 引擎中生效。
69
+ */
16
70
  highlight: boolean;
71
+ /**
72
+ * 最大屏幕空间误差,用于控制显示精度,默认值为 16。
73
+ */
17
74
  maximumScreenSpaceError: number;
75
+ /**
76
+ * 高亮 ID,用于标识高亮对象。
77
+ */
18
78
  highlightID: number;
79
+ /**
80
+ * 高亮颜色,以数组形式表示的 RGBA 颜色值,默认值为红色([1, 0, 0, 1])。
81
+ */
19
82
  highlightColor: import("xbsj-base").ReactiveVariable<ESJColor>;
83
+ /**
84
+ * 偏移量,三维向量,初始值为未定义。
85
+ */
20
86
  offset: import("xbsj-base").ReactiveVariable<ESJVector3D | undefined>;
87
+ /**
88
+ * 旋转角度,三维向量,初始值为 [0, 0, 0]。
89
+ */
21
90
  rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
91
+ /**
92
+ * 基于图像的光照因子,二维向量,默认值为 [1, 1]。
93
+ */
22
94
  czmImageBasedLightingFactor: import("xbsj-base").ReactiveVariable<ESJVector2D>;
95
+ /**
96
+ * 动态环境贴图管理器,初始值为未定义。
97
+ */
23
98
  czmEnvironmentMapManager: import("xbsj-base").ReactiveVariable<ESJEnvironmentMapManagerType | undefined>;
24
99
  /**
25
- * @deprecated czmLuminanceAtZenith已弃用,请使用czmEnvironmentMapManager代替
100
+ * @deprecated czmLuminanceAtZenith 已弃用,请使用 czmEnvironmentMapManager 代替。
101
+ * 天顶亮度,默认值为 2。
26
102
  */
27
103
  czmLuminanceAtZenith: number;
28
104
  /**
29
- * @deprecated czmAtmosphereScatteringIntensity已弃用,请使用czmEnvironmentMapManager代替
105
+ * @deprecated czmAtmosphereScatteringIntensity 已弃用,请使用 czmEnvironmentMapManager 代替。
106
+ * 大气散射强度,默认值为 2。
30
107
  */
31
108
  czmAtmosphereScatteringIntensity: number;
109
+ /**
110
+ * 最大内存使用量,单位为 MB,默认值为 512。
111
+ */
32
112
  czmMaximumMemoryUsage: number;
113
+ /**
114
+ * 分类类型,可选择 'NONE'、'TERRAIN'、'CESIUM_3D_TILE' 或 'BOTH',默认值为 'NONE'。
115
+ */
33
116
  czmClassificationType: string;
117
+ /**
118
+ * 样式 JSON,初始值为空对象。
119
+ */
34
120
  czmStyleJson: import("xbsj-base").ReactiveVariable<JsonValue>;
121
+ /**
122
+ * 是否进行背面剔除,默认值为 true。
123
+ */
35
124
  czmBackFaceCulling: boolean;
125
+ /**
126
+ * 是否显示调试用的边界体积,默认值为 false。
127
+ */
36
128
  czmDebugShowBoundingVolume: boolean;
129
+ /**
130
+ * 是否显示调试用的内容边界体积,默认值为 false。
131
+ */
37
132
  czmDebugShowContentBoundingVolume: boolean;
133
+ /**
134
+ * 是否跳过细节层次,默认值为 false。
135
+ */
38
136
  czmSkipLevelOfDetail: boolean;
137
+ /**
138
+ * 最大缓存占用,超过的会自动卸载,但视野范围内能看见的保留,单位为字节,默认值为 512MB。
139
+ */
39
140
  cacheBytes: number;
141
+ /**
142
+ * 颜色混合模式,可选择 'HIGHLIGHT'(高亮)、'REPLACE'(替换) 或 'MIX'(混合),默认值为 'HIGHLIGHT'。
143
+ */
40
144
  colorBlendMode: "HIGHLIGHT" | "REPLACE" | "MIX";
145
+ /**
146
+ * 裁剪平面是否启用,默认值为 true。
147
+ */
41
148
  clippingPlaneEnabled: boolean;
149
+ /**
150
+ * 是否合并裁剪区域,默认值为 true。
151
+ */
42
152
  unionClippingRegions: boolean;
153
+ /**
154
+ * 裁剪平面边缘颜色,以数组形式表示的 RGBA 颜色值,默认值为白色([1, 1, 1, 1])。
155
+ */
43
156
  clippingPlaneEdgeColor: import("xbsj-base").ReactiveVariable<ESJColor>;
157
+ /**
158
+ * 裁剪平面边缘宽度,默认值为 2。
159
+ */
44
160
  clippingPlaneEdgeWidth: number;
161
+ /**
162
+ * 材质参数,包含基础颜色,默认基础颜色为 [0, 0.5, 1]。
163
+ */
45
164
  materialParams: ESJsonObjectType;
165
+ /**
166
+ * 是否允许拾取,默认值为 true。
167
+ */
46
168
  allowPicking: boolean;
169
+ /**
170
+ * 材质替换映射,初始值为未定义。
171
+ */
47
172
  materialOverrideMap: import("xbsj-base").ReactiveVariable<undefined>;
173
+ /**
174
+ * 特征 ID 标签,默认值为 0。
175
+ */
48
176
  featureIdLabel: number;
49
177
  show: boolean;
50
178
  collision: boolean;
@@ -58,83 +186,179 @@ export declare class ES3DTileset extends ESVisualObject {
58
186
  updateFuncStr: string | undefined;
59
187
  toDestroyFuncStr: string | undefined;
60
188
  };
189
+ /**
190
+ * 重写支持的编辑模式,包含平移和旋转模式。
191
+ */
61
192
  static supportEditingModes: string[];
193
+ constructor(id?: SceneObjectKey);
194
+ /**
195
+ * 重写更新编辑状态的方法,启动编辑模式。
196
+ */
62
197
  updateEditing(): void;
198
+ /**
199
+ * 私有属性,刷新 Tileset 的事件。
200
+ */
63
201
  private _refreshTilesetEvent;
202
+ /**
203
+ * 获取刷新 Tileset 的事件。
204
+ * @returns 刷新 Tileset 的事件对象。
205
+ */
64
206
  get refreshTilesetEvent(): Event<[]>;
207
+ /**
208
+ * 触发刷新 Tileset 的事件。
209
+ */
65
210
  refreshTileset(): void;
211
+ /**
212
+ * 私有属性,Tileset 准备就绪的事件,携带 Tileset 对象作为参数。
213
+ */
66
214
  private _tilesetReadyEvent;
215
+ /**
216
+ * 获取 Tileset 准备就绪的事件。
217
+ * @returns Tileset 准备就绪的事件对象。
218
+ */
67
219
  get tilesetReady(): Event<[tileset: any]>;
68
220
  /**
69
- * @deprecated 完全支持3dtileset的编辑,不需要再使用这个事件了
221
+ * 已弃用的属性,指示是否支持编辑,现在已完全支持 3D Tileset 的编辑,不需要再使用此事件。
222
+ * @deprecated("完全支持3dtileset的编辑,不需要再使用这个事件了")
70
223
  */
71
224
  private _supportEdit;
225
+ /**
226
+ * 获取是否支持编辑的状态。
227
+ * @deprecated("完全支持3dtileset的编辑,不需要再使用这个属性了")
228
+ * @returns 是否支持编辑的布尔值。
229
+ */
72
230
  get supportEdit(): boolean;
231
+ /**
232
+ * 设置是否支持编辑的状态。
233
+ * @param value - 是否支持编辑的布尔值。
234
+ */
73
235
  set supportEdit(value: boolean);
236
+ /**
237
+ * 获取是否支持编辑状态改变的事件。
238
+ * @deprecated("完全支持3dtileset的编辑,不需要再使用这个属性了")
239
+ * @returns 是否支持编辑状态改变的事件对象。
240
+ */
74
241
  get supportEditChanged(): import("xbsj-base").Listener<[boolean, boolean]>;
242
+ /**
243
+ * 私有属性,高亮特征的事件,携带特征 ID 和可选的高亮颜色作为参数。
244
+ */
75
245
  private _highlightFeatureEvent;
246
+ /**
247
+ * 获取高亮特征的事件。
248
+ * @returns 高亮特征的事件对象。
249
+ */
76
250
  get highlightFeatureEvent(): Event<[id: string | number, color?: string | undefined]>;
251
+ /**
252
+ * 触发高亮特征的事件。
253
+ * @param id - 特征 ID。
254
+ * @param color - 可选的高亮颜色,参数形式如 `rgba(255,0,0,1)`。
255
+ */
77
256
  highlightFeature(id: string | number, color?: string): void;
257
+ /**
258
+ * 私有属性,高亮特征并飞行到该特征的事件,携带特征 ID、笛卡尔坐标系的球体信息、可选的高亮颜色和可选的飞行时间作为参数。
259
+ */
78
260
  private _highlightFeatureAndFlyToEvent;
261
+ /**
262
+ * 获取高亮特征并飞行到该特征的事件。
263
+ * @returns 高亮特征并飞行到该特征的事件对象。
264
+ */
79
265
  get highlightFeatureAndFlyToEvent(): Event<[id: string | number, sphere: ESJVector4D, color?: string | undefined, duration?: number | undefined]>;
80
266
  /**
81
- * @param id 节点id
82
- * @param sphere 笛卡尔坐标系[x, y, z, radius]
83
- * @param color 高亮颜色,不传就是默认颜色不高亮, 参数形式如 `rgba(255,0,0,1)`
84
- * @param duration 飞行时间,默认1s
267
+ * 触发高亮特征并飞行到该特征的事件。
268
+ * @param id - 节点 ID。
269
+ * @param sphere - 笛卡尔坐标系 [x, y, z, radius]。
270
+ * @param color - 高亮颜色,不传就是默认颜色不高亮,参数形式如 `rgba(255,0,0,1)`。
271
+ * @param duration - 飞行时间,默认 1s。
85
272
  */
86
273
  highlightFeatureAndFlyTo(id: string | number, sphere: ESJVector4D, color?: string, duration?: number): void;
274
+ /**
275
+ * 私有属性,获取特征表的事件。
276
+ */
87
277
  private _getFeatureTableEvent;
278
+ /**
279
+ * 公共属性,特征表结果的事件,携带特征表结果数组或 undefined 作为参数。
280
+ */
88
281
  _featureTableResultEvent: Event<[{
89
282
  key: string;
90
283
  type: string | number;
91
284
  }[] | undefined]>;
285
+ /**
286
+ * 获取获取特征表的事件。
287
+ * @returns 获取特征表的事件对象。
288
+ */
92
289
  get getFeatureTableEvent(): Event<[]>;
290
+ /**
291
+ * 触发获取特征表的事件,并返回一个 Promise,在 2 秒内等待特征表结果,超时返回 undefined。
292
+ * @returns 包含特征表结果数组或 undefined 的 Promise。
293
+ */
93
294
  getFeatureTable(): Promise<{
94
295
  key: string;
95
296
  type: string | number;
96
297
  }[] | undefined>;
298
+ /**
299
+ * 私有属性,获取材质名称列表的事件,携带未定义、材质名称数组或 'start' 作为参数。
300
+ */
97
301
  private _getMaterialNameListEvent;
302
+ /**
303
+ * 获取获取材质名称列表的事件。
304
+ * @returns 获取材质名称列表的事件对象。
305
+ */
98
306
  get getMaterialNameListEvent(): Event<[string[] | "start" | undefined]>;
307
+ /**
308
+ * 触发获取材质名称列表的事件,并返回一个 Promise,在 2 秒内等待材质名称列表结果,超时返回 undefined。
309
+ * @returns 包含材质名称列表数组或 undefined 的 Promise。
310
+ */
99
311
  getMaterialNameList(): Promise<unknown>;
312
+ /**
313
+ * 私有属性,设置特征样式的事件,携带 ESJFeatureStyleType 类型的样式信息作为参数。
314
+ */
100
315
  private _setFeatureStyleEvent;
316
+ /**
317
+ * 获取设置特征样式的事件。
318
+ * @returns 设置特征样式的事件对象。
319
+ */
101
320
  get setFeatureStyleEvent(): Event<[ESJFeatureStyleType]>;
102
321
  /**
103
- * 根据条件设置style
104
- * @param json
105
- * json格式如下:
106
- * @param op:string类型,操作符(目前字符串属性支持:== != contain empty; 数字属性支持:== != > >= < <=)
322
+ * 根据条件设置特征样式。
323
+ * @param json - JSON 格式的样式信息,格式如下:
107
324
  * @example
108
325
  * [
109
- {
110
- condition:[{
111
- field:"id",
112
- op:"!=",
113
- value:"ss"
114
- },{
115
- field:"name",
116
- op:"contain",
117
- value:""
118
- }],
119
- color:[1,0,0,1],
120
- show:true
121
- },
122
- {
123
- condition:{
124
- field:"height",
125
- op:"==",
126
- value:20
127
- },
128
- color:[1,1,0,1],
129
- show:false
130
- }
131
- ]
326
+ * {
327
+ * condition: [
328
+ * {
329
+ * field: "id",
330
+ * op: "!=",
331
+ * value: "ss"
332
+ * },
333
+ * {
334
+ * field: "name",
335
+ * op: "contain",
336
+ * value: "杨"
337
+ * }
338
+ * ],
339
+ * color: [1, 0, 0, 1],
340
+ * show: true
341
+ * },
342
+ * {
343
+ * condition: {
344
+ * field: "height",
345
+ * op: "==",
346
+ * value: 20
347
+ * },
348
+ * color: [1, 1, 0, 1],
349
+ * show: false
350
+ * }
351
+ * ]
132
352
  */
133
353
  setFeatureStyle(json: ESJFeatureStyleType): void;
134
354
  /**
135
- * 根据属性设置颜色
355
+ * 私有属性,设置特征颜色的事件,携带特征名称和 FeatureColorJsonType 类型的颜色信息数组作为参数。
136
356
  */
137
357
  private _setFeatureColorEvent;
358
+ /**
359
+ * 获取设置特征颜色的事件。
360
+ * @returns 设置特征颜色的事件对象。
361
+ */
138
362
  get setFeatureColorEvent(): Event<[string, FeatureColorJsonType[]]>;
139
363
  /**
140
364
  * 基于提供的条件为特定特征属性设置颜色。
@@ -144,13 +368,13 @@ export declare class ES3DTileset extends ESVisualObject {
144
368
  * 如果提供的是数组,它应该是 FeatureColorJsonType 对象的数组。
145
369
  * @remarks
146
370
  * 条件可以基于要素的值、最小值或最大值。
147
- * 颜色为0~1的映射数组,例如[1,0,0,1] 表示红色。
371
+ * 颜色为 0~1 的映射数组,例如 [1, 0, 0, 1] 表示红色。
148
372
  * @example
149
373
  * ```typescript
150
374
  * const featureName = "height";
151
375
  * const conditions: FeatureColorJsonType[] = [
152
- * { minValue: 100000, color: [1,0,0,1] },
153
- * { maxValue: 500000, color: [1,1,0,1] },
376
+ * { minValue: 100000, color: [1, 0, 0, 1] },
377
+ * { maxValue: 500000, color: [1, 1, 0, 1] },
154
378
  * ];
155
379
  * setFeatureColor(featureName, conditions);
156
380
  * ```
@@ -158,22 +382,23 @@ export declare class ES3DTileset extends ESVisualObject {
158
382
  */
159
383
  setFeatureColor(featureName: string, json: string | FeatureColorJsonType[]): void;
160
384
  /**
161
- * 根据属性控制show
385
+ * 私有属性,设置特征可见性的事件,携带特征名称和 FeatureVisableJsonType 类型的可见性信息数组作为参数。
162
386
  */
163
387
  private _setFeatureVisableEvent;
388
+ /**
389
+ * 获取设置特征可见性的事件。
390
+ * @returns 设置特征可见性的事件对象。
391
+ */
164
392
  get setFeatureVisableEvent(): Event<[string, FeatureVisableJsonType[]]>;
165
393
  /**
166
394
  * 根据提供的条件设置要素的可见性。
167
- *
168
395
  * @param featureName - 要修改的属性名称。
169
396
  * @param json - 要素的条件和可见性。
170
397
  * 如果提供的是字符串,它应该是有效的 JSON 字符串。
171
398
  * 如果提供的是数组,它应该是 FeatureVisableJsonType 对象的数组。
172
- *
173
399
  * @remarks
174
400
  * 条件可以基于要素的值、最小值或最大值。
175
401
  * 可见性可以设置为 true 或 false。
176
- *
177
402
  * @example
178
403
  * ```typescript
179
404
  * const featureName = "height";
@@ -188,57 +413,166 @@ export declare class ES3DTileset extends ESVisualObject {
188
413
  */
189
414
  setFeatureVisable(featureName: string, json: string | FeatureVisableJsonType[]): void;
190
415
  /**
191
- * 还原样式设置
416
+ * 私有属性,还原特征样式的事件。
192
417
  */
193
418
  private _resetFeatureStyleEvent;
419
+ /**
420
+ * 获取还原特征样式的事件。
421
+ * @returns 还原特征样式的事件对象。
422
+ */
194
423
  get resetFeatureStyleEvent(): Event<[]>;
424
+ /**
425
+ * 触发还原特征样式的事件。
426
+ */
195
427
  resetFeatureStyle(): void;
428
+ /**
429
+ * 公共属性,设置材质信息的事件,携带材质信息对象作为参数。
430
+ */
196
431
  setMaterialInfoEvent: Event<[{
197
432
  [xx: string]: any;
198
433
  }]>;
434
+ /**
435
+ * 私有属性,设置材质的事件,携带材质对象或 'default' 作为参数。
436
+ */
199
437
  private _setMaterialEvent;
438
+ /**
439
+ * 获取设置材质的事件。
440
+ * @returns 设置材质的事件对象。
441
+ */
200
442
  get setMaterialEvent(): Event<["default" | {
201
443
  [xx: string]: ESJMaterialType;
202
444
  }]>;
445
+ /**
446
+ * 设置材质,并返回一个 Promise,等待材质设置完成后的信息。
447
+ * @param options - 材质对象或 'default'。
448
+ * @returns 包含材质设置完成后信息的 Promise。
449
+ */
203
450
  setMaterial(options: {
204
451
  [xx: string]: ESJMaterialType;
205
452
  } | 'default'): Promise<{
206
453
  [xx: string]: any;
207
454
  }>;
455
+ /**
456
+ * 私有属性,裁剪平面 ID,使用 react 函数进行响应式处理。
457
+ */
208
458
  private _clippingPlanesId;
459
+ /**
460
+ * 获取裁剪平面 ID。
461
+ * @returns 裁剪平面 ID 字符串。
462
+ */
209
463
  get clippingPlanesId(): string;
464
+ /**
465
+ * 设置裁剪平面 ID。
466
+ * @param value - 裁剪平面 ID 字符串。
467
+ */
210
468
  set clippingPlanesId(value: string);
469
+ /**
470
+ * 获取裁剪平面 ID 改变的事件。
471
+ * @returns 裁剪平面 ID 改变的事件对象。
472
+ */
211
473
  get clippingPlanesIdChanged(): import("xbsj-base").Listener<[string, string]>;
212
474
  /**
213
- * 面裁切 ESClippingPlane
475
+ * 面裁切 ESClippingPlane,私有属性,裁剪平面 ID 数组,使用 react 函数进行响应式处理。
214
476
  */
215
477
  private _clippingPlaneIds;
478
+ /**
479
+ * 获取裁剪平面 ID 数组。
480
+ * @returns 裁剪平面 ID 数组。
481
+ */
216
482
  get clippingPlaneIds(): string[];
483
+ /**
484
+ * 设置裁剪平面 ID 数组。
485
+ * @param value - 裁剪平面 ID 数组。
486
+ */
217
487
  set clippingPlaneIds(value: string[]);
488
+ /**
489
+ * 获取裁剪平面 ID 数组改变的事件。
490
+ * @returns 裁剪平面 ID 数组改变的事件对象。
491
+ */
218
492
  get clippingPlaneIdsChanged(): import("xbsj-base").Listener<[string[], string[]]>;
493
+ /**
494
+ * 私有属性,扁平化平面 ID,使用 react 函数进行响应式处理。
495
+ */
219
496
  private _flattenedPlaneId;
497
+ /**
498
+ * 获取扁平化平面 ID。
499
+ * @returns 扁平化平面 ID 字符串。
500
+ */
220
501
  get flattenedPlaneId(): string;
502
+ /**
503
+ * 设置扁平化平面 ID。
504
+ * @param value - 扁平化平面 ID 字符串。
505
+ */
221
506
  set flattenedPlaneId(value: string);
507
+ /**
508
+ * 获取扁平化平面 ID 改变的事件。
509
+ * @returns 扁平化平面 ID 改变的事件对象。
510
+ */
222
511
  get flattenedPlaneIdChanged(): import("xbsj-base").Listener<[string, string]>;
512
+ /**
513
+ * 私有属性,扁平化平面是否启用,使用 react 函数进行响应式处理。
514
+ */
223
515
  private _flattenedPlaneEnabled;
516
+ /**
517
+ * 获取扁平化平面是否启用的状态。
518
+ * @returns 扁平化平面是否启用的布尔值。
519
+ */
224
520
  get flattenedPlaneEnabled(): boolean;
521
+ /**
522
+ * 设置扁平化平面是否启用的状态。
523
+ * @param value - 扁平化平面是否启用的布尔值。
524
+ */
225
525
  set flattenedPlaneEnabled(value: boolean);
526
+ /**
527
+ * 获取扁平化平面是否启用状态改变的事件。
528
+ * @returns 扁平化平面是否启用状态改变的事件对象。
529
+ */
226
530
  get flattenedPlaneEnabledChanged(): import("xbsj-base").Listener<[boolean, boolean]>;
227
531
  /**
228
- * 体裁切 ESBoxClippingPlanes + 挖坑
532
+ * 体裁切 ESBoxClippingPlanes + 挖坑,私有属性,裁剪平面 ID,使用 react 函数进行响应式处理。
229
533
  */
230
534
  private _clippingPlaneId;
535
+ /**
536
+ * 获取裁剪平面 ID。
537
+ * @returns 裁剪平面 ID 字符串。
538
+ */
231
539
  get clippingPlaneId(): string;
540
+ /**
541
+ * 设置裁剪平面 ID。
542
+ * @param value - 裁剪平面 ID 字符串。
543
+ */
232
544
  set clippingPlaneId(value: string);
545
+ /**
546
+ * 获取裁剪平面 ID 改变的事件。
547
+ * @returns 裁剪平面 ID 改变的事件对象。
548
+ */
233
549
  get clippingPlaneIdChanged(): import("xbsj-base").Listener<[string, string]>;
550
+ /**
551
+ * 私有属性,挖坑 ID 数组,使用 reactArray 函数进行响应式处理。
552
+ */
234
553
  private _excavateId;
554
+ /**
555
+ * 获取挖坑 ID 数组。
556
+ * @returns 挖坑 ID 数组。
557
+ */
235
558
  get excavateId(): string[];
559
+ /**
560
+ * 设置挖坑 ID 数组。
561
+ * @param value - 挖坑 ID 数组。
562
+ */
236
563
  set excavateId(value: string[]);
564
+ /**
565
+ * 获取挖坑 ID 数组改变的事件。
566
+ * @returns 挖坑 ID 数组改变的事件对象。
567
+ */
237
568
  get excavateIdChanged(): import("xbsj-base").Listener<[string[], string[]]>;
238
569
  /**
239
- * 仅Cesium引擎生效
570
+ * 仅 Cesium 引擎生效,设置光照模式为 122。
240
571
  */
241
572
  setLight122(): void;
573
+ /**
574
+ * 重写默认值,包含服务地址、材质模式、偏移量等默认属性。
575
+ */
242
576
  static defaults: {
243
577
  url: string;
244
578
  actorTag: string;
@@ -257,6 +591,10 @@ export declare class ES3DTileset extends ESVisualObject {
257
591
  flyToParam: import("../../../ESJTypes").ESJFlyToParam;
258
592
  flyInParam: import("../../../ESJTypes").ESJFlyInParam;
259
593
  };
594
+ /**
595
+ * 重写获取 ES 属性的方法,返回包含基本信息、数据源、坐标等属性的对象。
596
+ * @returns ES 属性对象。
597
+ */
260
598
  getESProperties(): {
261
599
  defaultMenu: string;
262
600
  basic: import("../../../ESJTypes").Property[];
@@ -266,45 +604,143 @@ export declare class ES3DTileset extends ESVisualObject {
266
604
  location: import("../../../ESJTypes").Property[];
267
605
  style: import("../../../ESJTypes").Property[];
268
606
  };
607
+ /**
608
+ * 重写获取属性的方法,返回包含各种属性和方法的数组。
609
+ * @param language - 可选的语言参数。
610
+ * @returns 属性和方法的数组。
611
+ */
269
612
  getProperties(language?: string): import("../../../ESJTypes").Property[];
270
613
  }
614
+ /**
615
+ * ES3DTileset 命名空间,包含创建默认属性的方法。
616
+ */
271
617
  export declare namespace ES3DTileset {
618
+ /**
619
+ * 创建 ES3DTileset 的默认属性。
620
+ * @returns 默认属性对象。
621
+ */
272
622
  const createDefaultProps: () => {
623
+ /**
624
+ * 服务地址,支持字符串或 ESJResource 类型。
625
+ */
273
626
  url: string | ESJResource;
627
+ /**
628
+ * actorTag 标签,适用于 UE 引擎,用于绑定或创建场景中的对象。
629
+ */
274
630
  actorTag: string;
631
+ /**
632
+ * 材质模式,可选择 'normal'(常规模式) 或 'technology'(科技感模式)。
633
+ */
275
634
  materialMode: "normal" | "technology";
635
+ /**
636
+ * 是否高亮,该属性仅在 UE 引擎中生效。
637
+ */
276
638
  highlight: boolean;
639
+ /**
640
+ * 最大屏幕空间误差,用于控制显示精度,默认值为 16。
641
+ */
277
642
  maximumScreenSpaceError: number;
643
+ /**
644
+ * 高亮 ID,用于标识高亮对象。
645
+ */
278
646
  highlightID: number;
647
+ /**
648
+ * 高亮颜色,以数组形式表示的 RGBA 颜色值,默认值为红色([1, 0, 0, 1])。
649
+ */
279
650
  highlightColor: import("xbsj-base").ReactiveVariable<ESJColor>;
651
+ /**
652
+ * 偏移量,三维向量,初始值为未定义。
653
+ */
280
654
  offset: import("xbsj-base").ReactiveVariable<ESJVector3D | undefined>;
655
+ /**
656
+ * 旋转角度,三维向量,初始值为 [0, 0, 0]。
657
+ */
281
658
  rotation: import("xbsj-base").ReactiveVariable<ESJVector3D>;
659
+ /**
660
+ * 基于图像的光照因子,二维向量,默认值为 [1, 1]。
661
+ */
282
662
  czmImageBasedLightingFactor: import("xbsj-base").ReactiveVariable<ESJVector2D>;
663
+ /**
664
+ * 动态环境贴图管理器,初始值为未定义。
665
+ */
283
666
  czmEnvironmentMapManager: import("xbsj-base").ReactiveVariable<ESJEnvironmentMapManagerType | undefined>;
284
667
  /**
285
- * @deprecated czmLuminanceAtZenith已弃用,请使用czmEnvironmentMapManager代替
668
+ * @deprecated czmLuminanceAtZenith 已弃用,请使用 czmEnvironmentMapManager 代替。
669
+ * 天顶亮度,默认值为 2。
286
670
  */
287
671
  czmLuminanceAtZenith: number;
288
672
  /**
289
- * @deprecated czmAtmosphereScatteringIntensity已弃用,请使用czmEnvironmentMapManager代替
673
+ * @deprecated czmAtmosphereScatteringIntensity 已弃用,请使用 czmEnvironmentMapManager 代替。
674
+ * 大气散射强度,默认值为 2。
290
675
  */
291
676
  czmAtmosphereScatteringIntensity: number;
677
+ /**
678
+ * 最大内存使用量,单位为 MB,默认值为 512。
679
+ */
292
680
  czmMaximumMemoryUsage: number;
681
+ /**
682
+ * 分类类型,可选择 'NONE'、'TERRAIN'、'CESIUM_3D_TILE' 或 'BOTH',默认值为 'NONE'。
683
+ */
293
684
  czmClassificationType: string;
685
+ /**
686
+ * 样式 JSON,初始值为空对象。
687
+ */
294
688
  czmStyleJson: import("xbsj-base").ReactiveVariable<JsonValue>;
689
+ /**
690
+ * 是否进行背面剔除,默认值为 true。
691
+ */
295
692
  czmBackFaceCulling: boolean;
693
+ /**
694
+ * 是否显示调试用的边界体积,默认值为 false。
695
+ */
296
696
  czmDebugShowBoundingVolume: boolean;
697
+ /**
698
+ * 是否显示调试用的内容边界体积,默认值为 false。
699
+ */
297
700
  czmDebugShowContentBoundingVolume: boolean;
701
+ /**
702
+ * 是否跳过细节层次,默认值为 false。
703
+ */
298
704
  czmSkipLevelOfDetail: boolean;
705
+ /**
706
+ * 最大缓存占用,超过的会自动卸载,但视野范围内能看见的保留,单位为字节,默认值为 512MB。
707
+ */
299
708
  cacheBytes: number;
709
+ /**
710
+ * 颜色混合模式,可选择 'HIGHLIGHT'(高亮)、'REPLACE'(替换) 或 'MIX'(混合),默认值为 'HIGHLIGHT'。
711
+ */
300
712
  colorBlendMode: "HIGHLIGHT" | "REPLACE" | "MIX";
713
+ /**
714
+ * 裁剪平面是否启用,默认值为 true。
715
+ */
301
716
  clippingPlaneEnabled: boolean;
717
+ /**
718
+ * 是否合并裁剪区域,默认值为 true。
719
+ */
302
720
  unionClippingRegions: boolean;
721
+ /**
722
+ * 裁剪平面边缘颜色,以数组形式表示的 RGBA 颜色值,默认值为白色([1, 1, 1, 1])。
723
+ */
303
724
  clippingPlaneEdgeColor: import("xbsj-base").ReactiveVariable<ESJColor>;
725
+ /**
726
+ * 裁剪平面边缘宽度,默认值为 2。
727
+ */
304
728
  clippingPlaneEdgeWidth: number;
729
+ /**
730
+ * 材质参数,包含基础颜色,默认基础颜色为 [0, 0.5, 1]。
731
+ */
305
732
  materialParams: ESJsonObjectType;
733
+ /**
734
+ * 是否允许拾取,默认值为 true。
735
+ */
306
736
  allowPicking: boolean;
737
+ /**
738
+ * 材质替换映射,初始值为未定义。
739
+ */
307
740
  materialOverrideMap: import("xbsj-base").ReactiveVariable<undefined>;
741
+ /**
742
+ * 特征 ID 标签,默认值为 0。
743
+ */
308
744
  featureIdLabel: number;
309
745
  show: boolean;
310
746
  collision: boolean;
@@ -319,6 +755,9 @@ export declare namespace ES3DTileset {
319
755
  toDestroyFuncStr: string | undefined;
320
756
  };
321
757
  }
758
+ /**
759
+ * 定义 ES3DTileset 接口,继承自 UniteChanged 类型,返回创建默认属性的返回类型。
760
+ */
322
761
  export interface ES3DTileset extends UniteChanged<ReturnType<typeof ES3DTileset.createDefaultProps>> {
323
762
  }
324
763
  //# sourceMappingURL=index.d.ts.map