@reall3d/reall3dviewer 0.1.4 → 0.1.6

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.
package/dist/pkg.d.ts CHANGED
@@ -63,77 +63,77 @@ declare class Events {
63
63
  }
64
64
 
65
65
  /**
66
- * 元数据
66
+ * Metadata
67
67
  */
68
68
  export declare interface MetaData {
69
- /** 名称 */
69
+ /** Name */
70
70
  name?: string;
71
- /** 版本 */
71
+ /** Version */
72
72
  version?: string;
73
- /** 更新日期(YYYYMMDD) */
73
+ /** Update date (YYYYMMDD) */
74
74
  updateDate?: number;
75
- /** 是否自动旋转 */
75
+ /** Enable auto-rotation */
76
76
  autoRotate?: boolean;
77
- /** 是否调试模式 */
77
+ /** Enable debug mode */
78
78
  debugMode?: boolean;
79
- /** 是否点云模式 */
79
+ /** Enable point-cloud rendering */
80
80
  pointcloudMode?: boolean;
81
- /** 移动端最大渲染数量 */
81
+ /** Maximum render count for mobile */
82
82
  maxRenderCountOfMobile?: number;
83
- /** PC端最大渲染数量 */
83
+ /** Maximum render count for PC */
84
84
  maxRenderCountOfPc?: number;
85
- /** 移动端最大下载数量 */
85
+ /** Maximum download count for mobile splats */
86
86
  mobileDownloadLimitSplatCount?: number;
87
- /** PC端最大下载数量 */
87
+ /** Maximum download count for PC splats */
88
88
  pcDownloadLimitSplatCount?: number;
89
- /** 米比例尺 */
89
+ /** Meter scale factor */
90
90
  meterScale?: number;
91
- /** 文字水印 */
91
+ /** Text watermark */
92
92
  watermark?: string;
93
- /** 是否显示水印 */
93
+ /** Display watermark */
94
94
  showWatermark?: boolean;
95
- /** 是否显示包围盒 */
95
+ /** Display bounding box */
96
96
  showBoundBox?: boolean;
97
- /** 相机参数 */
97
+ /** Camera parameters */
98
98
  cameraInfo?: CameraInfo;
99
- /** 标注 */
99
+ /** Annotations */
100
100
  marks?: any[];
101
- /** 飞翔相机位置点 */
101
+ /** Fly-through camera positions */
102
102
  flyPositions?: number[];
103
- /** 飞翔相机注视点 */
103
+ /** Fly-through camera look-at points */
104
104
  flyTargets?: number[];
105
- /** 是否粒子加载效果,小场景用 */
105
+ /** Enable particle loading effect (small scenes) */
106
106
  particleMode?: boolean;
107
- /** 自动切割数量 */
107
+ /** Auto-cut count */
108
108
  autoCut?: number;
109
- /** 变换矩阵 */
109
+ /** Transformation matrix */
110
110
  transform?: number[];
111
- /** 定位坐标(EPSG:4326 WGS 84) */
111
+ /** Geolocation (EPSG:4326 WGS 84) */
112
112
  WGS84?: number[];
113
- /** 模型地址 */
113
+ /** Model URL */
114
114
  url?: string;
115
115
  }
116
116
 
117
117
  /**
118
- * 高斯模型选项
118
+ * Gaussian Model Options
119
119
  */
120
120
  export declare interface ModelOptions {
121
121
  /**
122
- * 模型地址
122
+ * Model URL
123
123
  */
124
124
  url: string;
125
125
  /**
126
- * 模型格式(ply | splat | spx | spz | obj),默认自动识别
126
+ * Model format (ply | splat | spx | spz | obj), auto-detected by default
127
127
  */
128
128
  format?: 'ply' | 'splat' | 'spx' | 'spz' | 'obj';
129
129
  /**
130
- * 是否重新下载
130
+ * Whether to force re-download
131
131
  */
132
132
  fetchReload?: boolean;
133
133
  }
134
134
 
135
135
  /**
136
- * 地图渲染器
136
+ * Built-in Map viewer with Gaussian Splatting model support
137
137
  */
138
138
  export declare class Reall3dMapViewer extends EventDispatcher<tt.plugin.GLViewerEventMap> {
139
139
  scene: Scene;
@@ -163,37 +163,38 @@ export declare class Reall3dMapViewer extends EventDispatcher<tt.plugin.GLViewer
163
163
  }
164
164
 
165
165
  /**
166
- * 地图配置项
166
+ * Configuration options for Reall3dMapViewer
167
167
  */
168
168
  export declare interface Reall3dMapViewerOptions {
169
169
  /**
170
- * 容器元素或其选择器,默认选择器为'#map',找不到时将自动创建
170
+ * Container element or its selector (default: '#map').
171
+ * Will be automatically created if not found.
171
172
  */
172
173
  root?: HTMLElement | string;
173
174
  /**
174
- * 是否允许键盘操作,默认false
175
+ * Enable keyboard controls (default: false)
175
176
  */
176
177
  enableKeyboard?: boolean;
177
178
  /**
178
- * 拖动范围最小值,默认[-20000, 0.1, -60000]
179
+ * Minimum panning boundaries (default: [-20000, 0.1, -60000])
179
180
  */
180
181
  minPan?: number[];
181
182
  /**
182
- * 拖动范围最大值,默认[50000, 10000, 0]
183
+ * Maximum panning boundaries (default: [50000, 10000, 0])
183
184
  */
184
185
  maxPan?: number[];
185
186
  /**
186
- * 背景色(默认 '#dbf0ff')
187
+ * Background color (default: '#dbf0ff')
187
188
  */
188
189
  background?: string;
189
190
  /**
190
- * 是否调试模式,生产环境默认false
191
+ * Debug mode flag (default: false in production)
191
192
  */
192
193
  debugMode?: boolean;
193
194
  }
194
195
 
195
196
  /**
196
- * 高斯渲染器
197
+ * Built-in Gaussian Splatting model viewer
197
198
  */
198
199
  export declare class Reall3dViewer {
199
200
  private disposed;
@@ -249,151 +250,152 @@ export declare class Reall3dViewer {
249
250
  }
250
251
 
251
252
  /**
252
- * 高斯网格配置项
253
+ * Configuration options for Reall3dViewer
253
254
  */
254
255
  export declare interface Reall3dViewerOptions {
255
256
  /**
256
- * 指定渲染器对象传入使用,未定义时自动生成
257
+ * Specify a custom renderer instance. If undefined, one will be created automatically.
257
258
  */
258
259
  renderer?: Renderer | undefined;
259
260
  /**
260
- * 指定场景对象传入使用,未定义时自动生成
261
+ * Specify a custom scene instance. If undefined, one will be created automatically.
261
262
  */
262
263
  scene?: Scene | undefined;
263
264
  /**
264
- * 指定相机对象传入使用,未定义时自动生成
265
+ * Specify a custom camera instance. If undefined, one will be created automatically.
265
266
  */
266
267
  camera?: PerspectiveCamera | undefined;
267
268
  /**
268
- * 控制器
269
+ * Orbit controls instance
269
270
  */
270
271
  controls?: OrbitControls;
271
272
  /**
272
- * 渲染器事件管理器
273
+ * Renderer event manager
273
274
  */
274
275
  viewerEvents?: Events | undefined;
275
276
  /**
276
- * 是否调试模式,生产环境默认false
277
+ * Debug mode flag. Defaults to false in production.
277
278
  */
278
279
  debugMode?: boolean | undefined;
279
280
  /**
280
- * 是否大场景模式,初始化后不可修改
281
+ * Large scene mode flag. Cannot be modified after initialization.
281
282
  */
282
283
  bigSceneMode?: boolean;
283
284
  /**
284
- * 是否点云模式渲染,默认为true
285
- * 支持通过viewer.options()动态更新
285
+ * Point cloud rendering mode. Defaults to true.
286
+ * Can be dynamically updated via viewer.options()
286
287
  */
287
288
  pointcloudMode?: boolean | undefined;
288
289
  /**
289
- * 移动端可渲染的高斯点数量限制
290
- * 支持通过viewer.options()动态更新
290
+ * Maximum renderable Gaussian points count for mobile devices.
291
+ * Can be dynamically updated via viewer.options()
291
292
  */
292
293
  maxRenderCountOfMobile?: number | undefined;
293
294
  /**
294
- * PC端可渲染的高斯点数量限制
295
- * 支持通过viewer.options()动态更新
295
+ * Maximum renderable Gaussian points count for PC.
296
+ * Can be dynamically updated via viewer.options()
296
297
  */
297
298
  maxRenderCountOfPc?: number | undefined;
298
299
  /**
299
- * 颜色亮度系数,默认1.1
300
+ * Color brightness factor. Defaults to 1.1.
300
301
  */
301
302
  lightFactor?: number | undefined;
302
303
  /**
303
- * 容器元素或其选择器,默认选择器为'#gsviewer',自动创建画布时若找不到容器节点,将在body下自动创建容器
304
+ * Container element or its selector. Defaults to '#gsviewer'.
305
+ * If no container is found when creating canvas, one will be automatically created under body.
304
306
  */
305
307
  root?: HTMLElement | string | undefined;
306
308
  /**
307
- * 相机视场,默认 45
309
+ * Camera field of view. Defaults to 45.
308
310
  */
309
311
  fov?: number | undefined;
310
312
  /**
311
- * 相机近截面距离,默认 0.1
313
+ * Camera near clipping plane. Defaults to 0.1.
312
314
  */
313
315
  near?: number | undefined;
314
316
  /**
315
- * 相机远截面距离,默认 1000
317
+ * Camera far clipping plane. Defaults to 1000.
316
318
  */
317
319
  far?: number | undefined;
318
320
  /**
319
- * 相机位置,默认 [0, -5, 15]
321
+ * Camera position. Defaults to [0, -5, 15].
320
322
  */
321
323
  position?: number[] | undefined;
322
324
  /**
323
- * 相机注视点,默认 [0, 0, 0]
325
+ * Camera look-at target. Defaults to [0, 0, 0].
324
326
  */
325
327
  lookAt?: number[] | undefined;
326
328
  /**
327
- * 相机上向量,默认 [0, -1, 0]
329
+ * Camera up vector. Defaults to [0, -1, 0].
328
330
  */
329
331
  lookUp?: number[] | undefined;
330
332
  /**
331
- * 是否自动旋转,默认true
332
- * 支持通过viewer.options()动态更新
333
+ * Auto-rotation flag. Defaults to true.
334
+ * Can be dynamically updated via viewer.options()
333
335
  */
334
336
  autoRotate?: boolean | undefined;
335
337
  /**
336
- * 是否启用阻尼效果,默认true
338
+ * Damping effect flag. Defaults to true.
337
339
  */
338
340
  enableDamping?: boolean | undefined;
339
341
  /**
340
- * 是否允许操作缩放,默认true
342
+ * Zoom control flag. Defaults to true.
341
343
  */
342
344
  enableZoom?: boolean | undefined;
343
345
  /**
344
- * 是否允许操作旋转,默认true
346
+ * Rotation control flag. Defaults to true.
345
347
  */
346
348
  enableRotate?: boolean | undefined;
347
349
  /**
348
- * 是否允许操作拖动,默认true
350
+ * Pan control flag. Defaults to true.
349
351
  */
350
352
  enablePan?: boolean | undefined;
351
353
  /**
352
- * 最小视距
354
+ * Minimum camera distance
353
355
  */
354
356
  minDistance?: number | undefined;
355
357
  /**
356
- * 最大视距
358
+ * Maximum camera distance
357
359
  */
358
360
  maxDistance?: number | undefined;
359
361
  /**
360
- * 最小倾斜角度
362
+ * Minimum polar angle (vertical rotation limit)
361
363
  */
362
364
  minPolarAngle?: number | undefined;
363
365
  /**
364
- * 最大倾斜角度
366
+ * Maximum polar angle (vertical rotation limit)
365
367
  */
366
368
  maxPolarAngle?: number | undefined;
367
369
  /**
368
- * 是否允许键盘操作,默认true
370
+ * Keyboard controls flag. Defaults to true.
369
371
  */
370
372
  enableKeyboard?: boolean | undefined;
371
373
  /**
372
- * 标注模式,默认false
374
+ * Annotation mode flag. Defaults to false.
373
375
  */
374
376
  markMode?: boolean | undefined;
375
377
  /**
376
- * 标注类型(点、线、面、距离、面积、圆),默认undefined
378
+ * Annotation type (point/lines/plans/distance/area/circle)
377
379
  */
378
380
  markType?: 'point' | 'lines' | 'plans' | 'distance' | 'area' | 'circle' | undefined;
379
381
  /**
380
- * 标注是否显示,默认true
382
+ * Annotation visibility flag. Defaults to true.
381
383
  */
382
384
  markVisible?: boolean | undefined;
383
385
  /**
384
- * 米单位比例尺(1单位长度等于多少米),默认1
386
+ * Meter scale (how many meters per unit length). Defaults to 1.
385
387
  */
386
388
  meterScale?: number | undefined;
387
389
  /**
388
- * 是否禁止直接拖拽本地文件进行查看,默认false
390
+ * Disable local file drag-and-drop flag. Defaults to false.
389
391
  */
390
392
  disableDropLocalFile?: boolean | undefined;
391
393
  /**
392
- * 球谐系数的渲染级别,默认为模型数据的最大可渲染级别
394
+ * Spherical harmonics rendering level. Defaults to the maximum renderable level of model data.
393
395
  */
394
396
  shDegree?: number | undefined;
395
397
  /**
396
- * 背景色(默认 '#000000')
398
+ * Background color (defaults to '#000000')
397
399
  */
398
400
  background?: string;
399
401
  }
@@ -433,66 +435,66 @@ export declare class SplatMesh extends Mesh {
433
435
  }
434
436
 
435
437
  /**
436
- * 高斯网格配置项
438
+ * Splat mesh configuration options
437
439
  */
438
440
  export declare interface SplatMeshOptions {
439
441
  /**
440
- * 名称
442
+ * Name
441
443
  */
442
444
  name?: string;
443
445
  /**
444
- * 指定渲染器对象传入使用
446
+ * Renderer instance to be used
445
447
  */
446
448
  renderer: Renderer;
447
449
  /**
448
- * 指定场景对象传入使用
450
+ * Scene instance to be used
449
451
  */
450
452
  scene: Scene;
451
453
  /**
452
- * 控制器
454
+ * Camera controls
453
455
  */
454
456
  controls?: OrbitControls;
455
457
  /**
456
- * 渲染器事件管理器
458
+ * Renderer event manager
457
459
  */
458
460
  viewerEvents?: Events;
459
461
  /**
460
- * 是否调试模式,生产环境默认false
462
+ * Debug mode flag; defaults to false in production
461
463
  */
462
464
  debugMode?: boolean;
463
465
  /**
464
- * 是否大场景模式,初始化后不可修改
466
+ * Large-scene mode flag; cannot be changed after initialization
465
467
  */
466
468
  bigSceneMode?: boolean;
467
469
  /**
468
- * 是否点云模式渲染,默认为true
469
- * 支持通过viewer.options()动态更新
470
+ * Point-cloud rendering mode; defaults to true,
471
+ * Can be updated dynamically via viewer.options()
470
472
  */
471
473
  pointcloudMode?: boolean;
472
474
  /**
473
- * 移动端可渲染的高斯点数量限制
474
- * 支持通过viewer.options()动态更新
475
+ * Maximum number of Gaussians to render on mobile devices,
476
+ * Can be updated dynamically via viewer.options()
475
477
  */
476
478
  maxRenderCountOfMobile?: number;
477
479
  /**
478
- * PC端可渲染的高斯点数量限制
479
- * 支持通过viewer.options()动态更新
480
+ * Maximum number of Gaussians to render on PC,
481
+ * Can be updated dynamically via viewer.options()
480
482
  */
481
483
  maxRenderCountOfPc?: number;
482
484
  /**
483
- * 颜色亮度系数,默认1.0
485
+ * Brightness scale factor; defaults to 1.0
484
486
  */
485
487
  lightFactor?: number;
486
488
  /**
487
- * 是否显示水印,默认true
489
+ * Whether to display a watermark; defaults to true
488
490
  */
489
491
  showWatermark?: boolean;
490
492
  /**
491
- * 球谐系数的渲染级别,默认0
493
+ * Spherical harmonics rendering degree; defaults to 0
492
494
  */
493
495
  shDegree?: number;
494
496
  /**
495
- * 是否开启深度测试,默认true
497
+ * Enable depth testing; defaults to true
496
498
  */
497
499
  depthTest?: boolean;
498
500
  }