@xeokit/xeokit-sdk 2.2.5-beta-2 → 2.2.5-beta-3

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 (67) hide show
  1. package/dist/xeokit-sdk.cjs.js +16 -16
  2. package/dist/xeokit-sdk.es.js +16 -16
  3. package/package.json +7 -4
  4. package/types/extras/ContextMenu/ContextMenu.d.ts +8 -8
  5. package/types/plugins/AngleMeasurementsPlugin/AngleMeasurement.d.ts +1 -1
  6. package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsControl.d.ts +26 -1
  7. package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.d.ts +76 -62
  8. package/types/plugins/AnnotationsPlugin/Annotation.d.ts +11 -10
  9. package/types/plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts +32 -18
  10. package/types/plugins/AnnotationsPlugin/index.d.ts +1 -0
  11. package/types/plugins/AxisGizmoPlugin/AxisGizmoPlugin.d.ts +1 -1
  12. package/types/plugins/BCFViewpointsPlugin/BCFViewpointsPlugin.d.ts +10 -10
  13. package/types/plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts +2 -2
  14. package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.d.ts +6 -6
  15. package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsControl.d.ts +26 -1
  16. package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts +22 -7
  17. package/types/plugins/FastNavPlugin/FastNavPlugin.d.ts +9 -9
  18. package/types/plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts +8 -8
  19. package/types/plugins/LASLoaderPlugin/LASLoaderPlugin.d.ts +4 -4
  20. package/types/plugins/NavCubePlugin/NavCubePlugin.d.ts +6 -6
  21. package/types/plugins/OBJLoaderPlugin/OBJLoaderPlugin.d.ts +2 -2
  22. package/types/plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts +2 -2
  23. package/types/plugins/STLLoaderPlugin/index.d.ts +0 -1
  24. package/types/plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts +4 -4
  25. package/types/plugins/SkyboxesPlugin/SkyboxesPlugin.d.ts +1 -1
  26. package/types/plugins/StoreyViewsPlugin/StoreyViewsPlugin.d.ts +156 -149
  27. package/types/plugins/TreeViewPlugin/TreeViewPlugin.d.ts +20 -6
  28. package/types/plugins/ViewCullPlugin/ViewCullPlugin.d.ts +2 -2
  29. package/types/plugins/WebIFCLoaderPlugin/WebIFCLoaderPlugin.d.ts +16 -16
  30. package/types/plugins/XKTLoaderPlugin/XKTLoaderPlugin.d.ts +20 -20
  31. package/types/plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts +4 -4
  32. package/types/viewer/Plugin.d.ts +6 -6
  33. package/types/viewer/Viewer.d.ts +13 -13
  34. package/types/viewer/localization/LocaleService.d.ts +160 -153
  35. package/types/viewer/metadata/MetaModel.d.ts +2 -2
  36. package/types/viewer/metadata/MetaObject.d.ts +5 -5
  37. package/types/viewer/metadata/MetaScene.d.ts +11 -11
  38. package/types/viewer/metadata/index.d.ts +1 -1
  39. package/types/viewer/scene/CameraControl/CameraControl.d.ts +27 -19
  40. package/types/viewer/scene/Component.d.ts +6 -6
  41. package/types/viewer/scene/Entity.d.ts +29 -29
  42. package/types/viewer/scene/PerformanceModel/PerformanceModel.d.ts +45 -28
  43. package/types/viewer/scene/PerformanceModel/PerformanceNode.d.ts +26 -26
  44. package/types/viewer/scene/camera/Camera.d.ts +28 -28
  45. package/types/viewer/scene/camera/CameraFlightAnimation.d.ts +19 -19
  46. package/types/viewer/scene/camera/CustomProjection.d.ts +5 -5
  47. package/types/viewer/scene/camera/Frustum.d.ts +15 -15
  48. package/types/viewer/scene/camera/Ortho.d.ts +5 -5
  49. package/types/viewer/scene/camera/Perspective.d.ts +5 -5
  50. package/types/viewer/scene/index.d.ts +2 -1
  51. package/types/viewer/scene/marker/Marker.d.ts +15 -15
  52. package/types/viewer/scene/materials/EmphasisMaterial.d.ts +3 -3
  53. package/types/viewer/scene/materials/Fresnel.d.ts +2 -3
  54. package/types/viewer/scene/materials/LinesMaterial.d.ts +1 -1
  55. package/types/viewer/scene/materials/PhongMaterial.d.ts +26 -26
  56. package/types/viewer/scene/materials/PointsMaterial.d.ts +14 -14
  57. package/types/viewer/scene/materials/Texture.d.ts +14 -15
  58. package/types/viewer/scene/materials/index.d.ts +1 -0
  59. package/types/viewer/scene/math/math.d.ts +28 -28
  60. package/types/viewer/scene/mesh/Mesh.d.ts +786 -0
  61. package/types/viewer/scene/mesh/index.d.ts +1 -0
  62. package/types/viewer/scene/nodes/Node.d.ts +664 -0
  63. package/types/viewer/scene/nodes/index.d.ts +1 -0
  64. package/types/viewer/scene/scene/Scene.d.ts +155 -111
  65. package/types/viewer/scene/sectionPlane/SectionPlane.d.ts +3 -3
  66. package/types/viewer/scene/viewport/Viewport.d.ts +2 -2
  67. package/types/viewer/scene/webgl/PickResult.d.ts +2 -2
@@ -7,6 +7,23 @@ import { PerformanceNode } from "./PerformanceNode";
7
7
  * A high-performance model representation for efficient rendering and low memory usage.
8
8
  */
9
9
  export declare class PerformanceModel extends Component {
10
+
11
+ /**
12
+ * Fires when the model is loaded
13
+ * @param event The loaded event
14
+ * @param callback Called fired on the event
15
+ * @param scope Scope for the callback
16
+ */
17
+ on(event: "loaded", callback: (loaded: true) => void, scope?: any): string;
18
+
19
+ /**
20
+ * Fires when the loading the model has an error
21
+ * @param event The error event
22
+ * @param callback Called fired on the event
23
+ * @param scope Scope for the callback
24
+ */
25
+ on(event: "error", callback: (msg: string) => void, scope?: any): string;
26
+
10
27
  /**
11
28
  * Returns true to indicate that this Component is a PerformanceModel.
12
29
  * @type {Boolean}
@@ -132,8 +149,8 @@ export declare class PerformanceModel extends Component {
132
149
  /**
133
150
  * Returns ````true```` if this PerformanceModel represents a model.
134
151
  *
135
- * When ````true```` the PerformanceModel will be registered by {@link PerformanceModel#id} in
136
- * {@link Scene#models} and may also have a {@link MetaObject} with matching {@link MetaObject#id}.
152
+ * When ````true```` the PerformanceModel will be registered by {@link PerformanceModel.id} in
153
+ * {@link Scene.models} and may also have a {@link MetaObject} with matching {@link MetaObject.id}.
137
154
  *
138
155
  * @type {Boolean}
139
156
  */
@@ -180,7 +197,7 @@ export declare class PerformanceModel extends Component {
180
197
  /**
181
198
  * Gets if any {@link Entity}s in this PerformanceModel are visible.
182
199
  *
183
- * The PerformanceModel is only rendered when {@link PerformanceModel#visible} is ````true```` and {@link PerformanceModel#culled} is ````false````.
200
+ * The PerformanceModel is only rendered when {@link PerformanceModel.visible} is ````true```` and {@link PerformanceModel.culled} is ````false````.
184
201
  *
185
202
  * @type {Boolean}
186
203
  */
@@ -189,7 +206,7 @@ export declare class PerformanceModel extends Component {
189
206
  /**
190
207
  * Sets if this PerformanceModel is visible.
191
208
  *
192
- * The PerformanceModel is only rendered when {@link PerformanceModel#visible} is ````true```` and {@link PerformanceModel#culled} is ````false````.
209
+ * The PerformanceModel is only rendered when {@link PerformanceModel.visible} is ````true```` and {@link PerformanceModel.culled} is ````false````.
193
210
  **
194
211
  * @type {Boolean}
195
212
  */
@@ -254,7 +271,7 @@ export declare class PerformanceModel extends Component {
254
271
  /**
255
272
  * Gets if this PerformanceModel is culled from view.
256
273
  *
257
- * The PerformanceModel is only rendered when {@link PerformanceModel#visible} is true and {@link PerformanceModel#culled} is false.
274
+ * The PerformanceModel is only rendered when {@link PerformanceModel.visible} is true and {@link PerformanceModel.culled} is false.
258
275
  *
259
276
  * @type {Boolean}
260
277
  */
@@ -263,7 +280,7 @@ export declare class PerformanceModel extends Component {
263
280
  /**
264
281
  * Sets if this PerformanceModel is culled from view.
265
282
  *
266
- * The PerformanceModel is only rendered when {@link PerformanceModel#visible} is true and {@link PerformanceModel#culled} is false.
283
+ * The PerformanceModel is only rendered when {@link PerformanceModel.visible} is true and {@link PerformanceModel.culled} is false.
267
284
  *
268
285
  * @type {Boolean}
269
286
  */
@@ -272,7 +289,7 @@ export declare class PerformanceModel extends Component {
272
289
  /**
273
290
  * Gets if {@link Entity}s in this PerformanceModel are clippable.
274
291
  *
275
- * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
292
+ * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
276
293
  *
277
294
  * @type {Boolean}
278
295
  */
@@ -281,7 +298,7 @@ export declare class PerformanceModel extends Component {
281
298
  /**
282
299
  * Sets if {@link Entity}s in this PerformanceModel are clippable.
283
300
  *
284
- * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
301
+ * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
285
302
  *
286
303
  * @type {Boolean}
287
304
  */
@@ -304,7 +321,7 @@ export declare class PerformanceModel extends Component {
304
321
  /**
305
322
  * Gets if this PerformanceModel is pickable.
306
323
  *
307
- * Picking is done via calls to {@link Scene#pick}.
324
+ * Picking is done via calls to {@link Scene.pick}.
308
325
  *
309
326
  * @type {Boolean}
310
327
  */
@@ -313,7 +330,7 @@ export declare class PerformanceModel extends Component {
313
330
  /**
314
331
  * Sets if {@link Entity}s in this PerformanceModel are pickable.
315
332
  *
316
- * Picking is done via calls to {@link Scene#pick}.
333
+ * Picking is done via calls to {@link Scene.pick}.
317
334
  *
318
335
  * @type {Boolean}
319
336
  */
@@ -390,7 +407,7 @@ export declare class PerformanceModel extends Component {
390
407
  *
391
408
  * SAO is configured by the Scene's {@link SAO} component.
392
409
  *
393
- * Only works when {@link SAO#enabled} is also true.
410
+ * Only works when {@link SAO.enabled} is also true.
394
411
  *
395
412
  * @type {Boolean}
396
413
  */
@@ -399,7 +416,7 @@ export declare class PerformanceModel extends Component {
399
416
  /**
400
417
  * Gets if physically-based rendering (PBR) is enabled for this PerformanceModel.
401
418
  *
402
- * Only works when {@link Scene#pbrEnabled} is also true.
419
+ * Only works when {@link Scene.pbrEnabled} is also true.
403
420
  *
404
421
  * @type {Boolean}
405
422
  */
@@ -415,7 +432,7 @@ export declare class PerformanceModel extends Component {
415
432
  /**
416
433
  * Configures the appearance of xrayed {@link Entity}s within this PerformanceModel.
417
434
  *
418
- * This is the {@link Scene#xrayMaterial}.
435
+ * This is the {@link Scene.xrayMaterial}.
419
436
  *
420
437
  * @type {EmphasisMaterial}
421
438
  */
@@ -424,7 +441,7 @@ export declare class PerformanceModel extends Component {
424
441
  /**
425
442
  * Configures the appearance of highlighted {@link Entity}s within this PerformanceModel.
426
443
  *
427
- * This is the {@link Scene#highlightMaterial}.
444
+ * This is the {@link Scene.highlightMaterial}.
428
445
  *
429
446
  * @type {EmphasisMaterial}
430
447
  */
@@ -433,7 +450,7 @@ export declare class PerformanceModel extends Component {
433
450
  /**
434
451
  * Configures the appearance of selected {@link Entity}s within this PerformanceModel.
435
452
  *
436
- * This is the {@link Scene#selectedMaterial}.
453
+ * This is the {@link Scene.selectedMaterial}.
437
454
  *
438
455
  * @type {EmphasisMaterial}
439
456
  */
@@ -442,7 +459,7 @@ export declare class PerformanceModel extends Component {
442
459
  /**
443
460
  * Configures the appearance of edges of {@link Entity}s within this PerformanceModel.
444
461
  *
445
- * This is the {@link Scene#edgeMaterial}.
462
+ * This is the {@link Scene.edgeMaterial}.
446
463
  *
447
464
  * @type {EdgeMaterial}
448
465
  */
@@ -451,7 +468,7 @@ export declare class PerformanceModel extends Component {
451
468
  /**
452
469
  * Creates a reusable geometry within this PerformanceModel.
453
470
  *
454
- * We can then supply the geometry ID to {@link PerformanceModel#createMesh} when we want to create meshes that instance the geometry.
471
+ * We can then supply the geometry ID to {@link PerformanceModel.createMesh} when we want to create meshes that instance the geometry.
455
472
  *
456
473
  * If provide a ````positionsDecodeMatrix```` , then ````createGeometry()```` will assume
457
474
  * that the ````positions```` and ````normals```` arrays are compressed. When compressed, ````positions```` will be
@@ -460,7 +477,7 @@ export declare class PerformanceModel extends Component {
460
477
  * Note that ````positions````, ````normals```` and ````indices```` are all required together.
461
478
  *
462
479
  * @param {*} cfg Geometry properties.
463
- * @param {String|Number} cfg.id Mandatory ID for the geometry, to refer to with {@link PerformanceModel#createMesh}.
480
+ * @param {String|Number} cfg.id Mandatory ID for the geometry, to refer to with {@link PerformanceModel.createMesh}.
464
481
  * @param {String} cfg.primitive The primitive type. Accepted values are 'points', 'lines', 'triangles', 'solid' and 'surface'.
465
482
  * @param {Number[]} cfg.positions Flat array of positions.
466
483
  * @param {Number[]} [cfg.normals] Flat array of normal vectors. Only used with 'triangles' primitives. When no normals are given, the geometry will be flat shaded using auto-generated face-aligned normals.
@@ -469,7 +486,7 @@ export declare class PerformanceModel extends Component {
469
486
  * @param {Number[]} [cfg.indices] Array of indices. Not required for `points` primitives.
470
487
  * @param {Number[]} [cfg.edgeIndices] Array of edge line indices. Used only for Required for 'triangles' primitives. These are automatically generated internally if not supplied, using the ````edgeThreshold```` given to the ````PerformanceModel```` constructor.
471
488
  * @param {Number[]} [cfg.positionsDecodeMatrix] A 4x4 matrix for decompressing ````positions````.
472
- * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link PerformanceModel#origin}. When this is given, then every mesh created with {@link PerformanceModel#createMesh} that uses this geometry will
489
+ * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link PerformanceModel.origin}. When this is given, then every mesh created with {@link PerformanceModel.createMesh} that uses this geometry will
473
490
  * be transformed relative to this origin.
474
491
  */
475
492
  createGeometry(cfg: {
@@ -491,7 +508,7 @@ export declare class PerformanceModel extends Component {
491
508
  * A mesh can either share geometry with other meshes, or have its own unique geometry.
492
509
  *
493
510
  * To share a geometry with other meshes, provide the ID of a geometry created earlier
494
- * with {@link PerformanceModel#createGeometry}.
511
+ * with {@link PerformanceModel.createGeometry}.
495
512
  *
496
513
  * To create unique geometry for the mesh, provide geometry data arrays.
497
514
  *
@@ -515,14 +532,14 @@ export declare class PerformanceModel extends Component {
515
532
  *
516
533
  * @param {object} cfg Object properties.
517
534
  * @param {String} cfg.id Mandatory ID for the new mesh. Must not clash with any existing components within the {@link Scene}.
518
- * @param {String|Number} [cfg.geometryId] ID of a geometry to instance, previously created with {@link PerformanceModel#createGeometry:method"}}createMesh(){{/crossLink}}. Overrides all other geometry parameters given to this method.
535
+ * @param {String|Number} [cfg.geometryId] ID of a geometry to instance, previously created with {@link PerformanceModel.createGeometry:method"}}createMesh(){{/crossLink}}. Overrides all other geometry parameters given to this method.
519
536
  * @param {String} [cfg.primitive="triangles"] Geometry primitive type. Ignored when ````geometryId```` is given. Accepted values are 'points', 'lines' and 'triangles'.
520
537
  * @param {Number[]} [cfg.positions] Flat array of vertex positions. Ignored when ````geometryId```` is given.
521
538
  * @param {Number[]} [cfg.colors] Flat array of RGB vertex colors as float values in range ````[0..1]````. Ignored when ````geometryId```` is given, overriden by ````color```` and ````colorsCompressed````.
522
539
  * @param {Number[]} [cfg.colorsCompressed] Flat array of RGB vertex colors as unsigned short integers in range ````[0..255]````. Ignored when ````geometryId```` is given, overrides ````colors```` and is overriden by ````color````.
523
540
  * @param {Number[]} [cfg.normals] Flat array of normal vectors. Only used with 'triangles' primitives. When no normals are given, the mesh will be flat shaded using auto-generated face-aligned normals.
524
541
  * @param {Number[]} [cfg.positionsDecodeMatrix] A 4x4 matrix for decompressing ````positions````.
525
- * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link PerformanceModel#origin}. When this is given, then ````positions```` are assumed to be relative to this.
542
+ * @param {Number[]} [cfg.origin] Optional geometry origin, relative to {@link PerformanceModel.origin}. When this is given, then ````positions```` are assumed to be relative to this.
526
543
  * @param {Number[]} [cfg.indices] Array of triangle indices. Ignored when ````geometryId```` is given.
527
544
  * @param {Number[]} [cfg.edgeIndices] Array of edge line indices. If ````geometryId```` is not given, edge line indices are
528
545
  * automatically generated internally if not given, using the ````edgeThreshold```` given to the ````PerformanceModel````
@@ -555,7 +572,7 @@ export declare class PerformanceModel extends Component {
555
572
  }): void;
556
573
 
557
574
  /**
558
- * Creates an {@link Entity} within this PerformanceModel, giving it one or more meshes previously created with {@link PerformanceModel#createMesh}.
575
+ * Creates an {@link Entity} within this PerformanceModel, giving it one or more meshes previously created with {@link PerformanceModel.createMesh}.
559
576
  *
560
577
  * A mesh can only belong to one {@link Entity}, so you'll get an error if you try to reuse a mesh among multiple {@link Entity}s.
561
578
  *
@@ -563,7 +580,7 @@ export declare class PerformanceModel extends Component {
563
580
  * @param {String} cfg.id Optional ID for the new Entity. Must not clash with any existing components within the {@link Scene}.
564
581
  * @param {String[]} cfg.meshIds IDs of one or more meshes created previously with {@link PerformanceModel@createMesh}.
565
582
 
566
- * @param {Boolean} [cfg.isObject] Set ````true```` if the {@link Entity} represents an object, in which case it will be registered by {@link Entity#id} in {@link Scene#objects} and can also have a corresponding {@link MetaObject} with matching {@link MetaObject#id}, registered by that ID in {@link MetaScene#metaObjects}.
583
+ * @param {Boolean} [cfg.isObject] Set ````true```` if the {@link Entity} represents an object, in which case it will be registered by {@link Entity.id} in {@link Scene.objects} and can also have a corresponding {@link MetaObject} with matching {@link MetaObject.id}, registered by that ID in {@link MetaScene.metaObjects}.
567
584
  * @param {Boolean} [cfg.visible=true] Indicates if the Entity is initially visible.
568
585
  * @param {Boolean} [cfg.culled=false] Indicates if the Entity is initially culled from view.
569
586
  * @param {Boolean} [cfg.pickable=true] Indicates if the Entity is initially pickable.
@@ -571,10 +588,10 @@ export declare class PerformanceModel extends Component {
571
588
  * @param {Boolean} [cfg.collidable=true] Indicates if the Entity is initially included in boundary calculations.
572
589
  * @param {Boolean} [cfg.castsShadow=true] Indicates if the Entity initially casts shadows.
573
590
  * @param {Boolean} [cfg.receivesShadow=true] Indicates if the Entity initially receives shadows.
574
- * @param {Boolean} [cfg.xrayed=false] Indicates if the Entity is initially xrayed. XRayed appearance is configured by {@link PerformanceModel#xrayMaterial}.
575
- * @param {Boolean} [cfg.highlighted=false] Indicates if the Entity is initially highlighted. Highlighted appearance is configured by {@link PerformanceModel#highlightMaterial}.
576
- * @param {Boolean} [cfg.selected=false] Indicates if the Entity is initially selected. Selected appearance is configured by {@link PerformanceModel#selectedMaterial}.
577
- * @param {Boolean} [cfg.edges=false] Indicates if the Entity's edges are initially emphasized. Edges appearance is configured by {@link PerformanceModel#edgeMaterial}.
591
+ * @param {Boolean} [cfg.xrayed=false] Indicates if the Entity is initially xrayed. XRayed appearance is configured by {@link PerformanceModel.xrayMaterial}.
592
+ * @param {Boolean} [cfg.highlighted=false] Indicates if the Entity is initially highlighted. Highlighted appearance is configured by {@link PerformanceModel.highlightMaterial}.
593
+ * @param {Boolean} [cfg.selected=false] Indicates if the Entity is initially selected. Selected appearance is configured by {@link PerformanceModel.selectedMaterial}.
594
+ * @param {Boolean} [cfg.edges=false] Indicates if the Entity's edges are initially emphasized. Edges appearance is configured by {@link PerformanceModel.edgeMaterial}.
578
595
  * @returns {PerformanceNode}
579
596
  */
580
597
  createEntity(cfg: {
@@ -15,8 +15,8 @@ export declare class PerformanceNode {
15
15
  /**
16
16
  * Returns ````true```` if this PerformanceNode represents an object.
17
17
  *
18
- * When ````true```` the PerformanceNode will be registered by {@link PerformanceNode#id} in
19
- * {@link Scene#objects} and may also have a {@link MetaObject} with matching {@link MetaObject#id}.
18
+ * When ````true```` the PerformanceNode will be registered by {@link PerformanceNode.id} in
19
+ * {@link Scene.objects} and may also have a {@link MetaObject} with matching {@link MetaObject.id}.
20
20
  *
21
21
  * @type {Boolean}
22
22
  */
@@ -42,10 +42,10 @@ export declare class PerformanceNode {
42
42
  /**
43
43
  * Gets if this PerformanceNode is visible.
44
44
  *
45
- * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
45
+ * Only rendered when {@link PerformanceNode.visible} is ````true```` and {@link PerformanceNode.culled} is ````false````.
46
46
  *
47
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#visible} are ````true```` the PerformanceNode will be
48
- * registered by {@link PerformanceNode#id} in {@link Scene#visibleObjects}.
47
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.visible} are ````true```` the PerformanceNode will be
48
+ * registered by {@link PerformanceNode.id} in {@link Scene.visibleObjects}.
49
49
  *
50
50
  * @type {Boolean}
51
51
  */
@@ -54,10 +54,10 @@ export declare class PerformanceNode {
54
54
  /**
55
55
  * Sets if this PerformanceNode is visible.
56
56
  *
57
- * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
57
+ * Only rendered when {@link PerformanceNode.visible} is ````true```` and {@link PerformanceNode.culled} is ````false````.
58
58
  *
59
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#visible} are ````true```` the PerformanceNode will be
60
- * registered by {@link PerformanceNode#id} in {@link Scene#visibleObjects}.
59
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.visible} are ````true```` the PerformanceNode will be
60
+ * registered by {@link PerformanceNode.id} in {@link Scene.visibleObjects}.
61
61
  *
62
62
  * @type {Boolean}
63
63
  */
@@ -66,8 +66,8 @@ export declare class PerformanceNode {
66
66
  /**
67
67
  * Gets if this PerformanceNode is highlighted.
68
68
  *
69
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#highlighted} are ````true```` the PerformanceNode will be
70
- * registered by {@link PerformanceNode#id} in {@link Scene#highlightedObjects}.
69
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.highlighted} are ````true```` the PerformanceNode will be
70
+ * registered by {@link PerformanceNode.id} in {@link Scene.highlightedObjects}.
71
71
  *
72
72
  * @type {Boolean}
73
73
  */
@@ -76,8 +76,8 @@ export declare class PerformanceNode {
76
76
  /**
77
77
  * Sets if this PerformanceNode is highlighted.
78
78
  *
79
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#highlighted} are ````true```` the PerformanceNode will be
80
- * registered by {@link PerformanceNode#id} in {@link Scene#highlightedObjects}.
79
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.highlighted} are ````true```` the PerformanceNode will be
80
+ * registered by {@link PerformanceNode.id} in {@link Scene.highlightedObjects}.
81
81
  *
82
82
  * @type {Boolean}
83
83
  */
@@ -86,8 +86,8 @@ export declare class PerformanceNode {
86
86
  /**
87
87
  * Gets if this PerformanceNode is xrayed.
88
88
  *
89
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#xrayed} are ````true```` the PerformanceNode will be
90
- * registered by {@link PerformanceNode#id} in {@link Scene#xrayedObjects}.
89
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.xrayed} are ````true```` the PerformanceNode will be
90
+ * registered by {@link PerformanceNode.id} in {@link Scene.xrayedObjects}.
91
91
  *
92
92
  * @type {Boolean}
93
93
  */
@@ -96,8 +96,8 @@ export declare class PerformanceNode {
96
96
  /**
97
97
  * Sets if this PerformanceNode is xrayed.
98
98
  *
99
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#xrayed} are ````true```` the PerformanceNode will be
100
- * registered by {@link PerformanceNode#id} in {@link Scene#xrayedObjects}.
99
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.xrayed} are ````true```` the PerformanceNode will be
100
+ * registered by {@link PerformanceNode.id} in {@link Scene.xrayedObjects}.
101
101
  *
102
102
  * @type {Boolean}
103
103
  */
@@ -106,8 +106,8 @@ export declare class PerformanceNode {
106
106
  /**
107
107
  * Sets if this PerformanceNode is selected.
108
108
  *
109
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#selected} are ````true```` the PerformanceNode will be
110
- * registered by {@link PerformanceNode#id} in {@link Scene#selectedObjects}.
109
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.selected} are ````true```` the PerformanceNode will be
110
+ * registered by {@link PerformanceNode.id} in {@link Scene.selectedObjects}.
111
111
  *
112
112
  * @type {Boolean}
113
113
  */
@@ -116,8 +116,8 @@ export declare class PerformanceNode {
116
116
  /**
117
117
  * Gets if this PerformanceNode is selected.
118
118
  *
119
- * When both {@link PerformanceNode#isObject} and {@link PerformanceNode#selected} are ````true```` the PerformanceNode will be
120
- * registered by {@link PerformanceNode#id} in {@link Scene#selectedObjects}.
119
+ * When both {@link PerformanceNode.isObject} and {@link PerformanceNode.selected} are ````true```` the PerformanceNode will be
120
+ * registered by {@link PerformanceNode.id} in {@link Scene.selectedObjects}.
121
121
  *
122
122
  * @type {Boolean}
123
123
  */
@@ -140,7 +140,7 @@ export declare class PerformanceNode {
140
140
  /**
141
141
  * Gets if this PerformanceNode is culled.
142
142
  *
143
- * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
143
+ * Only rendered when {@link PerformanceNode.visible} is ````true```` and {@link PerformanceNode.culled} is ````false````.
144
144
  *
145
145
  * @type {Boolean}
146
146
  */
@@ -149,7 +149,7 @@ export declare class PerformanceNode {
149
149
  /**
150
150
  * Sets if this PerformanceNode is culled.
151
151
  *
152
- * Only rendered when {@link PerformanceNode#visible} is ````true```` and {@link PerformanceNode#culled} is ````false````.
152
+ * Only rendered when {@link PerformanceNode.visible} is ````true```` and {@link PerformanceNode.culled} is ````false````.
153
153
  *
154
154
  * @type {Boolean}
155
155
  */
@@ -158,7 +158,7 @@ export declare class PerformanceNode {
158
158
  /**
159
159
  * Gets if this PerformanceNode is clippable.
160
160
  *
161
- * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
161
+ * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
162
162
  *
163
163
  * @type {Boolean}
164
164
  */
@@ -167,7 +167,7 @@ export declare class PerformanceNode {
167
167
  /**
168
168
  * Sets if this PerformanceNode is clippable.
169
169
  *
170
- * Clipping is done by the {@link SectionPlane}s in {@link Scene#sectionPlanes}.
170
+ * Clipping is done by the {@link SectionPlane}s in {@link Scene.sectionPlanes}.
171
171
  *
172
172
  * @type {Boolean}
173
173
  */
@@ -190,7 +190,7 @@ export declare class PerformanceNode {
190
190
  /**
191
191
  * Gets if this PerformanceNode is pickable.
192
192
  *
193
- * Picking is done via calls to {@link Scene#pick}.
193
+ * Picking is done via calls to {@link Scene.pick}.
194
194
  *
195
195
  * @type {Boolean}
196
196
  */
@@ -199,7 +199,7 @@ export declare class PerformanceNode {
199
199
  /**
200
200
  * Sets if this PerformanceNode is pickable.
201
201
  *
202
- * Picking is done via calls to {@link Scene#pick}.
202
+ * Picking is done via calls to {@link Scene.pick}.
203
203
  *
204
204
  * @type {Boolean}
205
205
  */
@@ -9,7 +9,7 @@ import { CustomProjection } from "./CustomProjection";
9
9
  */
10
10
  export declare class Camera extends Component {
11
11
  /**
12
- * Sets an optional matrix to premultiply into {@link Camera#matrix} matrix.
12
+ * Sets an optional matrix to premultiply into {@link Camera.matrix} matrix.
13
13
  *
14
14
  * This is intended to be used for stereo rendering with WebVR etc.
15
15
  *
@@ -18,7 +18,7 @@ export declare class Camera extends Component {
18
18
  set deviceMatrix(arg: number[]);
19
19
 
20
20
  /**
21
- * Gets an optional matrix to premultiply into {@link Camera#matrix} matrix.
21
+ * Gets an optional matrix to premultiply into {@link Camera.matrix} matrix.
22
22
  *
23
23
  * @returns {Number[]} The matrix.
24
24
  */
@@ -64,7 +64,7 @@ export declare class Camera extends Component {
64
64
  get look(): number[];
65
65
 
66
66
  /**
67
- * Sets the direction of this Camera's {@link Camera#up} vector.
67
+ * Sets the direction of this Camera's {@link Camera.up} vector.
68
68
  *
69
69
  * @emits "up" event on change, with the value of this property.
70
70
  *
@@ -73,7 +73,7 @@ export declare class Camera extends Component {
73
73
  set up(arg: number[]);
74
74
 
75
75
  /**
76
- * Gets the direction of this Camera's {@link Camera#up} vector.
76
+ * Gets the direction of this Camera's {@link Camera.up} vector.
77
77
  *
78
78
  * @returns {Number[]} Direction of "up".
79
79
  */
@@ -104,7 +104,7 @@ export declare class Camera extends Component {
104
104
  /**
105
105
  * Sets whether to lock yaw rotation to pivot about the World-space "up" axis.
106
106
  *
107
- * Fires a {@link Camera#gimbalLock:event} event on change.
107
+ * Fires a {@link Camera.gimbalLock:event} event on change.
108
108
  *
109
109
  * @params {Boolean} gimbalLock Set true to lock gimbal.
110
110
  */
@@ -140,28 +140,28 @@ export declare class Camera extends Component {
140
140
  get projection(): "perspective" | "ortho" | "frustum" | "customProjection";
141
141
 
142
142
  /**
143
- * Rotates {@link Camera#eye} about {@link Camera#look}, around the {@link Camera#up} vector
143
+ * Rotates {@link Camera.eye} about {@link Camera.look}, around the {@link Camera.up} vector
144
144
  *
145
145
  * @param {Number} angleInc Angle of rotation in degrees
146
146
  */
147
147
  orbitYaw(angleInc: number): void;
148
148
 
149
149
  /**
150
- * Rotates {@link Camera#eye} about {@link Camera#look} around the right axis (orthogonal to {@link Camera#up} and "look").
150
+ * Rotates {@link Camera.eye} about {@link Camera.look} around the right axis (orthogonal to {@link Camera.up} and "look").
151
151
  *
152
152
  * @param {Number} angleInc Angle of rotation in degrees
153
153
  */
154
154
  orbitPitch(angleInc: number): void;
155
155
 
156
156
  /**
157
- * Rotates {@link Camera#look} about {@link Camera#eye}, around the {@link Camera#up} vector.
157
+ * Rotates {@link Camera.look} about {@link Camera.eye}, around the {@link Camera.up} vector.
158
158
  *
159
159
  * @param {Number} angleInc Angle of rotation in degrees
160
160
  */
161
161
  yaw(angleInc: number): void;
162
162
 
163
163
  /**
164
- * Rotates {@link Camera#look} about {@link Camera#eye}, around the right axis (orthogonal to {@link Camera#up} and "look").
164
+ * Rotates {@link Camera.look} about {@link Camera.eye}, around the right axis (orthogonal to {@link Camera.up} and "look").
165
165
  *
166
166
  * @param {Number} angleInc Angle of rotation in degrees
167
167
  */
@@ -175,7 +175,7 @@ export declare class Camera extends Component {
175
175
  pan(pan: number[]): void;
176
176
 
177
177
  /**
178
- * Increments/decrements the Camera's zoom factor, which is the distance between {@link Camera#eye} and {@link Camera#look}.
178
+ * Increments/decrements the Camera's zoom factor, which is the distance between {@link Camera.eye} and {@link Camera.look}.
179
179
  *
180
180
  * @param {Number} delta Zoom factor increment.
181
181
  */
@@ -184,7 +184,7 @@ export declare class Camera extends Component {
184
184
  /**
185
185
  * Gets the direction of World-space "up".
186
186
  *
187
- * This is set by {@link Camera#worldAxis}.
187
+ * This is set by {@link Camera.worldAxis}.
188
188
  *
189
189
  * Default value is ````[0,1,0]````.
190
190
  *
@@ -213,7 +213,7 @@ export declare class Camera extends Component {
213
213
  /**
214
214
  * Gets the direction of World-space "right".
215
215
  *
216
- * This is set by {@link Camera#worldAxis}.
216
+ * This is set by {@link Camera.worldAxis}.
217
217
  *
218
218
  * Default value is ````[1,0,0]````.
219
219
  *
@@ -224,7 +224,7 @@ export declare class Camera extends Component {
224
224
  /**
225
225
  * Gets the direction of World-space "forwards".
226
226
  *
227
- * This is set by {@link Camera#worldAxis}.
227
+ * This is set by {@link Camera.worldAxis}.
228
228
  *
229
229
  * Default value is ````[0,0,1]````.
230
230
  *
@@ -235,7 +235,7 @@ export declare class Camera extends Component {
235
235
  /**
236
236
  * Gets whether to prevent camera from being pitched upside down.
237
237
  *
238
- * The camera is upside down when the angle between {@link Camera#up} and {@link Camera#worldUp} is less than one degree.
238
+ * The camera is upside down when the angle between {@link Camera.up} and {@link Camera.worldUp} is less than one degree.
239
239
  *
240
240
  * Default value is ````false````.
241
241
  *
@@ -246,9 +246,9 @@ export declare class Camera extends Component {
246
246
  /**
247
247
  * Sets whether to prevent camera from being pitched upside down.
248
248
  *
249
- * The camera is upside down when the angle between {@link Camera#up} and {@link Camera#worldUp} is less than one degree.
249
+ * The camera is upside down when the angle between {@link Camera.up} and {@link Camera.worldUp} is less than one degree.
250
250
  *
251
- * Fires a {@link Camera#constrainPitch:event} event on change.
251
+ * Fires a {@link Camera.constrainPitch:event} event on change.
252
252
  *
253
253
  * Default value is ````false````.
254
254
  *
@@ -257,7 +257,7 @@ export declare class Camera extends Component {
257
257
  set constrainPitch(arg: boolean);
258
258
 
259
259
  /**
260
- * Gets distance from {@link Camera#look} to {@link Camera#eye}.
260
+ * Gets distance from {@link Camera.look} to {@link Camera.eye}.
261
261
  *
262
262
  * @returns {Number} The distance.
263
263
  */
@@ -266,7 +266,7 @@ export declare class Camera extends Component {
266
266
  /**
267
267
  * Gets the Camera's viewing transformation matrix.
268
268
  *
269
- * Fires a {@link Camera#matrix:event} event on change.
269
+ * Fires a {@link Camera.matrix:event} event on change.
270
270
  *
271
271
  * @returns {Number[]} The viewing transform matrix.
272
272
  */
@@ -275,7 +275,7 @@ export declare class Camera extends Component {
275
275
  /**
276
276
  * Gets the Camera's viewing transformation matrix.
277
277
  *
278
- * Fires a {@link Camera#matrix:event} event on change.
278
+ * Fires a {@link Camera.matrix:event} event on change.
279
279
  *
280
280
  * @returns {Number[]} The viewing transform matrix.
281
281
  */
@@ -284,7 +284,7 @@ export declare class Camera extends Component {
284
284
  /**
285
285
  * The Camera's viewing normal transformation matrix.
286
286
  *
287
- * Fires a {@link Camera#matrix:event} event on change.
287
+ * Fires a {@link Camera.matrix:event} event on change.
288
288
  *
289
289
  * @returns {Number[]} The viewing normal transform matrix.
290
290
  */
@@ -293,7 +293,7 @@ export declare class Camera extends Component {
293
293
  /**
294
294
  * The Camera's viewing normal transformation matrix.
295
295
  *
296
- * Fires a {@link Camera#matrix:event} event on change.
296
+ * Fires a {@link Camera.matrix:event} event on change.
297
297
  *
298
298
  * @returns {Number[]} The viewing normal transform matrix.
299
299
  */
@@ -302,7 +302,7 @@ export declare class Camera extends Component {
302
302
  /**
303
303
  * Gets the inverse of the Camera's viewing transform matrix.
304
304
  *
305
- * This has the same value as {@link Camera#normalMatrix}.
305
+ * This has the same value as {@link Camera.normalMatrix}.
306
306
  *
307
307
  * @returns {Number[]} The inverse viewing transform matrix.
308
308
  */
@@ -311,7 +311,7 @@ export declare class Camera extends Component {
311
311
  /**
312
312
  * Gets the Camera's projection transformation projMatrix.
313
313
  *
314
- * Fires a {@link Camera#projMatrix:event} event on change.
314
+ * Fires a {@link Camera.projMatrix:event} event on change.
315
315
  *
316
316
  * @returns {Number[]} The projection matrix.
317
317
  */
@@ -320,7 +320,7 @@ export declare class Camera extends Component {
320
320
  /**
321
321
  * Gets the Camera's perspective projection.
322
322
  *
323
- * The Camera uses this while {@link Camera#projection} equals ````perspective````.
323
+ * The Camera uses this while {@link Camera.projection} equals ````perspective````.
324
324
  *
325
325
  * @returns {Perspective} The Perspective component.
326
326
  */
@@ -329,7 +329,7 @@ export declare class Camera extends Component {
329
329
  /**
330
330
  * Gets the Camera's orthographic projection.
331
331
  *
332
- * The Camera uses this while {@link Camera#projection} equals ````ortho````.
332
+ * The Camera uses this while {@link Camera.projection} equals ````ortho````.
333
333
  *
334
334
  * @returns {Ortho} The Ortho component.
335
335
  */
@@ -338,7 +338,7 @@ export declare class Camera extends Component {
338
338
  /**
339
339
  * Gets the Camera's frustum projection.
340
340
  *
341
- * The Camera uses this while {@link Camera#projection} equals ````frustum````.
341
+ * The Camera uses this while {@link Camera.projection} equals ````frustum````.
342
342
  *
343
343
  * @returns {Frustum} The Ortho component.
344
344
  */
@@ -347,7 +347,7 @@ export declare class Camera extends Component {
347
347
  /**
348
348
  * Gets the Camera's custom projection.
349
349
  *
350
- * This is used while {@link Camera#projection} equals "customProjection".
350
+ * This is used while {@link Camera.projection} equals "customProjection".
351
351
  *
352
352
  * @returns {CustomProjection} The custom projection.
353
353
  */
@@ -356,7 +356,7 @@ export declare class Camera extends Component {
356
356
  /**
357
357
  * Gets the currently active projection for this Camera.
358
358
  *
359
- * The currently active project is selected with {@link Camera#projection}.
359
+ * The currently active project is selected with {@link Camera.projection}.
360
360
  *
361
361
  * @returns {Perspective|Ortho|Frustum|CustomProjection} The currently active projection is active.
362
362
  */