@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.
- package/dist/xeokit-sdk.cjs.js +16 -16
- package/dist/xeokit-sdk.es.js +16 -16
- package/package.json +7 -4
- package/types/extras/ContextMenu/ContextMenu.d.ts +8 -8
- package/types/plugins/AngleMeasurementsPlugin/AngleMeasurement.d.ts +1 -1
- package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsControl.d.ts +26 -1
- package/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.d.ts +76 -62
- package/types/plugins/AnnotationsPlugin/Annotation.d.ts +11 -10
- package/types/plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts +32 -18
- package/types/plugins/AnnotationsPlugin/index.d.ts +1 -0
- package/types/plugins/AxisGizmoPlugin/AxisGizmoPlugin.d.ts +1 -1
- package/types/plugins/BCFViewpointsPlugin/BCFViewpointsPlugin.d.ts +10 -10
- package/types/plugins/CityJSONLoaderPlugin/CityJSONLoaderPlugin.d.ts +2 -2
- package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.d.ts +6 -6
- package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsControl.d.ts +26 -1
- package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts +22 -7
- package/types/plugins/FastNavPlugin/FastNavPlugin.d.ts +9 -9
- package/types/plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts +8 -8
- package/types/plugins/LASLoaderPlugin/LASLoaderPlugin.d.ts +4 -4
- package/types/plugins/NavCubePlugin/NavCubePlugin.d.ts +6 -6
- package/types/plugins/OBJLoaderPlugin/OBJLoaderPlugin.d.ts +2 -2
- package/types/plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts +2 -2
- package/types/plugins/STLLoaderPlugin/index.d.ts +0 -1
- package/types/plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts +4 -4
- package/types/plugins/SkyboxesPlugin/SkyboxesPlugin.d.ts +1 -1
- package/types/plugins/StoreyViewsPlugin/StoreyViewsPlugin.d.ts +156 -149
- package/types/plugins/TreeViewPlugin/TreeViewPlugin.d.ts +20 -6
- package/types/plugins/ViewCullPlugin/ViewCullPlugin.d.ts +2 -2
- package/types/plugins/WebIFCLoaderPlugin/WebIFCLoaderPlugin.d.ts +16 -16
- package/types/plugins/XKTLoaderPlugin/XKTLoaderPlugin.d.ts +20 -20
- package/types/plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts +4 -4
- package/types/viewer/Plugin.d.ts +6 -6
- package/types/viewer/Viewer.d.ts +13 -13
- package/types/viewer/localization/LocaleService.d.ts +160 -153
- package/types/viewer/metadata/MetaModel.d.ts +2 -2
- package/types/viewer/metadata/MetaObject.d.ts +5 -5
- package/types/viewer/metadata/MetaScene.d.ts +11 -11
- package/types/viewer/metadata/index.d.ts +1 -1
- package/types/viewer/scene/CameraControl/CameraControl.d.ts +27 -19
- package/types/viewer/scene/Component.d.ts +6 -6
- package/types/viewer/scene/Entity.d.ts +29 -29
- package/types/viewer/scene/PerformanceModel/PerformanceModel.d.ts +45 -28
- package/types/viewer/scene/PerformanceModel/PerformanceNode.d.ts +26 -26
- package/types/viewer/scene/camera/Camera.d.ts +28 -28
- package/types/viewer/scene/camera/CameraFlightAnimation.d.ts +19 -19
- package/types/viewer/scene/camera/CustomProjection.d.ts +5 -5
- package/types/viewer/scene/camera/Frustum.d.ts +15 -15
- package/types/viewer/scene/camera/Ortho.d.ts +5 -5
- package/types/viewer/scene/camera/Perspective.d.ts +5 -5
- package/types/viewer/scene/index.d.ts +2 -1
- package/types/viewer/scene/marker/Marker.d.ts +15 -15
- package/types/viewer/scene/materials/EmphasisMaterial.d.ts +3 -3
- package/types/viewer/scene/materials/Fresnel.d.ts +2 -3
- package/types/viewer/scene/materials/LinesMaterial.d.ts +1 -1
- package/types/viewer/scene/materials/PhongMaterial.d.ts +26 -26
- package/types/viewer/scene/materials/PointsMaterial.d.ts +14 -14
- package/types/viewer/scene/materials/Texture.d.ts +14 -15
- package/types/viewer/scene/materials/index.d.ts +1 -0
- package/types/viewer/scene/math/math.d.ts +28 -28
- package/types/viewer/scene/mesh/Mesh.d.ts +786 -0
- package/types/viewer/scene/mesh/index.d.ts +1 -0
- package/types/viewer/scene/nodes/Node.d.ts +664 -0
- package/types/viewer/scene/nodes/index.d.ts +1 -0
- package/types/viewer/scene/scene/Scene.d.ts +155 -111
- package/types/viewer/scene/sectionPlane/SectionPlane.d.ts +3 -3
- package/types/viewer/scene/viewport/Viewport.d.ts +2 -2
- package/types/viewer/scene/webgl/PickResult.d.ts +2 -2
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { PickResult } from "viewer/scene/webgl/PickResult";
|
|
1
|
+
import { PickResult } from "../../viewer/scene/webgl/PickResult";
|
|
2
2
|
import { Entity, Plugin, Viewer } from "../../viewer";
|
|
3
3
|
import { Annotation } from "./Annotation";
|
|
4
4
|
|
|
5
5
|
export declare type AnnotationsPluginConfiguration = {
|
|
6
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
6
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
7
7
|
id?: string;
|
|
8
8
|
/** HTML text template for Annotation markers. Defaults to ````<div></div>````. Ignored on {@link Annotation}s configured with a ````markerElementId````. */
|
|
9
9
|
markerHTML?: string;
|
|
@@ -13,14 +13,14 @@ export declare type AnnotationsPluginConfiguration = {
|
|
|
13
13
|
container?: HTMLElement;
|
|
14
14
|
/** Map of default values to insert into the HTML templates for the marker and label. */
|
|
15
15
|
values?: { [key: string]: string | number };
|
|
16
|
-
/** The amount by which each {@link Annotation} is offset from the surface of its {@link Entity} when we create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin
|
|
16
|
+
/** The amount by which each {@link Annotation} is offset from the surface of its {@link Entity} when we create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin.createAnnotation}.*/
|
|
17
17
|
surfaceOffset?: number;
|
|
18
18
|
};
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* {@link Viewer} plugin that creates {@link Annotation}s.
|
|
22
22
|
*/
|
|
23
|
-
export class AnnotationsPlugin extends Plugin {
|
|
23
|
+
export declare class AnnotationsPlugin extends Plugin {
|
|
24
24
|
/**
|
|
25
25
|
* @constructor
|
|
26
26
|
* @param {Viewer} viewer The Viewer.
|
|
@@ -29,14 +29,14 @@ export class AnnotationsPlugin extends Plugin {
|
|
|
29
29
|
constructor(viewer: Viewer, cfg: AnnotationsPluginConfiguration);
|
|
30
30
|
|
|
31
31
|
/**
|
|
32
|
-
* The {@link Annotation}s created by {@link AnnotationsPlugin
|
|
32
|
+
* The {@link Annotation}s created by {@link AnnotationsPlugin.createAnnotation}, each mapped to its {@link Annotation.id}.
|
|
33
33
|
* @type {{String:Annotation}}
|
|
34
34
|
*/
|
|
35
35
|
annotations: { [key:string]: Annotation };
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
38
|
* Sets the amount by which each {@link Annotation} is offset from the surface of its {@link Entity}, when we
|
|
39
|
-
* create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin
|
|
39
|
+
* create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin.createAnnotation}.
|
|
40
40
|
*
|
|
41
41
|
* See the class comments for more info.
|
|
42
42
|
*
|
|
@@ -48,8 +48,8 @@ export class AnnotationsPlugin extends Plugin {
|
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
50
|
* Gets the amount by which an {@link Annotation} is offset from the surface of its {@link Entity} when
|
|
51
|
-
* created by {@link AnnotationsPlugin
|
|
52
|
-
* create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin
|
|
51
|
+
* created by {@link AnnotationsPlugin.createAnnotation}, when we
|
|
52
|
+
* create the Annotation by supplying a {@link PickResult} to {@link AnnotationsPlugin.createAnnotation}.
|
|
53
53
|
*
|
|
54
54
|
* This is ````0.3```` by default.
|
|
55
55
|
*
|
|
@@ -60,26 +60,26 @@ export class AnnotationsPlugin extends Plugin {
|
|
|
60
60
|
/**
|
|
61
61
|
* Creates an {@link Annotation}.
|
|
62
62
|
*
|
|
63
|
-
* The Annotation is then registered by {@link Annotation
|
|
63
|
+
* The Annotation is then registered by {@link Annotation.id} in {@link AnnotationsPlugin.annotations}.
|
|
64
64
|
*
|
|
65
65
|
* @param {Object} params Annotation configuration.
|
|
66
|
-
* @param {String} params.id Unique ID to assign to {@link Annotation
|
|
66
|
+
* @param {String} params.id Unique ID to assign to {@link Annotation.id}. The Annotation will be registered by this in {@link AnnotationsPlugin.annotations} and {@link Scene.components}. Must be unique among all components in the {@link Viewer}.
|
|
67
67
|
* @param {String} [params.markerElementId] ID of pre-existing DOM element to render the marker. This overrides ````markerHTML```` and does not support ````values```` (data is baked into the label DOM element).
|
|
68
68
|
* @param {String} [params.labelElementId] ID of pre-existing DOM element to render the label. This overrides ````labelHTML```` and does not support ````values```` (data is baked into the label DOM element).
|
|
69
69
|
* @param {String} [params.markerHTML] HTML text template for the Annotation marker. Defaults to the marker HTML given to the AnnotationsPlugin constructor. Ignored if you provide ````markerElementId````.
|
|
70
70
|
* @param {String} [params.labelHTML] HTML text template for the Annotation label. Defaults to the label HTML given to the AnnotationsPlugin constructor. Ignored if you provide ````labelElementId````.
|
|
71
|
-
* @param {Number[]} [params.worldPos=[0,0,0]] World-space position of the Annotation marker, assigned to {@link Annotation
|
|
72
|
-
* @param {Entity} [params.entity] Optional {@link Entity} to associate the Annotation with. Causes {@link Annotation
|
|
73
|
-
* @param {PickResult} [params.pickResult] Sets the Annotation's World-space position and direction vector from the given {@link PickResult}'s {@link PickResult
|
|
71
|
+
* @param {Number[]} [params.worldPos=[0,0,0]] World-space position of the Annotation marker, assigned to {@link Annotation.worldPos}.
|
|
72
|
+
* @param {Entity} [params.entity] Optional {@link Entity} to associate the Annotation with. Causes {@link Annotation.visible} to be ````false```` whenever {@link Entity.visible} is also ````false````.
|
|
73
|
+
* @param {PickResult} [params.pickResult] Sets the Annotation's World-space position and direction vector from the given {@link PickResult}'s {@link PickResult.worldPos} and {@link PickResult.worldNormal}, and the Annotation's Entity from {@link PickResult.entity}. Causes ````worldPos```` and ````entity```` parameters to be ignored, if they are also given.
|
|
74
74
|
* @param {Boolean} [params.occludable=false] Indicates whether or not the {@link Annotation} marker and label are hidden whenever the marker occluded by {@link Entity}s in the {@link Scene}. The
|
|
75
|
-
* {@link Scene} periodically occlusion-tests all Annotations on every 20th "tick" (which represents a rendered frame). We can adjust that frequency via property {@link Scene
|
|
75
|
+
* {@link Scene} periodically occlusion-tests all Annotations on every 20th "tick" (which represents a rendered frame). We can adjust that frequency via property {@link Scene.ticksPerOcclusionTest}.
|
|
76
76
|
* @param {{String:(String|Number)}} [params.values={}] Map of values to insert into the HTML templates for the marker and label. These will be inserted in addition to any values given to the AnnotationsPlugin constructor.
|
|
77
77
|
* @param {Boolean} [params.markerShown=true] Whether to initially show the {@link Annotation} marker.
|
|
78
78
|
* @param {Boolean} [params.labelShown=false] Whether to initially show the {@link Annotation} label.
|
|
79
|
-
* @param {Number[]} [params.eye] Optional World-space position for {@link Camera
|
|
80
|
-
* @param {Number[]} [params.look] Optional World-space position for {@link Camera
|
|
81
|
-
* @param {Number[]} [params.up] Optional World-space position for {@link Camera
|
|
82
|
-
* @param {String} [params.projection] Optional projection type for {@link Camera
|
|
79
|
+
* @param {Number[]} [params.eye] Optional World-space position for {@link Camera.eye}, used when this Annotation is associated with a {@link Camera} position.
|
|
80
|
+
* @param {Number[]} [params.look] Optional World-space position for {@link Camera.look}, used when this Annotation is associated with a {@link Camera} position.
|
|
81
|
+
* @param {Number[]} [params.up] Optional World-space position for {@link Camera.up}, used when this Annotation is associated with a {@link Camera} position.
|
|
82
|
+
* @param {String} [params.projection] Optional projection type for {@link Camera.projection}, used when this Annotation is associated with a {@link Camera} position.
|
|
83
83
|
* @returns {Annotation} The new {@link Annotation}.
|
|
84
84
|
*/
|
|
85
85
|
createAnnotation(params: {
|
|
@@ -114,4 +114,18 @@ export class AnnotationsPlugin extends Plugin {
|
|
|
114
114
|
* Destroys all {@link Annotation}s.
|
|
115
115
|
*/
|
|
116
116
|
clear(): void;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Fires when a annotation is created.
|
|
120
|
+
* @param {String} event The annotationCreated event
|
|
121
|
+
* @param {Function} callback Callback fired on the event
|
|
122
|
+
*/
|
|
123
|
+
on(event: "annotationCreated", callback: (annotationId: string)=> void): void;
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Fires when a annotation is destroyed.
|
|
127
|
+
* @param {String} event The annotationDestroyed event
|
|
128
|
+
* @param {Function} callback Callback fired on the event
|
|
129
|
+
*/
|
|
130
|
+
on(event: "annotationDestroyed", callback: (annotationId: string)=> void): void;
|
|
117
131
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Plugin, Viewer } from "../../viewer";
|
|
2
2
|
|
|
3
3
|
export declare type AxisGizmoPluginConfiguration = {
|
|
4
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
4
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
5
5
|
id?: string;
|
|
6
6
|
/** ID of an existing HTML canvas to display the AxisGizmo - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID. */
|
|
7
7
|
canvasId?: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Plugin, Viewer } from "../../viewer";
|
|
2
2
|
|
|
3
3
|
export declare type BCFViewpointsPluginConfiguration = {
|
|
4
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
4
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
5
5
|
id?: string;
|
|
6
6
|
/** Identifies the originating system for BCF records. */
|
|
7
7
|
originatingSystem?: string;
|
|
@@ -12,7 +12,7 @@ export declare type BCFViewpointsPluginConfiguration = {
|
|
|
12
12
|
/**
|
|
13
13
|
* {@link Viewer} plugin that saves and loads BCF viewpoints as JSON objects.
|
|
14
14
|
*/
|
|
15
|
-
export class BCFViewpointsPlugin extends Plugin {
|
|
15
|
+
export declare class BCFViewpointsPlugin extends Plugin {
|
|
16
16
|
/**
|
|
17
17
|
* @constructor
|
|
18
18
|
* @param {Viewer} viewer The Viewer.
|
|
@@ -35,8 +35,8 @@ export class BCFViewpointsPlugin extends Plugin {
|
|
|
35
35
|
/**
|
|
36
36
|
* Saves viewer state to a BCF viewpoint.
|
|
37
37
|
*
|
|
38
|
-
* Note that xeokit's {@link Camera
|
|
39
|
-
* direction vector. Therefore, we save ````camera_direction```` as the vector from {@link Camera
|
|
38
|
+
* Note that xeokit's {@link Camera.look} is the **point-of-interest**, whereas the BCF ````camera_direction```` is a
|
|
39
|
+
* direction vector. Therefore, we save ````camera_direction```` as the vector from {@link Camera.eye} to {@link Camera.look}.
|
|
40
40
|
*
|
|
41
41
|
* @param {*} [options] Options for getting the viewpoint.
|
|
42
42
|
* @param {Boolean} [options.spacesVisible=false] Indicates whether ````IfcSpace```` types should be forced visible in the viewpoint.
|
|
@@ -122,22 +122,22 @@ export class BCFViewpointsPlugin extends Plugin {
|
|
|
122
122
|
/**
|
|
123
123
|
* Sets viewer state to the given BCF viewpoint.
|
|
124
124
|
*
|
|
125
|
-
* Note that xeokit's {@link Camera
|
|
126
|
-
* direction vector. Therefore, when loading a BCF viewpoint, we set {@link Camera
|
|
125
|
+
* Note that xeokit's {@link Camera.look} is the **point-of-interest**, whereas the BCF ````camera_direction```` is a
|
|
126
|
+
* direction vector. Therefore, when loading a BCF viewpoint, we set {@link Camera.look} to the absolute position
|
|
127
127
|
* obtained by offsetting the BCF ````camera_view_point```` along ````camera_direction````.
|
|
128
128
|
*
|
|
129
|
-
* When loading a viewpoint, we also have the option to find {@link Camera
|
|
129
|
+
* When loading a viewpoint, we also have the option to find {@link Camera.look} as the closest point of intersection
|
|
130
130
|
* (on the surface of any visible and pickable {@link Entity}) with a 3D ray fired from ````camera_view_point```` in
|
|
131
131
|
* the direction of ````camera_direction````.
|
|
132
132
|
*
|
|
133
133
|
* @param {*} bcfViewpoint BCF JSON viewpoint object,
|
|
134
134
|
* shows default visible entities and restores camera to initial default position.
|
|
135
135
|
* @param {*} [options] Options for setting the viewpoint.
|
|
136
|
-
* @param {Boolean} [options.rayCast=true] When ````true```` (default), will attempt to set {@link Camera
|
|
136
|
+
* @param {Boolean} [options.rayCast=true] When ````true```` (default), will attempt to set {@link Camera.look} to the closest
|
|
137
137
|
* point of surface intersection with a ray fired from the BCF ````camera_view_point```` in the direction of ````camera_direction````.
|
|
138
138
|
* @param {Boolean} [options.immediate=true] When ````true```` (default), immediately set camera position.
|
|
139
|
-
* @param {Boolean} [options.duration] Flight duration in seconds. Overrides {@link CameraFlightAnimation
|
|
140
|
-
* @param {Boolean} [options.reset=true] When ````true```` (default), set {@link Entity
|
|
139
|
+
* @param {Boolean} [options.duration] Flight duration in seconds. Overrides {@link CameraFlightAnimation.duration}. Only applies when ````immediate```` is ````false````.
|
|
140
|
+
* @param {Boolean} [options.reset=true] When ````true```` (default), set {@link Entity.xrayed} and {@link Entity.highlighted} ````false```` on all scene objects.
|
|
141
141
|
* @param {Boolean} [options.reverseClippingPlanes=false] When ````true````, clipping planes are reversed (https://github.com/buildingSMART/BCF-XML/issues/193)
|
|
142
142
|
* @param {Boolean} [options.updateCompositeObjects=false] When ````true````, then when visibility and selection updates refer to composite objects (eg. an IfcBuildingStorey),
|
|
143
143
|
* then this method will apply the updates to objects within those composites.
|
|
@@ -13,14 +13,14 @@ export declare interface ICityJSONDefaultDataSource {
|
|
|
13
13
|
}
|
|
14
14
|
|
|
15
15
|
export declare type CityJSONLoaderPluginConfiguration = {
|
|
16
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
16
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
17
17
|
id?: string;
|
|
18
18
|
/** A custom data source through which the CityJSONLoaderPlugin can load model and metadata files. Defaults to an instance of {@link CityJSONDefaultDataSource}, which loads over HTTP.*/
|
|
19
19
|
dataSource?: ICityJSONDefaultDataSource;
|
|
20
20
|
};
|
|
21
21
|
|
|
22
22
|
export declare type LoadCityJSONModel = {
|
|
23
|
-
/** ID to assign to the root {@link Entity
|
|
23
|
+
/** ID to assign to the root {@link Entity.id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
|
|
24
24
|
id?: string;
|
|
25
25
|
/** Path to a CityJSON file, as an alternative to the ````cityJSON```` parameter. */
|
|
26
26
|
src?: string;
|
|
@@ -5,7 +5,7 @@ import { Marker } from "../../viewer/scene/marker";
|
|
|
5
5
|
/**
|
|
6
6
|
* @desc Measures the distance between two 3D points.
|
|
7
7
|
*/
|
|
8
|
-
export class DistanceMeasurement extends Component {
|
|
8
|
+
export declare class DistanceMeasurement extends Component {
|
|
9
9
|
/**
|
|
10
10
|
* The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurement.
|
|
11
11
|
* @type {DistanceMeasurementsPlugin}
|
|
@@ -73,28 +73,28 @@ export class DistanceMeasurement extends Component {
|
|
|
73
73
|
get targetVisible(): boolean;
|
|
74
74
|
|
|
75
75
|
/**
|
|
76
|
-
* Sets if the direct point-to-point wire between {@link DistanceMeasurement
|
|
76
|
+
* Sets if the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target} is visible.
|
|
77
77
|
*
|
|
78
78
|
* @type {Boolean}
|
|
79
79
|
*/
|
|
80
80
|
set wireVisible(arg: boolean);
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* Gets if the direct point-to-point wire between {@link DistanceMeasurement
|
|
83
|
+
* Gets if the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target} is visible.
|
|
84
84
|
*
|
|
85
85
|
* @type {Boolean}
|
|
86
86
|
*/
|
|
87
87
|
get wireVisible(): boolean;
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* Sets if the axis-aligned wires between {@link DistanceMeasurement
|
|
90
|
+
* Sets if the axis-aligned wires between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target} are visible.
|
|
91
91
|
*
|
|
92
92
|
* @type {Boolean}
|
|
93
93
|
*/
|
|
94
94
|
set axisVisible(arg: boolean);
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* Gets if the axis-aligned wires between {@link DistanceMeasurement
|
|
97
|
+
* Gets if the axis-aligned wires between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target} are visible.
|
|
98
98
|
*
|
|
99
99
|
* @type {Boolean}
|
|
100
100
|
*/
|
|
@@ -115,7 +115,7 @@ export class DistanceMeasurement extends Component {
|
|
|
115
115
|
get target(): Marker;
|
|
116
116
|
|
|
117
117
|
/**
|
|
118
|
-
* Gets the World-space direct point-to-point distance between {@link DistanceMeasurement
|
|
118
|
+
* Gets the World-space direct point-to-point distance between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
|
|
119
119
|
*
|
|
120
120
|
* @type {Number}
|
|
121
121
|
*/
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { Component } from "../../viewer/scene/Component";
|
|
2
|
+
import { DistanceMeasurement } from "./DistanceMeasurement";
|
|
2
3
|
import { DistanceMeasurementsPlugin } from "./DistanceMeasurementsPlugin";
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* Creates {@link DistanceMeasurement}s from mouse and touch input.
|
|
6
7
|
*/
|
|
7
|
-
export class DistanceMeasurementsControl extends Component {
|
|
8
|
+
export declare class DistanceMeasurementsControl extends Component {
|
|
8
9
|
/**
|
|
9
10
|
* The {@link DistanceMeasurementsPlugin} that owns this DistanceMeasurementsControl.
|
|
10
11
|
* @type {DistanceMeasurementsPlugin}
|
|
@@ -37,4 +38,28 @@ export class DistanceMeasurementsControl extends Component {
|
|
|
37
38
|
* Does nothing if the DistanceMeasurementsControl is not active.
|
|
38
39
|
*/
|
|
39
40
|
reset(): void;
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Fires when the measurement is ended.
|
|
44
|
+
* @param event The measurementEnd event
|
|
45
|
+
* @param callback Called fired on the event
|
|
46
|
+
* @param scope Scope for the callback
|
|
47
|
+
*/
|
|
48
|
+
on(event: "measurementEnd", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Fires when the measurement is cancelled.
|
|
52
|
+
* @param event The measurementCancel event
|
|
53
|
+
* @param callback Called fired on the event
|
|
54
|
+
* @param scope Scope for the callback
|
|
55
|
+
*/
|
|
56
|
+
on(event: "measurementCancel", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Fires when the measurement is started.
|
|
60
|
+
* @param event The measurementStart event
|
|
61
|
+
* @param callback Called fired on the event
|
|
62
|
+
* @param scope Scope for the callback
|
|
63
|
+
*/
|
|
64
|
+
on(event: "measurementStart", callback: (measurement: DistanceMeasurement) => void, scope?: any): string
|
|
40
65
|
}
|
|
@@ -3,7 +3,7 @@ import { DistanceMeasurementsControl } from "./DistanceMeasurementsControl";
|
|
|
3
3
|
import { DistanceMeasurement } from "./DistanceMeasurement";
|
|
4
4
|
|
|
5
5
|
export declare type DistanceMeasurementsPluginConfiguration = {
|
|
6
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
6
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
7
7
|
id?: string;
|
|
8
8
|
/** The minimum length, in pixels, of an axis wire beyond which its label is shown. */
|
|
9
9
|
labelMinAxisLength?: number;
|
|
@@ -28,7 +28,7 @@ export declare type DistanceMeasurementsPluginConfiguration = {
|
|
|
28
28
|
/**
|
|
29
29
|
* {@link Viewer} plugin for measuring point-to-point distances.
|
|
30
30
|
*/
|
|
31
|
-
export class DistanceMeasurementsPlugin extends Plugin {
|
|
31
|
+
export declare class DistanceMeasurementsPlugin extends Plugin {
|
|
32
32
|
/**
|
|
33
33
|
* @constructor
|
|
34
34
|
* @param {Viewer} viewer The Viewer.
|
|
@@ -63,7 +63,7 @@ export class DistanceMeasurementsPlugin extends Plugin {
|
|
|
63
63
|
get control(): DistanceMeasurementsControl;
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement
|
|
66
|
+
* Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement.id}.
|
|
67
67
|
*
|
|
68
68
|
* @type {{String:DistanceMeasurement}}
|
|
69
69
|
*/
|
|
@@ -72,10 +72,10 @@ export class DistanceMeasurementsPlugin extends Plugin {
|
|
|
72
72
|
/**
|
|
73
73
|
* Creates a {@link DistanceMeasurement}.
|
|
74
74
|
*
|
|
75
|
-
* The DistanceMeasurement is then registered by {@link DistanceMeasurement
|
|
75
|
+
* The DistanceMeasurement is then registered by {@link DistanceMeasurement.id} in {@link DistanceMeasurementsPlugin.measurements}.
|
|
76
76
|
*
|
|
77
77
|
* @param {Object} params {@link DistanceMeasurement} configuration.
|
|
78
|
-
* @param {String} params.id Unique ID to assign to {@link DistanceMeasurement
|
|
78
|
+
* @param {String} params.id Unique ID to assign to {@link DistanceMeasurement.id}. The DistanceMeasurement will be registered by this in {@link DistanceMeasurementsPlugin.measurements} and {@link Scene.components}. Must be unique among all components in the {@link Viewer}.
|
|
79
79
|
* @param {Number[]} params.origin.worldPos Origin World-space 3D position.
|
|
80
80
|
* @param {Entity} params.origin.entity Origin Entity.
|
|
81
81
|
* @param {Number[]} params.target.worldPos Target World-space 3D position.
|
|
@@ -83,8 +83,8 @@ export class DistanceMeasurementsPlugin extends Plugin {
|
|
|
83
83
|
* @param {Boolean} [params.visible=true] Whether to initially show the {@link DistanceMeasurement}.
|
|
84
84
|
* @param {Boolean} [params.originVisible=true] Whether to initially show the {@link DistanceMeasurement} origin.
|
|
85
85
|
* @param {Boolean} [params.targetVisible=true] Whether to initially show the {@link DistanceMeasurement} target.
|
|
86
|
-
* @param {Boolean} [params.wireVisible=true] Whether to initially show the direct point-to-point wire between {@link DistanceMeasurement
|
|
87
|
-
* @param {Boolean} [params.axisVisible=true] Whether to initially show the axis-aligned wires between {@link DistanceMeasurement
|
|
86
|
+
* @param {Boolean} [params.wireVisible=true] Whether to initially show the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
|
|
87
|
+
* @param {Boolean} [params.axisVisible=true] Whether to initially show the axis-aligned wires between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
|
|
88
88
|
* @param {string} [params.color] The color of the length dot, wire and label.
|
|
89
89
|
* @returns {DistanceMeasurement} The new {@link DistanceMeasurement}.
|
|
90
90
|
*/
|
|
@@ -117,4 +117,19 @@ export class DistanceMeasurementsPlugin extends Plugin {
|
|
|
117
117
|
* Destroys all {@link DistanceMeasurement}s.
|
|
118
118
|
*/
|
|
119
119
|
clear(): void;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Fires when a measurement is created.
|
|
123
|
+
* @param {String} event The measurementCreated event
|
|
124
|
+
* @param {Function} callback Callback fired on the event
|
|
125
|
+
*/
|
|
126
|
+
on(event: "measurementCreated", callback: (measurement: DistanceMeasurement)=> void): void;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Fires when a measurement is destroyed.
|
|
130
|
+
* @param {String} event The measurementDestroyed event
|
|
131
|
+
* @param {Function} callback Callback fired on the event
|
|
132
|
+
*/
|
|
133
|
+
on(event: "measurementDestroyed", callback: (measurement: DistanceMeasurement)=> void): void;
|
|
134
|
+
|
|
120
135
|
}
|
|
@@ -2,7 +2,7 @@ import { Plugin } from "../../viewer/Plugin";
|
|
|
2
2
|
import { Viewer } from "../../viewer/Viewer";
|
|
3
3
|
|
|
4
4
|
export declare type FastNavPluginConfiguration = {
|
|
5
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
5
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
6
6
|
id?: string;
|
|
7
7
|
/** Whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer. */
|
|
8
8
|
hidePBR?: boolean;
|
|
@@ -116,7 +116,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
116
116
|
*
|
|
117
117
|
* Default is ````false````.
|
|
118
118
|
*
|
|
119
|
-
* The scaling factor is configured via {@link FastNavPlugin
|
|
119
|
+
* The scaling factor is configured via {@link FastNavPlugin.scaleCanvasResolutionFactor}.
|
|
120
120
|
*
|
|
121
121
|
* @param {Boolean} scaleCanvasResolution ````true```` to scale the canvas resolution.
|
|
122
122
|
*/
|
|
@@ -127,7 +127,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
127
127
|
*
|
|
128
128
|
* Default is ````false````.
|
|
129
129
|
*
|
|
130
|
-
* The scaling factor is configured via {@link FastNavPlugin
|
|
130
|
+
* The scaling factor is configured via {@link FastNavPlugin.scaleCanvasResolutionFactor}.
|
|
131
131
|
*
|
|
132
132
|
* @return {Boolean} ````true```` if scaling the canvas resolution.
|
|
133
133
|
*/
|
|
@@ -140,7 +140,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
140
140
|
*
|
|
141
141
|
* Default is ````0.6````.
|
|
142
142
|
*
|
|
143
|
-
* Enable canvas resolution scaling by setting {@link FastNavPlugin
|
|
143
|
+
* Enable canvas resolution scaling by setting {@link FastNavPlugin.scaleCanvasResolution} ````true````.
|
|
144
144
|
*
|
|
145
145
|
* @param {Number} scaleCanvasResolutionFactor Factor by which we scale the canvas resolution.
|
|
146
146
|
*/
|
|
@@ -151,7 +151,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
151
151
|
*
|
|
152
152
|
* Default is ````0.6````.
|
|
153
153
|
*
|
|
154
|
-
* Enable canvas resolution scaling by setting {@link FastNavPlugin
|
|
154
|
+
* Enable canvas resolution scaling by setting {@link FastNavPlugin.scaleCanvasResolution} ````true````.
|
|
155
155
|
*
|
|
156
156
|
* @return {Number} Factor by which we scale the canvas resolution.
|
|
157
157
|
*/
|
|
@@ -160,7 +160,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
160
160
|
/**
|
|
161
161
|
* Sets whether to have a delay before restoring normal rendering after we stop interacting with the Viewer.
|
|
162
162
|
*
|
|
163
|
-
* The delay duration is configured via {@link FastNavPlugin
|
|
163
|
+
* The delay duration is configured via {@link FastNavPlugin.delayBeforeRestoreSeconds}.
|
|
164
164
|
*
|
|
165
165
|
* Default is ````true````.
|
|
166
166
|
*
|
|
@@ -171,7 +171,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
171
171
|
/**
|
|
172
172
|
* Gets whether to have a delay before restoring normal rendering after we stop interacting with the Viewer.
|
|
173
173
|
*
|
|
174
|
-
* The delay duration is configured via {@link FastNavPlugin
|
|
174
|
+
* The delay duration is configured via {@link FastNavPlugin.delayBeforeRestoreSeconds}.
|
|
175
175
|
*
|
|
176
176
|
* Default is ````true````.
|
|
177
177
|
*
|
|
@@ -182,7 +182,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
182
182
|
/**
|
|
183
183
|
* Sets the delay before restoring normal rendering after we stop interacting with the Viewer.
|
|
184
184
|
*
|
|
185
|
-
* The delay is enabled when {@link FastNavPlugin
|
|
185
|
+
* The delay is enabled when {@link FastNavPlugin.delayBeforeRestore} is ````true````.
|
|
186
186
|
*
|
|
187
187
|
* Default is ````0.5```` seconds.
|
|
188
188
|
*
|
|
@@ -193,7 +193,7 @@ export declare class FastNavPlugin extends Plugin {
|
|
|
193
193
|
/**
|
|
194
194
|
* Gets the delay before restoring normal rendering after we stop interacting with the Viewer.
|
|
195
195
|
*
|
|
196
|
-
* The delay is enabled when {@link FastNavPlugin
|
|
196
|
+
* The delay is enabled when {@link FastNavPlugin.delayBeforeRestore} is ````true````.
|
|
197
197
|
*
|
|
198
198
|
* Default is ````0.5```` seconds.
|
|
199
199
|
*
|
|
@@ -5,10 +5,10 @@ export declare interface IGLTFDefaultDataSource {
|
|
|
5
5
|
* Gets metamodel JSON.
|
|
6
6
|
*
|
|
7
7
|
* @param {String|Number} metaModelSrc Identifies the metamodel JSON asset.
|
|
8
|
-
* @param {
|
|
9
|
-
* @param {
|
|
8
|
+
* @param {Function(*)} ok Fired on successful loading of the metamodel JSON asset.
|
|
9
|
+
* @param {Function(*)} error Fired on error while loading the metamodel JSON asset.
|
|
10
10
|
*/
|
|
11
|
-
getMetaModel(metaModelSrc: string | number, ok:
|
|
11
|
+
getMetaModel(metaModelSrc: string | number, ok: Function, error: Function): void;
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* Gets glTF JSON.
|
|
@@ -34,7 +34,7 @@ export declare interface IGLTFDefaultDataSource {
|
|
|
34
34
|
}
|
|
35
35
|
|
|
36
36
|
export declare type GLTFLoaderPluginConfiguration = {
|
|
37
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
37
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
38
38
|
id?: string;
|
|
39
39
|
/** Map of initial default states for each loaded {@link Entity} that represents an object. Default value is {@link IFCObjectDefaults}. */
|
|
40
40
|
objectDefaults?: IFCObjectDefaults;
|
|
@@ -43,7 +43,7 @@ export declare type GLTFLoaderPluginConfiguration = {
|
|
|
43
43
|
};
|
|
44
44
|
|
|
45
45
|
export declare type LoadGLTFModel = {
|
|
46
|
-
/** ID to assign to the root {@link Entity
|
|
46
|
+
/** ID to assign to the root {@link Entity.id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
|
|
47
47
|
id?: string;
|
|
48
48
|
/** Path to a glTF file, as an alternative to the ````gltf```` parameter. */
|
|
49
49
|
src?: string;
|
|
@@ -55,9 +55,9 @@ export declare type LoadGLTFModel = {
|
|
|
55
55
|
metaModelData?: any;
|
|
56
56
|
/** Map of initial default states for each loaded {@link Entity} that represents an object. Default value is {@link IFCObjectDefaults}. */
|
|
57
57
|
objectDefaults?: object;
|
|
58
|
-
/** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject
|
|
58
|
+
/** When loading metadata, only loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
|
|
59
59
|
includeTypes?: string[]
|
|
60
|
-
/** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject
|
|
60
|
+
/** When loading metadata, never loads objects that have {@link MetaObject}s with {@link MetaObject.type} values in this list. */
|
|
61
61
|
excludeTypes?: string[]
|
|
62
62
|
/** Whether or not xeokit renders the model with edges emphasized. */
|
|
63
63
|
edges?: boolean;
|
|
@@ -134,7 +134,7 @@ export declare class GLTFLoaderPlugin extends Plugin {
|
|
|
134
134
|
* Loads a glTF model from a file into this GLTFLoaderPlugin's {@link Viewer}.
|
|
135
135
|
*
|
|
136
136
|
* @param {LoadGLTFModel} params Loading parameters.
|
|
137
|
-
* @returns {Entity} Entity representing the model, which will have {@link Entity
|
|
137
|
+
* @returns {Entity} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}
|
|
138
138
|
*/
|
|
139
139
|
load(params: LoadGLTFModel): PerformanceModel;
|
|
140
140
|
}
|
|
@@ -13,7 +13,7 @@ export declare interface ILASDefaultDataSource {
|
|
|
13
13
|
}
|
|
14
14
|
|
|
15
15
|
export declare type LASLoaderPluginConfiguration = {
|
|
16
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
16
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
17
17
|
id?: string;
|
|
18
18
|
/** A custom data source through which the LASLoaderPlugin can load model and metadata files. Defaults to an instance of {@link LASDefaultDataSource}, which loads over HTTP. */
|
|
19
19
|
dataSource?: ILASDefaultDataSource;
|
|
@@ -26,7 +26,7 @@ export declare type LASLoaderPluginConfiguration = {
|
|
|
26
26
|
};
|
|
27
27
|
|
|
28
28
|
export declare type LoadLASModel = {
|
|
29
|
-
/** ID to assign to the root {@link Entity
|
|
29
|
+
/** ID to assign to the root {@link Entity.id}, unique among all components in the Viewer's {@link Scene}, generated automatically by default. */
|
|
30
30
|
id?: string;
|
|
31
31
|
/** Path to a LAS file, as an alternative to the ````las```` parameter. */
|
|
32
32
|
src?: string;
|
|
@@ -51,7 +51,7 @@ export declare type LoadLASModel = {
|
|
|
51
51
|
/**
|
|
52
52
|
* {@link Viewer} plugin that loads lidar point cloud geometry from LAS files.
|
|
53
53
|
*/
|
|
54
|
-
export class LASLoaderPlugin extends Plugin {
|
|
54
|
+
export declare class LASLoaderPlugin extends Plugin {
|
|
55
55
|
/**
|
|
56
56
|
* @constructor
|
|
57
57
|
*
|
|
@@ -140,7 +140,7 @@ export class LASLoaderPlugin extends Plugin {
|
|
|
140
140
|
* Loads an ````LAS```` model into this LASLoaderPlugin's {@link Viewer}.
|
|
141
141
|
*
|
|
142
142
|
* @param {LoadLASModel} params Loading parameters.
|
|
143
|
-
* @returns {Entity} Entity representing the model, which will have {@link Entity
|
|
143
|
+
* @returns {Entity} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}.
|
|
144
144
|
*/
|
|
145
145
|
load(params?: LoadLASModel): PerformanceModel;
|
|
146
146
|
}
|
|
@@ -2,7 +2,7 @@ import { Plugin } from "../../viewer/Plugin";
|
|
|
2
2
|
import { Viewer } from "../../viewer/Viewer";
|
|
3
3
|
|
|
4
4
|
export declare type NavCubePluginConfiguration = {
|
|
5
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
5
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
6
6
|
id?: string;
|
|
7
7
|
/** ID of an existing HTML canvas to display the NavCube - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID. */
|
|
8
8
|
canvasId?: string;
|
|
@@ -34,7 +34,7 @@ export declare type NavCubePluginConfiguration = {
|
|
|
34
34
|
bottomColor?: string;
|
|
35
35
|
/** Custom color for highlighting regions on the NavCube as we hover the pointer over them. */
|
|
36
36
|
hoverColor?: string;
|
|
37
|
-
/** Sets whether the axis, corner and edge-aligned views will fit the view to the entire {@link Scene} or just to visible object-{@link Entity}s. Entitys are visible objects when {@link Entity
|
|
37
|
+
/** Sets whether the axis, corner and edge-aligned views will fit the view to the entire {@link Scene} or just to visible object-{@link Entity}s. Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````. */
|
|
38
38
|
fitVisible?: boolean;
|
|
39
39
|
/** Sets whether the NavCube switches between perspective and orthographic projections in synchrony with the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection. */
|
|
40
40
|
synchProjection?: boolean;
|
|
@@ -70,7 +70,7 @@ export declare class NavCubePlugin extends Plugin {
|
|
|
70
70
|
* Sets whether the axis, corner and edge-aligned views will fit the
|
|
71
71
|
* view to the entire {@link Scene} or just to visible object-{@link Entity}s.
|
|
72
72
|
*
|
|
73
|
-
* Entitys are visible objects when {@link Entity
|
|
73
|
+
* Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````.
|
|
74
74
|
*
|
|
75
75
|
* @param {Boolean} value Set ````true```` to fit only visible object-Entitys.
|
|
76
76
|
*/
|
|
@@ -80,7 +80,7 @@ export declare class NavCubePlugin extends Plugin {
|
|
|
80
80
|
* Gets whether the axis, corner and edge-aligned views will fit the
|
|
81
81
|
* view to the entire {@link Scene} or just to visible object-{@link Entity}s.
|
|
82
82
|
*
|
|
83
|
-
* Entitys are visible objects when {@link Entity
|
|
83
|
+
* Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````.
|
|
84
84
|
*
|
|
85
85
|
* @return {Boolean} True when fitting only visible object-Entitys.
|
|
86
86
|
*/
|
|
@@ -146,7 +146,7 @@ export declare class NavCubePlugin extends Plugin {
|
|
|
146
146
|
* Sets whether the NavCube switches between perspective and orthographic projections in synchrony with
|
|
147
147
|
* the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection.
|
|
148
148
|
*
|
|
149
|
-
* @param {Boolean} value Set ````true```` to keep NavCube projection synchronized with {@link Camera
|
|
149
|
+
* @param {Boolean} value Set ````true```` to keep NavCube projection synchronized with {@link Camera.projection}.
|
|
150
150
|
*/
|
|
151
151
|
setSynchProjection(value: boolean): void;
|
|
152
152
|
|
|
@@ -154,7 +154,7 @@ export declare class NavCubePlugin extends Plugin {
|
|
|
154
154
|
* Gets whether the NavCube switches between perspective and orthographic projections in synchrony with
|
|
155
155
|
* the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection.
|
|
156
156
|
*
|
|
157
|
-
* @return {Boolean} True when NavCube projection is synchronized with {@link Camera
|
|
157
|
+
* @return {Boolean} True when NavCube projection is synchronized with {@link Camera.projection}.
|
|
158
158
|
*/
|
|
159
159
|
getSynchProjection(): boolean;
|
|
160
160
|
}
|
|
@@ -28,7 +28,7 @@ export declare class OBJLoaderPlugin extends Plugin {
|
|
|
28
28
|
*
|
|
29
29
|
* @param {Viewer} viewer The Viewer.
|
|
30
30
|
* @param {Object} cfg Plugin configuration.
|
|
31
|
-
* @param {String} [cfg.id="OBJLoader"] Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
31
|
+
* @param {String} [cfg.id="OBJLoader"] Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
|
|
32
32
|
*/
|
|
33
33
|
constructor(viewer: Viewer, cfg: {
|
|
34
34
|
id?: string;
|
|
@@ -38,7 +38,7 @@ export declare class OBJLoaderPlugin extends Plugin {
|
|
|
38
38
|
* Loads an OBJ model from a file into this OBJLoader's {@link Viewer}.
|
|
39
39
|
*
|
|
40
40
|
* @param {LoadOBJModel} params Loading parameters.
|
|
41
|
-
* @returns {PerformanceModel} Entity representing the model, which will have {@link Entity
|
|
41
|
+
* @returns {PerformanceModel} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}
|
|
42
42
|
*/
|
|
43
43
|
load(params: LoadOBJModel): PerformanceModel;
|
|
44
44
|
}
|
|
@@ -12,7 +12,7 @@ export declare interface ISTLDefaultDataSource {
|
|
|
12
12
|
}
|
|
13
13
|
|
|
14
14
|
export declare type STLLoaderPluginCOnfiguration = {
|
|
15
|
-
/** Optional ID for this plugin, so that we can find it within {@link Viewer
|
|
15
|
+
/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
|
|
16
16
|
id?: string;
|
|
17
17
|
/** A custom data source through which the STLLoaderPlugin can load STL files. Defaults to an instance of {@link STLDefaultDataSource}, which loads over HTTP. */
|
|
18
18
|
dataSource?: ISTLDefaultDataSource;
|
|
@@ -82,7 +82,7 @@ export declare class STLLoaderPlugin extends Plugin {
|
|
|
82
82
|
* Loads an STL model from a file into this STLLoaderPlugin's {@link Viewer}.
|
|
83
83
|
*
|
|
84
84
|
* @param {LoadSTLModel} params Loading parameters.
|
|
85
|
-
* @returns {PerformanceModel} Entity representing the model, which will have {@link Entity
|
|
85
|
+
* @returns {PerformanceModel} Entity representing the model, which will have {@link Entity.isModel} set ````true```` and will be registered by {@link Entity.id} in {@link Scene.models}
|
|
86
86
|
*/
|
|
87
87
|
load(params: LoadSTLModel): PerformanceModel;
|
|
88
88
|
}
|