@cognite/reveal 2.1.2 → 2.2.0

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 (211) hide show
  1. package/core/cad.d.ts +4 -5
  2. package/core/index.d.ts +7 -7
  3. package/core/src/datamodels/base/SupportedModelTypes.d.ts +4 -4
  4. package/core/src/datamodels/base/index.d.ts +6 -6
  5. package/core/src/datamodels/base/types.d.ts +14 -14
  6. package/core/src/datamodels/cad/CadManager.d.ts +45 -43
  7. package/core/src/datamodels/cad/CadModelFactory.d.ts +7 -7
  8. package/core/src/datamodels/cad/CadModelSectorLoadStatistics.d.ts +38 -38
  9. package/core/src/datamodels/cad/createCadManager.d.ts +9 -10
  10. package/core/src/datamodels/cad/picking.d.ts +28 -28
  11. package/core/src/datamodels/cad/rendering/RenderAlreadyLoadedGeometryProvider.d.ts +10 -9
  12. package/core/src/datamodels/cad/sector/CadModelClipper.d.ts +10 -10
  13. package/core/src/datamodels/cad/styling/AssetNodeCollection.d.ts +39 -39
  14. package/core/src/datamodels/cad/styling/InvertedNodeCollection.d.ts +24 -24
  15. package/core/src/datamodels/cad/styling/NodeCollectionDeserializer.d.ts +26 -26
  16. package/core/src/datamodels/cad/styling/PopulateIndexSetFromPagedResponseHelper.d.ts +24 -24
  17. package/core/src/datamodels/cad/styling/PropertyFilterNodeCollection.d.ts +61 -61
  18. package/core/src/datamodels/cad/styling/SinglePropertyFilterNodeCollection.d.ts +60 -60
  19. package/core/src/datamodels/cad/styling/index.d.ts +8 -8
  20. package/core/src/datamodels/pointcloud/PointCloudFactory.d.ts +9 -9
  21. package/core/src/datamodels/pointcloud/PointCloudManager.d.ts +26 -25
  22. package/core/src/datamodels/pointcloud/PointCloudMetadata.d.ts +11 -11
  23. package/core/src/datamodels/pointcloud/PointCloudMetadataRepository.d.ts +13 -13
  24. package/core/src/datamodels/pointcloud/PointCloudNode.d.ts +62 -62
  25. package/core/src/datamodels/pointcloud/PotreeGroupWrapper.d.ts +39 -39
  26. package/core/src/datamodels/pointcloud/PotreeNodeWrapper.d.ts +38 -38
  27. package/core/src/datamodels/pointcloud/createPointCloudManager.d.ts +6 -8
  28. package/core/src/datamodels/pointcloud/index.d.ts +5 -0
  29. package/core/src/datamodels/pointcloud/picking.d.ts +29 -29
  30. package/core/src/datamodels/pointcloud/types.d.ts +114 -114
  31. package/core/src/index.d.ts +19 -19
  32. package/core/src/internals.d.ts +15 -0
  33. package/core/src/migration.d.ts +8 -8
  34. package/core/src/public/RevealManager.d.ts +64 -61
  35. package/core/src/public/createRevealManager.d.ts +23 -24
  36. package/core/src/public/migration/Cognite3DModel.d.ts +339 -323
  37. package/core/src/public/migration/Cognite3DViewer.d.ts +555 -545
  38. package/core/src/public/migration/CogniteModelBase.d.ts +17 -17
  39. package/core/src/public/migration/CognitePointCloudModel.d.ts +121 -121
  40. package/core/src/public/migration/NodeIdAndTreeIndexMaps.d.ts +4 -4
  41. package/core/src/public/migration/NotSupportedInMigrationWrapperError.d.ts +11 -11
  42. package/core/src/public/migration/RenderController.d.ts +4 -4
  43. package/core/src/public/migration/types.d.ts +266 -240
  44. package/core/src/public/types.d.ts +46 -45
  45. package/core/src/{public/migration → storage}/RevealManagerHelper.d.ts +58 -58
  46. package/core/src/utilities/BoundingBoxClipper.d.ts +23 -23
  47. package/core/src/utilities/Spinner.d.ts +27 -28
  48. package/core/src/utilities/ViewStateHelper.d.ts +33 -33
  49. package/core/src/utilities/callActionWithIndicesAsync.d.ts +4 -4
  50. package/core/src/utilities/index.d.ts +8 -8
  51. package/core/src/utilities/reflection.d.ts +7 -7
  52. package/core/src/utilities/worldToViewport.d.ts +30 -31
  53. package/core/utilities.d.ts +4 -4
  54. package/extensions/datasource.d.ts +9 -0
  55. package/extensions/datasource.js +33 -0
  56. package/extensions/datasource.map +1 -0
  57. package/index.d.ts +8 -8
  58. package/index.js +142 -130
  59. package/index.map +1 -1
  60. package/package.json +1 -1
  61. package/packages/cad-geometry-loaders/index.d.ts +14 -20
  62. package/packages/cad-geometry-loaders/src/CadLoadingHints.d.ts +11 -11
  63. package/packages/cad-geometry-loaders/src/CadModelSectorBudget.d.ts +26 -26
  64. package/packages/cad-geometry-loaders/src/CadModelUpdateHandler.d.ts +44 -44
  65. package/packages/cad-geometry-loaders/src/sector/CachedRepository.d.ts +25 -25
  66. package/packages/cad-geometry-loaders/src/sector/ModelStateHandler.d.ts +12 -12
  67. package/packages/cad-geometry-loaders/src/sector/Repository.d.ts +9 -9
  68. package/packages/cad-geometry-loaders/src/sector/SectorLoader.d.ts +28 -28
  69. package/packages/cad-geometry-loaders/src/sector/SimpleAndDetailedToSector3D.d.ts +20 -20
  70. package/packages/cad-geometry-loaders/src/sector/culling/ByVisibilityGpuSectorCuller.d.ts +53 -53
  71. package/packages/cad-geometry-loaders/src/sector/culling/OccludingGeometryProvider.d.ts +6 -6
  72. package/packages/cad-geometry-loaders/src/sector/culling/OrderSectorsByVisibilityCoverage.d.ts +107 -107
  73. package/packages/cad-geometry-loaders/src/sector/culling/SectorCuller.d.ts +33 -33
  74. package/packages/cad-geometry-loaders/src/sector/culling/TakenSectorTree.d.ts +24 -24
  75. package/packages/cad-geometry-loaders/src/sector/culling/types.d.ts +71 -71
  76. package/packages/cad-geometry-loaders/src/sector/rxSectorUtilities.d.ts +12 -12
  77. package/packages/cad-geometry-loaders/src/sector/sectorUtilities.d.ts +20 -19
  78. package/packages/cad-geometry-loaders/src/utilities/PromiseUtils.d.ts +18 -18
  79. package/packages/cad-geometry-loaders/src/utilities/arrays.d.ts +5 -5
  80. package/packages/cad-geometry-loaders/src/utilities/groupMeshesByNumber.d.ts +8 -8
  81. package/packages/cad-geometry-loaders/src/utilities/rxOperations.d.ts +5 -5
  82. package/packages/cad-geometry-loaders/src/utilities/types.d.ts +25 -48
  83. package/packages/cad-parsers/index.d.ts +21 -20
  84. package/packages/cad-parsers/src/cad/CadSectorParser.d.ts +15 -15
  85. package/packages/cad-parsers/src/cad/LevelOfDetail.d.ts +8 -8
  86. package/packages/{cad-geometry-loaders/src/material-manager/rendering → cad-parsers/src/cad}/filterInstanceMesh.d.ts +6 -6
  87. package/packages/cad-parsers/src/cad/filterPrimitives.d.ts +9 -9
  88. package/packages/cad-parsers/src/cad/primitiveGeometries.d.ts +31 -31
  89. package/packages/{cad-geometry-loaders/src/material-manager/rendering → cad-parsers/src/cad}/triangleMeshes.d.ts +6 -6
  90. package/packages/cad-parsers/src/cad/types.d.ts +56 -56
  91. package/packages/cad-parsers/src/metadata/CadMetadataParser.d.ts +7 -7
  92. package/packages/cad-parsers/src/metadata/CadModelMetadata.d.ts +44 -44
  93. package/packages/cad-parsers/src/metadata/CadModelMetadataRepository.d.ts +16 -16
  94. package/packages/cad-parsers/src/metadata/MetadataRepository.d.ts +7 -6
  95. package/packages/cad-parsers/src/metadata/parsers/CadMetadataParserV8.d.ts +51 -51
  96. package/packages/cad-parsers/src/metadata/types.d.ts +41 -41
  97. package/packages/{cad-geometry-loaders → cad-parsers}/src/sector/RootSectorNode.d.ts +12 -12
  98. package/packages/{cad-geometry-loaders → cad-parsers}/src/sector/SectorNode.d.ts +21 -21
  99. package/packages/cad-parsers/src/utilities/SectorScene.d.ts +21 -21
  100. package/packages/cad-parsers/src/utilities/SectorSceneFactory.d.ts +12 -12
  101. package/packages/cad-parsers/src/{cad → utilities}/computeBoundingBoxFromAttributes.d.ts +9 -9
  102. package/packages/{cad-geometry-loaders → cad-parsers}/src/utilities/float32BufferToMatrix.d.ts +12 -12
  103. package/packages/cad-parsers/src/utilities/types.d.ts +48 -48
  104. package/packages/cad-styling/index.d.ts +9 -9
  105. package/packages/cad-styling/src/CombineNodeCollectionBase.d.ts +31 -31
  106. package/packages/cad-styling/src/IntersectionNodeCollection.d.ts +15 -15
  107. package/packages/cad-styling/src/NodeAppearance.d.ts +62 -62
  108. package/packages/cad-styling/src/NodeAppearanceProvider.d.ts +29 -29
  109. package/packages/cad-styling/src/NodeCollectionBase.d.ts +47 -47
  110. package/packages/cad-styling/src/TreeIndexNodeCollection.d.ts +23 -23
  111. package/packages/cad-styling/src/UnionNodeCollection.d.ts +15 -15
  112. package/packages/camera-manager/index.d.ts +4 -4
  113. package/packages/camera-manager/src/ComboControls.d.ts +84 -83
  114. package/packages/camera-manager/src/Keyboard.d.ts +14 -14
  115. package/packages/data-source/index.d.ts +6 -0
  116. package/packages/data-source/src/CdfDataSource.d.ts +19 -0
  117. package/packages/data-source/src/DataSource.d.ts +26 -0
  118. package/packages/data-source/src/LocalDataSource.d.ts +15 -0
  119. package/packages/logger/index.d.ts +5 -5
  120. package/packages/logger/src/Log.d.ts +5 -5
  121. package/packages/metrics/index.d.ts +5 -0
  122. package/packages/metrics/src/MetricsLogger.d.ts +21 -0
  123. package/packages/metrics/src/types.d.ts +7 -0
  124. package/packages/modeldata-api/index.d.ts +13 -8
  125. package/packages/modeldata-api/src/{CdfModelDataClient.d.ts → CdfModelDataProvider.d.ts} +15 -17
  126. package/packages/modeldata-api/src/CdfModelIdentifier.d.ts +17 -0
  127. package/packages/modeldata-api/src/CdfModelMetadataProvider.d.ts +19 -36
  128. package/packages/modeldata-api/src/CdfModelOutputsProvider.d.ts +15 -0
  129. package/packages/modeldata-api/src/{LocalModelDataClient.d.ts → LocalModelDataProvider.d.ts} +9 -10
  130. package/packages/modeldata-api/src/LocalModelIdentifier.d.ts +14 -0
  131. package/packages/modeldata-api/src/LocalModelMetadataProvider.d.ts +14 -19
  132. package/packages/modeldata-api/src/Model3DOutputList.d.ts +17 -17
  133. package/packages/modeldata-api/src/ModelIdentifier.d.ts +12 -0
  134. package/packages/modeldata-api/src/ModelMetadataProvider.d.ts +17 -0
  135. package/packages/modeldata-api/src/applyDefaultModelTransformation.d.ts +6 -6
  136. package/packages/modeldata-api/src/types.d.ts +41 -55
  137. package/packages/modeldata-api/src/utilities.d.ts +7 -7
  138. package/packages/nodes-api/index.d.ts +6 -7
  139. package/packages/nodes-api/src/NodesApiClient.d.ts +52 -43
  140. package/packages/nodes-api/src/NodesCdfClient.d.ts +24 -19
  141. package/packages/nodes-api/src/NodesLocalClient.d.ts +30 -25
  142. package/packages/nodes-api/src/types.d.ts +10 -14
  143. package/packages/rendering/index.d.ts +17 -0
  144. package/packages/{cad-geometry-loaders/src/material-manager → rendering/src}/CadMaterialManager.d.ts +37 -37
  145. package/packages/{cad-geometry-loaders → rendering}/src/InstancedMeshManager.d.ts +20 -20
  146. package/packages/{cad-geometry-loaders → rendering}/src/cameraconfig.d.ts +12 -12
  147. package/packages/{cad-geometry-loaders/src/material-manager → rendering/src}/rendering/EffectRenderManager.d.ts +99 -83
  148. package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/rendering}/NodeAppearanceTextureBuilder.d.ts +51 -50
  149. package/packages/{cad-parsers/src/cad → rendering/src/rendering}/RenderMode.d.ts +15 -15
  150. package/packages/{cad-geometry-loaders/src/material-manager → rendering/src}/rendering/createSimpleGeometryMesh.d.ts +6 -6
  151. package/packages/{cad-parsers/src/cad → rendering/src/rendering}/matCapTextureData.d.ts +5 -5
  152. package/packages/{cad-parsers/src/cad → rendering/src/rendering}/materials.d.ts +23 -23
  153. package/packages/{cad-parsers/src/cad → rendering/src/rendering}/primitives.d.ts +12 -12
  154. package/packages/{cad-parsers/src/cad → rendering/src/rendering}/shaders.d.ts +101 -101
  155. package/packages/{cad-geometry-loaders/src/material-manager → rendering/src}/rendering/types.d.ts +76 -76
  156. package/packages/{cad-geometry-loaders/src → rendering/src/sector}/CadNode.d.ts +54 -54
  157. package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/NodeTransformProvider.d.ts +13 -13
  158. package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/NodeTransformTextureBuilder.d.ts +23 -23
  159. package/packages/{cad-geometry-loaders/src/material-manager/styling → rendering/src/transform}/TransformOverrideBuffer.d.ts +21 -21
  160. package/packages/rendering/src/utilities/types.d.ts +26 -0
  161. package/packages/tools/index.d.ts +15 -12
  162. package/packages/tools/src/AxisView/AxisViewTool.d.ts +32 -32
  163. package/packages/tools/src/AxisView/types.d.ts +98 -98
  164. package/packages/tools/src/Cognite3DViewerToolBase.d.ts +25 -25
  165. package/packages/tools/src/DebugCameraTool.d.ts +20 -20
  166. package/packages/tools/src/DebugLoadedSectorsTool.d.ts +23 -23
  167. package/packages/tools/src/ExplodedViewTool.d.ts +12 -12
  168. package/packages/tools/src/Geomap/Geomap.d.ts +14 -14
  169. package/packages/tools/src/Geomap/GeomapTool.d.ts +21 -21
  170. package/packages/tools/src/Geomap/MapConfig.d.ts +195 -195
  171. package/packages/tools/src/HtmlOverlay/BucketGrid2D.d.ts +28 -0
  172. package/packages/tools/src/HtmlOverlay/HtmlOverlayTool.d.ts +159 -0
  173. package/packages/tools/src/Timeline/Keyframe.d.ts +38 -0
  174. package/packages/tools/src/Timeline/TimelineTool.d.ts +79 -0
  175. package/packages/tools/src/Timeline/types.d.ts +13 -0
  176. package/packages/tools/src/types.d.ts +4 -4
  177. package/packages/utilities/index.d.ts +24 -24
  178. package/packages/utilities/src/CameraConfiguration.d.ts +10 -10
  179. package/packages/utilities/src/IndexSet.d.ts +1 -1
  180. package/packages/utilities/src/NumericRange.d.ts +21 -21
  181. package/packages/utilities/src/RandomColors.d.ts +34 -0
  182. package/packages/utilities/src/WebGLRendererStateHelper.d.ts +15 -15
  183. package/packages/utilities/src/assertNever.d.ts +7 -7
  184. package/packages/utilities/src/cache/MemoryRequestCache.d.ts +22 -22
  185. package/packages/utilities/src/cache/MostFrequentlyUsedCache.d.ts +19 -19
  186. package/packages/utilities/src/cache/RequestCache.d.ts +13 -13
  187. package/packages/utilities/src/datastructures/DynamicDefragmentedBuffer.d.ts +22 -22
  188. package/packages/utilities/src/determinePowerOfTwoDimensions.d.ts +11 -11
  189. package/packages/utilities/src/disposeAttributeArrayOnUpload.d.ts +17 -17
  190. package/packages/utilities/src/events/EventTrigger.d.ts +13 -13
  191. package/packages/utilities/src/events/clickOrTouchEventOffset.d.ts +13 -13
  192. package/packages/utilities/src/events/index.d.ts +5 -5
  193. package/packages/utilities/src/indexset/IndexSet.d.ts +26 -26
  194. package/packages/utilities/src/indexset/IntermediateIndexNode.d.ts +26 -26
  195. package/packages/utilities/src/indexset/LeafIndexNode.d.ts +16 -16
  196. package/packages/utilities/src/isMobileOrTablet.d.ts +4 -4
  197. package/packages/utilities/src/networking/isTheSameDomain.d.ts +11 -11
  198. package/packages/utilities/src/objectTraversal.d.ts +8 -8
  199. package/packages/utilities/src/packFloat.d.ts +6 -6
  200. package/packages/utilities/src/revealEnv.d.ts +10 -10
  201. package/packages/utilities/src/three/AutoDisposeGroup.d.ts +17 -17
  202. package/packages/utilities/src/three/BoundingBoxLOD.d.ts +27 -27
  203. package/packages/utilities/src/three/getBox3CornerPoints.d.ts +5 -5
  204. package/packages/utilities/src/transformCameraConfiguration.d.ts +6 -6
  205. package/packages/utilities/src/types.d.ts +10 -10
  206. package/packages/utilities/src/workers/WorkerPool.d.ts +14 -14
  207. package/tools.d.ts +7 -7
  208. package/tools.js +70 -123
  209. package/tools.map +1 -1
  210. package/packages/tools/src/HtmlOverlayTool.d.ts +0 -88
  211. package/packages/utilities/src/metrics.d.ts +0 -15
@@ -1,36 +1,19 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { CogniteClient } from '@cognite/sdk';
6
- import { File3dFormat, CameraConfiguration, ModelMetadataProvider } from './types';
7
- import { Model3DOutputList } from './Model3DOutputList';
8
- export declare class CdfModelMetadataProvider implements ModelMetadataProvider<{
9
- modelId: number;
10
- revisionId: number;
11
- format: File3dFormat;
12
- }> {
13
- private readonly _client;
14
- constructor(client: CogniteClient);
15
- getModelMatrix(modelIdentifier: {
16
- modelId: number;
17
- revisionId: number;
18
- format: File3dFormat | string;
19
- }): Promise<THREE.Matrix4>;
20
- getModelCamera(modelIdentifier: {
21
- modelId: number;
22
- revisionId: number;
23
- format: File3dFormat | string;
24
- }): Promise<CameraConfiguration | undefined>;
25
- getModelUri(modelIdentifier: {
26
- modelId: number;
27
- revisionId: number;
28
- format: File3dFormat | string;
29
- }): Promise<string>;
30
- getOutputs(modelIdentifier: {
31
- modelId: number;
32
- revisionId: number;
33
- format?: File3dFormat | string;
34
- }): Promise<Model3DOutputList>;
35
- private getRequestPath;
36
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { ModelMetadataProvider } from './ModelMetadataProvider';
6
+ import { CogniteClient } from '@cognite/sdk';
7
+ import { ModelIdentifier } from './ModelIdentifier';
8
+ export declare class CdfModelMetadataProvider implements ModelMetadataProvider {
9
+ private readonly _client;
10
+ constructor(client: CogniteClient);
11
+ getModelMatrix(modelIdentifier: ModelIdentifier): Promise<THREE.Matrix4>;
12
+ getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
13
+ position: THREE.Vector3;
14
+ target: THREE.Vector3;
15
+ } | undefined>;
16
+ getModelUri(modelIdentifier: ModelIdentifier): Promise<string>;
17
+ private getOutputs;
18
+ private getRequestPath;
19
+ }
@@ -0,0 +1,15 @@
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { CdfModelIdentifier } from './CdfModelIdentifier';
5
+ import { Model3DOutputList } from './Model3DOutputList';
6
+ import { CogniteClient } from '@cognite/sdk';
7
+ /**
8
+ * Helper class for getting the available 'outputs' from the Cognite
9
+ * 3D processing pipeline for a given model.
10
+ */
11
+ export declare class CdfModelOutputsProvider {
12
+ private readonly _client;
13
+ constructor(client: CogniteClient);
14
+ getOutputs(modelIdentifier: CdfModelIdentifier): Promise<Model3DOutputList>;
15
+ }
@@ -1,10 +1,9 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import { ModelDataClient } from './types';
5
- export declare class LocalModelDataClient implements ModelDataClient {
6
- get headers(): {};
7
- getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
8
- getJsonFile(baseUrl: string, fileName: string): Promise<any>;
9
- getApplicationIdentifier(): string;
10
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { ModelDataProvider } from './types';
5
+ export declare class LocalModelDataProvider implements ModelDataProvider {
6
+ get headers(): {};
7
+ getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
8
+ getJsonFile(baseUrl: string, fileName: string): Promise<any>;
9
+ }
@@ -0,0 +1,14 @@
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { ModelIdentifier } from './ModelIdentifier';
5
+ /**
6
+ * Identifies a 3D model by a URL. This implementation is used for testing
7
+ * purposes.
8
+ */
9
+ export declare class LocalModelIdentifier implements ModelIdentifier {
10
+ readonly revealInternalId: symbol;
11
+ readonly localPath: string;
12
+ constructor(localPath: string);
13
+ toString(): string;
14
+ }
@@ -1,19 +1,14 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { ModelMetadataProvider } from './types';
6
- import { CameraConfiguration } from './types';
7
- export declare class LocalModelMetadataProvider implements ModelMetadataProvider<{
8
- fileName: string;
9
- }> {
10
- getModelUri(params: {
11
- fileName: string;
12
- }): Promise<string>;
13
- getModelMatrix(_identifier: {
14
- fileName: string;
15
- }): Promise<THREE.Matrix4>;
16
- getModelCamera(_identifier: {
17
- fileName: string;
18
- }): Promise<CameraConfiguration | undefined>;
19
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { ModelIdentifier } from './ModelIdentifier';
6
+ import { ModelMetadataProvider } from './ModelMetadataProvider';
7
+ export declare class LocalModelMetadataProvider implements ModelMetadataProvider {
8
+ getModelUri(modelIdentifier: ModelIdentifier): Promise<string>;
9
+ getModelMatrix(modelIdentifier: ModelIdentifier): Promise<THREE.Matrix4>;
10
+ getModelCamera(modelIdentifier: ModelIdentifier): Promise<{
11
+ position: THREE.Vector3;
12
+ target: THREE.Vector3;
13
+ } | undefined>;
14
+ }
@@ -1,17 +1,17 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import { BlobOutputMetadata, File3dFormat } from './types';
5
- export declare class Model3DOutputList {
6
- readonly modelId: number;
7
- readonly revisionId: number;
8
- readonly outputs: BlobOutputMetadata[];
9
- constructor(modelId: number, revisionId: number, outputs: BlobOutputMetadata[]);
10
- /**
11
- * Finds an output with a given format of the most recent version.
12
- *
13
- * @param outputFormat Format to find output for, either a well known format a custom format.
14
- * @param supportedVersions Optional list of supported version. If not provided all versions are considered.
15
- */
16
- findMostRecentOutput(outputFormat: File3dFormat | string, supportedVersions?: number[]): BlobOutputMetadata | undefined;
17
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { BlobOutputMetadata, File3dFormat } from './types';
5
+ export declare class Model3DOutputList {
6
+ readonly modelId: number;
7
+ readonly revisionId: number;
8
+ readonly outputs: BlobOutputMetadata[];
9
+ constructor(modelId: number, revisionId: number, outputs: BlobOutputMetadata[]);
10
+ /**
11
+ * Finds an output with a given format of the most recent version.
12
+ *
13
+ * @param outputFormat Format to find output for, either a well known format a custom format.
14
+ * @param supportedVersions Optional list of supported version. If not provided all versions are considered.
15
+ */
16
+ findMostRecentOutput(outputFormat: File3dFormat | string, supportedVersions?: number[]): BlobOutputMetadata | undefined;
17
+ }
@@ -0,0 +1,12 @@
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ /**
5
+ * Identifies a 3D model. Typically, implementations will use {@link CdfModelIdentifier}.
6
+ */
7
+ export interface ModelIdentifier {
8
+ /**
9
+ * Unique ID of the model.
10
+ */
11
+ readonly revealInternalId: symbol;
12
+ }
@@ -0,0 +1,17 @@
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { ModelIdentifier } from './ModelIdentifier';
6
+ /**
7
+ * Provides metadata for 3D models.
8
+ * @version New since 2.2
9
+ */
10
+ export interface ModelMetadataProvider {
11
+ getModelUri(identifier: ModelIdentifier): Promise<string>;
12
+ getModelCamera(identifier: ModelIdentifier): Promise<{
13
+ position: THREE.Vector3;
14
+ target: THREE.Vector3;
15
+ } | undefined>;
16
+ getModelMatrix(identifier: ModelIdentifier): Promise<THREE.Matrix4>;
17
+ }
@@ -1,6 +1,6 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { File3dFormat } from './types';
6
- export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { File3dFormat } from './types';
6
+ export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;
@@ -1,55 +1,41 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { HttpHeaders } from '@cognite/sdk-core';
6
- export interface LocalModelIdentifier {
7
- fileName: string;
8
- }
9
- export interface CdfModelIdentifier {
10
- modelId: number;
11
- revisionId: number;
12
- }
13
- export interface JsonFileProvider {
14
- getJsonFile(baseUrl: string, fileName: string): Promise<any>;
15
- }
16
- export interface BinaryFileProvider {
17
- getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
18
- }
19
- export interface ModelMetadataProvider<TModelIdentifier> {
20
- /**
21
- * Returns an URI that identifies the resource where model geometry and metadata files are stored.
22
- * @param identifier Identifier of the model
23
- */
24
- getModelUri(identifier: TModelIdentifier): Promise<string>;
25
- getModelCamera(identifier: TModelIdentifier): Promise<CameraConfiguration | undefined>;
26
- getModelMatrix(identifier: TModelIdentifier): Promise<THREE.Matrix4>;
27
- }
28
- export interface ModelDataClient extends HttpHeadersProvider, JsonFileProvider, BinaryFileProvider {
29
- getJsonFile(baseUrl: string, fileName: string): Promise<any>;
30
- getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
31
- /**
32
- * Returns an identifier that can be used to identify the application Reveal is used in.
33
- */
34
- getApplicationIdentifier(): string;
35
- }
36
- export interface HttpHeadersProvider {
37
- readonly headers: HttpHeaders;
38
- }
39
- export declare enum File3dFormat {
40
- EptPointCloud = "ept-pointcloud",
41
- RevealCadModel = "reveal-directory",
42
- AnyFormat = "all-outputs"
43
- }
44
- /**
45
- * Represents a camera configuration, consisting of a camera position and target.
46
- */
47
- export declare type CameraConfiguration = {
48
- readonly position: THREE.Vector3;
49
- readonly target: THREE.Vector3;
50
- };
51
- export interface BlobOutputMetadata {
52
- blobId: number;
53
- format: File3dFormat | string;
54
- version: number;
55
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { HttpHeaders } from '@cognite/sdk-core';
5
+ export interface JsonFileProvider {
6
+ getJsonFile(baseUrl: string, fileName: string): Promise<any>;
7
+ }
8
+ export interface BinaryFileProvider {
9
+ getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
10
+ }
11
+ /**
12
+ * Provides data for 3D models.
13
+ * @version New since 2.2
14
+ */
15
+ export interface ModelDataProvider extends HttpHeadersProvider, JsonFileProvider, BinaryFileProvider {
16
+ /**
17
+ * Download and parse a JSON file and return the resulting struct.
18
+ * @param baseUrl Base URL of the model.
19
+ * @param fileName Filename of JSON file.
20
+ */
21
+ getJsonFile(baseUrl: string, fileName: string): Promise<any>;
22
+ /**
23
+ * Downloads a binary blob.
24
+ * @param baseUrl Base URL of the model.
25
+ * @param fileName Filename of binary file.
26
+ */
27
+ getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
28
+ }
29
+ export interface HttpHeadersProvider {
30
+ readonly headers: HttpHeaders;
31
+ }
32
+ export declare enum File3dFormat {
33
+ EptPointCloud = "ept-pointcloud",
34
+ RevealCadModel = "reveal-directory",
35
+ AnyFormat = "all-outputs"
36
+ }
37
+ export interface BlobOutputMetadata {
38
+ blobId: number;
39
+ format: File3dFormat | string;
40
+ version: number;
41
+ }
@@ -1,7 +1,7 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import { Versioned3DFile } from '@cognite/sdk';
5
- export declare const supportedVersions: number[];
6
- export declare function getNewestVersionedFile(files: Versioned3DFile[]): Versioned3DFile;
7
- export declare function fetchWithStatusCheck(url: string): Promise<Response>;
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { Versioned3DFile } from '@cognite/sdk';
5
+ export declare const supportedVersions: number[];
6
+ export declare function getNewestVersionedFile(files: Versioned3DFile[]): Versioned3DFile;
7
+ export declare function fetchWithStatusCheck(url: string): Promise<Response>;
@@ -1,7 +1,6 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- export { NodesApiClient } from './src/NodesApiClient';
5
- export { NodesCdfClient } from './src/NodesCdfClient';
6
- export { NodesLocalClient } from './src/NodesLocalClient';
7
- export { NodeTreeIndexAndSubtreeSize } from './src/types';
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ export { NodesApiClient } from './src/NodesApiClient';
5
+ export { NodesCdfClient } from './src/NodesCdfClient';
6
+ export { NodesLocalClient } from './src/NodesLocalClient';
@@ -1,43 +1,52 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { CogniteInternalId } from '@cognite/sdk';
6
- import { NodeTreeIndexAndSubtreeSize } from './types';
7
- export interface NodesApiClient {
8
- /**
9
- * Maps a set of "tree indexes" that identify nodes, to the respective
10
- * "node IDs".
11
- */
12
- mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
13
- /**
14
- * Maps a set of "node IDs" that identify nodes, to the respective
15
- * "tree indexes".
16
- */
17
- mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
18
- /**
19
- * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
20
- * of) given a set of node IDs.
21
- */
22
- determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<NodeTreeIndexAndSubtreeSize[]>;
23
- /**
24
- * Determine ancestor subtree span of a given node. If the node doesn't have an
25
- * ancestor at the generation given, the span of the root node is returned.
26
- * @param modelId ID of 3D model
27
- * @param revisionId ID of 3D model revision
28
- * @param nodeId Node ID of node
29
- * @param generation Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc).
30
- */
31
- determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<NodeTreeIndexAndSubtreeSize>;
32
- /**
33
- * Determines the bounds of the node provided. Note that the returned
34
- * box returned will be in "CDF coordinates" and not transformed using
35
- * the model transformation for the given model.
36
- *
37
- * @param modelId ID of 3D model
38
- * @param revisionId ID of 3D model revision
39
- * @param nodeId Node ID of node
40
- * @param box Pre-allocated THREE.Box3 (optional).
41
- */
42
- getBoundingBoxByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, box?: THREE.Box3): Promise<THREE.Box3>;
43
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { CogniteInternalId } from '@cognite/sdk';
6
+ /**
7
+ * Client for retrieving metadata information about CAD nodes.
8
+ * @version New since 2.2
9
+ */
10
+ export interface NodesApiClient {
11
+ /**
12
+ * Maps a set of "tree indexes" that identify nodes, to the respective
13
+ * "node IDs".
14
+ */
15
+ mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
16
+ /**
17
+ * Maps a set of "node IDs" that identify nodes, to the respective
18
+ * "tree indexes".
19
+ */
20
+ mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
21
+ /**
22
+ * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
23
+ * of) given a set of node IDs.
24
+ */
25
+ determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
26
+ treeIndex: number;
27
+ subtreeSize: number;
28
+ }[]>;
29
+ /**
30
+ * Determine ancestor subtree span of a given node. If the node doesn't have an
31
+ * ancestor at the generation given, the span of the root node is returned.
32
+ * @param modelId ID of 3D model
33
+ * @param revisionId ID of 3D model revision
34
+ * @param nodeId Node ID of node
35
+ * @param generation Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc).
36
+ */
37
+ determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
38
+ treeIndex: number;
39
+ subtreeSize: number;
40
+ }>;
41
+ /**
42
+ * Determines the bounds of the node provided. Note that the returned
43
+ * box returned will be in "CDF coordinates" and not transformed using
44
+ * the model transformation for the given model.
45
+ *
46
+ * @param modelId ID of 3D model
47
+ * @param revisionId ID of 3D model revision
48
+ * @param nodeId Node ID of node
49
+ * @param box Pre-allocated THREE.Box3 (optional).
50
+ */
51
+ getBoundingBoxByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, box?: THREE.Box3): Promise<THREE.Box3>;
52
+ }
@@ -1,19 +1,24 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { CogniteClient, CogniteInternalId } from '@cognite/sdk';
6
- import { NodesApiClient } from './NodesApiClient';
7
- import { NodeTreeIndexAndSubtreeSize } from './types';
8
- export declare class NodesCdfClient implements NodesApiClient {
9
- private static readonly MaxItemsPerRequest;
10
- private readonly _client;
11
- constructor(client: CogniteClient);
12
- mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<number[]>;
13
- mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
14
- determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<NodeTreeIndexAndSubtreeSize[]>;
15
- determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<NodeTreeIndexAndSubtreeSize>;
16
- getBoundingBoxByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, box?: THREE.Box3): Promise<THREE.Box3>;
17
- private postByTreeIndicesRequest;
18
- private postByNodeIdsRequest;
19
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { CogniteClient, CogniteInternalId } from '@cognite/sdk';
6
+ import { NodesApiClient } from './NodesApiClient';
7
+ export declare class NodesCdfClient implements NodesApiClient {
8
+ private static readonly MaxItemsPerRequest;
9
+ private readonly _client;
10
+ constructor(client: CogniteClient);
11
+ mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<number[]>;
12
+ mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
13
+ determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
14
+ treeIndex: number;
15
+ subtreeSize: number;
16
+ }[]>;
17
+ determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
18
+ treeIndex: number;
19
+ subtreeSize: number;
20
+ }>;
21
+ getBoundingBoxByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, box?: THREE.Box3): Promise<THREE.Box3>;
22
+ private postByTreeIndicesRequest;
23
+ private postByNodeIdsRequest;
24
+ }
@@ -1,25 +1,30 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import * as THREE from 'three';
5
- import { NodesApiClient } from './NodesApiClient';
6
- import { CogniteInternalId } from '@cognite/sdk';
7
- import { NodeTreeIndexAndSubtreeSize } from './types';
8
- export declare class NodesLocalClient implements NodesApiClient {
9
- constructor(_modelBaseUrl: string);
10
- mapTreeIndicesToNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
11
- mapNodeIdsToTreeIndices(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
12
- /**
13
- * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
14
- * of) given a set of node IDs.
15
- */
16
- determineTreeIndexAndSubtreeSizesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<NodeTreeIndexAndSubtreeSize[]>;
17
- /**
18
- * Not supported.
19
- */
20
- determineNodeAncestorsByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _generation: number): Promise<NodeTreeIndexAndSubtreeSize>;
21
- /**
22
- * Not supported.
23
- */
24
- getBoundingBoxByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _box?: THREE.Box3): Promise<THREE.Box3>;
25
- }
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import * as THREE from 'three';
5
+ import { NodesApiClient } from './NodesApiClient';
6
+ import { CogniteInternalId } from '@cognite/sdk';
7
+ export declare class NodesLocalClient implements NodesApiClient {
8
+ constructor();
9
+ mapTreeIndicesToNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
10
+ mapNodeIdsToTreeIndices(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
11
+ /**
12
+ * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
13
+ * of) given a set of node IDs.
14
+ */
15
+ determineTreeIndexAndSubtreeSizesByNodeIds(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeIds: CogniteInternalId[]): Promise<{
16
+ treeIndex: number;
17
+ subtreeSize: number;
18
+ }[]>;
19
+ /**
20
+ * Not supported.
21
+ */
22
+ determineNodeAncestorsByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _generation: number): Promise<{
23
+ treeIndex: number;
24
+ subtreeSize: number;
25
+ }>;
26
+ /**
27
+ * Not supported.
28
+ */
29
+ getBoundingBoxByNodeId(_modelId: CogniteInternalId, _revisionId: CogniteInternalId, _nodeId: CogniteInternalId, _box?: THREE.Box3): Promise<THREE.Box3>;
30
+ }
@@ -1,14 +1,10 @@
1
- /*!
2
- * Copyright 2021 Cognite AS
3
- */
4
- import { CogniteInternalId } from '@cognite/sdk';
5
- export declare type ByTreeIndicesResponse = {
6
- items: CogniteInternalId[];
7
- };
8
- export declare type ByNodeIdsResponse = {
9
- items: number[];
10
- };
11
- export declare type NodeTreeIndexAndSubtreeSize = {
12
- treeIndex: number;
13
- subtreeSize: number;
14
- };
1
+ /*!
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ import { CogniteInternalId } from '@cognite/sdk';
5
+ export declare type ByTreeIndicesResponse = {
6
+ items: CogniteInternalId[];
7
+ };
8
+ export declare type ByNodeIdsResponse = {
9
+ items: number[];
10
+ };
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Copyright 2021 Cognite AS
3
+ */
4
+ export { SectorQuads } from './src/rendering/types';
5
+ export { CadMaterialManager } from './src/CadMaterialManager';
6
+ export { createSimpleGeometryMesh } from './src/rendering/createSimpleGeometryMesh';
7
+ export { NodeAppearanceTextureBuilder } from './src/rendering/NodeAppearanceTextureBuilder';
8
+ export { NodeTransformTextureBuilder } from './src/transform/NodeTransformTextureBuilder';
9
+ export { NodeTransformProvider } from './src/transform/NodeTransformProvider';
10
+ export { CogniteColors, RevealColors } from './src/utilities/types';
11
+ export { CadNode, SuggestedCameraConfig } from './src/sector/CadNode';
12
+ export { RenderOptions, defaultRenderOptions, SsaoParameters, SsaoSampleQuality, AntiAliasingMode } from './src/rendering/types';
13
+ export { EffectRenderManager } from './src/rendering/EffectRenderManager';
14
+ export { RenderMode } from './src/rendering/RenderMode';
15
+ export { coverageShaders } from './src/rendering/shaders';
16
+ export { Materials, createMaterials } from './src/rendering/materials';
17
+ export { createPrimitives } from './src/rendering/primitives';