@itwin/core-backend 3.5.0-dev.63 → 3.5.0-dev.66
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/CHANGELOG.md +16 -1
- package/lib/cjs/AliCloudStorageService.d.ts +23 -23
- package/lib/cjs/AliCloudStorageService.js +71 -71
- package/lib/cjs/AliCloudStorageService.js.map +1 -1
- package/lib/cjs/BackendHubAccess.d.ts +224 -224
- package/lib/cjs/BackendHubAccess.js +41 -41
- package/lib/cjs/BackendHubAccess.js.map +1 -1
- package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
- package/lib/cjs/BackendLoggerCategory.js +99 -99
- package/lib/cjs/BackendLoggerCategory.js.map +1 -1
- package/lib/cjs/BisCoreSchema.d.ts +21 -21
- package/lib/cjs/BisCoreSchema.js +60 -60
- package/lib/cjs/BisCoreSchema.js.map +1 -1
- package/lib/cjs/BriefcaseManager.d.ts +170 -170
- package/lib/cjs/BriefcaseManager.js +413 -413
- package/lib/cjs/BriefcaseManager.js.map +1 -1
- package/lib/cjs/Category.d.ts +153 -153
- package/lib/cjs/Category.js +243 -243
- package/lib/cjs/Category.js.map +1 -1
- package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
- package/lib/cjs/ChangeSummaryManager.js +447 -447
- package/lib/cjs/ChangeSummaryManager.js.map +1 -1
- package/lib/cjs/ChangedElementsDb.d.ts +99 -99
- package/lib/cjs/ChangedElementsDb.js +165 -165
- package/lib/cjs/ChangedElementsDb.js.map +1 -1
- package/lib/cjs/ChangedElementsManager.d.ts +39 -39
- package/lib/cjs/ChangedElementsManager.js +88 -88
- package/lib/cjs/ChangedElementsManager.js.map +1 -1
- package/lib/cjs/CheckpointManager.d.ts +120 -120
- package/lib/cjs/CheckpointManager.js +343 -343
- package/lib/cjs/CheckpointManager.js.map +1 -1
- package/lib/cjs/ClassRegistry.d.ts +79 -79
- package/lib/cjs/ClassRegistry.js +249 -249
- package/lib/cjs/ClassRegistry.js.map +1 -1
- package/lib/cjs/CloudSqlite.d.ts +350 -350
- package/lib/cjs/CloudSqlite.js +152 -152
- package/lib/cjs/CloudSqlite.js.map +1 -1
- package/lib/cjs/CloudStorageBackend.d.ts +58 -58
- package/lib/cjs/CloudStorageBackend.js +173 -173
- package/lib/cjs/CloudStorageBackend.js.map +1 -1
- package/lib/cjs/CodeService.d.ts +396 -396
- package/lib/cjs/CodeService.js +63 -63
- package/lib/cjs/CodeService.js.map +1 -1
- package/lib/cjs/CodeSpecs.d.ts +50 -50
- package/lib/cjs/CodeSpecs.js +112 -112
- package/lib/cjs/CodeSpecs.js.map +1 -1
- package/lib/cjs/ConcurrentQuery.d.ts +13 -13
- package/lib/cjs/ConcurrentQuery.js +36 -36
- package/lib/cjs/ConcurrentQuery.js.map +1 -1
- package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
- package/lib/cjs/CustomViewState3dCreator.js +81 -81
- package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
- package/lib/cjs/DevTools.d.ts +71 -71
- package/lib/cjs/DevTools.js +154 -154
- package/lib/cjs/DevTools.js.map +1 -1
- package/lib/cjs/DisplayStyle.d.ts +106 -106
- package/lib/cjs/DisplayStyle.js +256 -256
- package/lib/cjs/DisplayStyle.js.map +1 -1
- package/lib/cjs/ECDb.d.ts +191 -191
- package/lib/cjs/ECDb.js +350 -350
- package/lib/cjs/ECDb.js.map +1 -1
- package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
- package/lib/cjs/ECSchemaXmlContext.js +41 -41
- package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
- package/lib/cjs/ECSqlStatement.d.ts +466 -466
- package/lib/cjs/ECSqlStatement.js +791 -791
- package/lib/cjs/ECSqlStatement.js.map +1 -1
- package/lib/cjs/Element.d.ts +1102 -1102
- package/lib/cjs/Element.js +1416 -1416
- package/lib/cjs/Element.js.map +1 -1
- package/lib/cjs/ElementAspect.d.ts +176 -176
- package/lib/cjs/ElementAspect.js +211 -211
- package/lib/cjs/ElementAspect.js.map +1 -1
- package/lib/cjs/ElementGraphics.d.ts +9 -9
- package/lib/cjs/ElementGraphics.js +41 -41
- package/lib/cjs/ElementGraphics.js.map +1 -1
- package/lib/cjs/ElementTreeWalker.d.ts +162 -162
- package/lib/cjs/ElementTreeWalker.js +409 -409
- package/lib/cjs/ElementTreeWalker.js.map +1 -1
- package/lib/cjs/Entity.d.ts +106 -106
- package/lib/cjs/Entity.js +134 -134
- package/lib/cjs/Entity.js.map +1 -1
- package/lib/cjs/EntityReferences.d.ts +49 -49
- package/lib/cjs/EntityReferences.js +95 -95
- package/lib/cjs/EntityReferences.js.map +1 -1
- package/lib/cjs/ExportGraphics.d.ts +317 -317
- package/lib/cjs/ExportGraphics.js +208 -208
- package/lib/cjs/ExportGraphics.js.map +1 -1
- package/lib/cjs/ExternalSource.d.ts +96 -96
- package/lib/cjs/ExternalSource.js +131 -131
- package/lib/cjs/ExternalSource.js.map +1 -1
- package/lib/cjs/GeoCoordConfig.d.ts +19 -19
- package/lib/cjs/GeoCoordConfig.js +85 -85
- package/lib/cjs/GeoCoordConfig.js.map +1 -1
- package/lib/cjs/GeometrySummary.d.ts +4 -4
- package/lib/cjs/GeometrySummary.js +380 -380
- package/lib/cjs/GeometrySummary.js.map +1 -1
- package/lib/cjs/HubMock.d.ts +94 -94
- package/lib/cjs/HubMock.js +222 -222
- package/lib/cjs/HubMock.js.map +1 -1
- package/lib/cjs/IModelCloneContext.d.ts +8 -8
- package/lib/cjs/IModelCloneContext.js +15 -15
- package/lib/cjs/IModelCloneContext.js.map +1 -1
- package/lib/cjs/IModelDb.d.ts +1183 -1183
- package/lib/cjs/IModelDb.js +2374 -2374
- package/lib/cjs/IModelDb.js.map +1 -1
- package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
- package/lib/cjs/IModelElementCloneContext.js +159 -159
- package/lib/cjs/IModelElementCloneContext.js.map +1 -1
- package/lib/cjs/IModelHost.d.ts +370 -370
- package/lib/cjs/IModelHost.js +496 -496
- package/lib/cjs/IModelHost.js.map +1 -1
- package/lib/cjs/IModelJsFs.d.ts +62 -62
- package/lib/cjs/IModelJsFs.js +140 -140
- package/lib/cjs/IModelJsFs.js.map +1 -1
- package/lib/cjs/IpcHost.d.ts +104 -104
- package/lib/cjs/IpcHost.js +278 -278
- package/lib/cjs/IpcHost.js.map +1 -1
- package/lib/cjs/LineStyle.d.ts +311 -311
- package/lib/cjs/LineStyle.js +295 -295
- package/lib/cjs/LineStyle.js.map +1 -1
- package/lib/cjs/LocalHub.d.ts +162 -162
- package/lib/cjs/LocalHub.js +587 -587
- package/lib/cjs/LocalHub.js.map +1 -1
- package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
- package/lib/cjs/LocalhostIpcHost.js +81 -81
- package/lib/cjs/LocalhostIpcHost.js.map +1 -1
- package/lib/cjs/Material.d.ts +103 -103
- package/lib/cjs/Material.js +147 -147
- package/lib/cjs/Material.js.map +1 -1
- package/lib/cjs/Model.d.ts +392 -392
- package/lib/cjs/Model.js +485 -485
- package/lib/cjs/Model.js.map +1 -1
- package/lib/cjs/NativeAppStorage.d.ts +51 -51
- package/lib/cjs/NativeAppStorage.js +202 -202
- package/lib/cjs/NativeAppStorage.js.map +1 -1
- package/lib/cjs/NativeHost.d.ts +52 -52
- package/lib/cjs/NativeHost.js +163 -163
- package/lib/cjs/NativeHost.js.map +1 -1
- package/lib/cjs/NavigationRelationship.d.ts +156 -156
- package/lib/cjs/NavigationRelationship.js +225 -225
- package/lib/cjs/NavigationRelationship.js.map +1 -1
- package/lib/cjs/PromiseMemoizer.d.ts +51 -51
- package/lib/cjs/PromiseMemoizer.js +101 -101
- package/lib/cjs/PromiseMemoizer.js.map +1 -1
- package/lib/cjs/PropertyStore.d.ts +132 -132
- package/lib/cjs/PropertyStore.js +11 -11
- package/lib/cjs/PropertyStore.js.map +1 -1
- package/lib/cjs/Relationship.d.ts +416 -416
- package/lib/cjs/Relationship.js +494 -494
- package/lib/cjs/Relationship.js.map +1 -1
- package/lib/cjs/RpcBackend.d.ts +5 -5
- package/lib/cjs/RpcBackend.js +31 -31
- package/lib/cjs/RpcBackend.js.map +1 -1
- package/lib/cjs/SQLiteDb.d.ts +219 -219
- package/lib/cjs/SQLiteDb.js +214 -214
- package/lib/cjs/SQLiteDb.js.map +1 -1
- package/lib/cjs/Schema.d.ts +55 -55
- package/lib/cjs/Schema.js +83 -83
- package/lib/cjs/Schema.js.map +1 -1
- package/lib/cjs/ServerBasedLocks.d.ts +57 -57
- package/lib/cjs/ServerBasedLocks.js +168 -168
- package/lib/cjs/ServerBasedLocks.js.map +1 -1
- package/lib/cjs/SqliteStatement.d.ts +360 -360
- package/lib/cjs/SqliteStatement.js +586 -586
- package/lib/cjs/SqliteStatement.js.map +1 -1
- package/lib/cjs/Texture.d.ts +58 -58
- package/lib/cjs/Texture.js +82 -82
- package/lib/cjs/Texture.js.map +1 -1
- package/lib/cjs/TileStorage.d.ts +18 -18
- package/lib/cjs/TileStorage.js +90 -90
- package/lib/cjs/TileStorage.js.map +1 -1
- package/lib/cjs/TxnManager.d.ts +202 -202
- package/lib/cjs/TxnManager.js +356 -356
- package/lib/cjs/TxnManager.js.map +1 -1
- package/lib/cjs/ViewDefinition.d.ts +439 -439
- package/lib/cjs/ViewDefinition.js +646 -646
- package/lib/cjs/ViewDefinition.js.map +1 -1
- package/lib/cjs/ViewStateHydrator.d.ts +13 -13
- package/lib/cjs/ViewStateHydrator.js +103 -103
- package/lib/cjs/ViewStateHydrator.js.map +1 -1
- package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
- package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
- package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
- package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
- package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
- package/lib/cjs/core-backend.d.ts +184 -184
- package/lib/cjs/core-backend.js +204 -204
- package/lib/cjs/core-backend.js.map +1 -1
- package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
- package/lib/cjs/domains/FunctionalElements.js +145 -145
- package/lib/cjs/domains/FunctionalElements.js.map +1 -1
- package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
- package/lib/cjs/domains/FunctionalSchema.js +40 -40
- package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
- package/lib/cjs/domains/GenericElements.d.ts +177 -177
- package/lib/cjs/domains/GenericElements.js +263 -263
- package/lib/cjs/domains/GenericElements.js.map +1 -1
- package/lib/cjs/domains/GenericSchema.d.ts +10 -10
- package/lib/cjs/domains/GenericSchema.js +28 -28
- package/lib/cjs/domains/GenericSchema.js.map +1 -1
- package/lib/cjs/rpc/multipart.d.ts +11 -11
- package/lib/cjs/rpc/multipart.js +70 -70
- package/lib/cjs/rpc/multipart.js.map +1 -1
- package/lib/cjs/rpc/tracing.d.ts +28 -28
- package/lib/cjs/rpc/tracing.js +73 -73
- package/lib/cjs/rpc/tracing.js.map +1 -1
- package/lib/cjs/rpc/web/logging.d.ts +9 -9
- package/lib/cjs/rpc/web/logging.js +42 -42
- package/lib/cjs/rpc/web/logging.js.map +1 -1
- package/lib/cjs/rpc/web/request.d.ts +6 -6
- package/lib/cjs/rpc/web/request.js +73 -73
- package/lib/cjs/rpc/web/request.js.map +1 -1
- package/lib/cjs/rpc/web/response.d.ts +6 -6
- package/lib/cjs/rpc/web/response.js +105 -105
- package/lib/cjs/rpc/web/response.js.map +1 -1
- package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
- package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
- package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
- package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
- package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +291 -291
- package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
- package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
- package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +202 -202
- package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
- package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
- package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +168 -168
- package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
- package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
- package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +43 -43
- package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
- package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
- package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
- package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
- package/lib/cjs/workspace/Settings.d.ts +186 -186
- package/lib/cjs/workspace/Settings.js +155 -155
- package/lib/cjs/workspace/Settings.js.map +1 -1
- package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
- package/lib/cjs/workspace/SettingsSchemas.js +191 -191
- package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
- package/lib/cjs/workspace/Workspace.d.ts +414 -414
- package/lib/cjs/workspace/Workspace.js +543 -543
- package/lib/cjs/workspace/Workspace.js.map +1 -1
- package/package.json +12 -12
|
@@ -1,647 +1,647 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
|
6
|
-
/** @packageDocumentation
|
|
7
|
-
* @module ViewDefinitions
|
|
8
|
-
*/
|
|
9
|
-
var _a, _b, _c, _d;
|
|
10
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
-
exports.LightLocation = exports.ViewAttachment = exports.AuxCoordSystemSpatial = exports.AuxCoordSystem3d = exports.AuxCoordSystem2d = exports.AuxCoordSystem = exports.TemplateViewDefinition3d = exports.TemplateViewDefinition2d = exports.SheetViewDefinition = exports.DrawingViewDefinition = exports.ViewDefinition2d = exports.OrthographicViewDefinition = exports.SpatialViewDefinition = exports.ViewDefinition3d = exports.ViewDefinition = exports.CategorySelector = exports.ModelSelector = void 0;
|
|
12
|
-
const core_bentley_1 = require("@itwin/core-bentley");
|
|
13
|
-
const core_geometry_1 = require("@itwin/core-geometry");
|
|
14
|
-
const core_common_1 = require("@itwin/core-common");
|
|
15
|
-
const Element_1 = require("./Element");
|
|
16
|
-
/** Holds the list of Ids of GeometricModels displayed by a [[SpatialViewDefinition]]. Multiple SpatialViewDefinitions may point to the same ModelSelector.
|
|
17
|
-
* @see [ModelSelectorState]($frontend)
|
|
18
|
-
* See [how to create a ModelSelector]$(docs/learning/backend/CreateElements.md#ModelSelector).
|
|
19
|
-
* @public
|
|
20
|
-
*/
|
|
21
|
-
class ModelSelector extends Element_1.DefinitionElement {
|
|
22
|
-
/** @internal */
|
|
23
|
-
constructor(props, iModel) {
|
|
24
|
-
super(props, iModel);
|
|
25
|
-
this.models = props.models;
|
|
26
|
-
}
|
|
27
|
-
/** @internal */
|
|
28
|
-
static get className() { return "ModelSelector"; }
|
|
29
|
-
/** @internal */
|
|
30
|
-
toJSON() {
|
|
31
|
-
const val = super.toJSON();
|
|
32
|
-
val.models = this.models;
|
|
33
|
-
return val;
|
|
34
|
-
}
|
|
35
|
-
/** @internal */
|
|
36
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
37
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
38
|
-
this.models.forEach((modelId) => referenceIds.addModel(modelId));
|
|
39
|
-
}
|
|
40
|
-
/** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
41
|
-
* @param iModel The IModelDb
|
|
42
|
-
* @param scopeModelId The Id of the DefinitionModel that contains the ModelSelector and provides the scope for its name.
|
|
43
|
-
* @param codeValue The ModelSelector name
|
|
44
|
-
*/
|
|
45
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
46
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.modelSelector);
|
|
47
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Create a ModelSelector to select which Models are displayed by a ViewDefinition.
|
|
51
|
-
* @param iModelDb The iModel
|
|
52
|
-
* @param definitionModelId The [[DefinitionModel]]
|
|
53
|
-
* @param name The name/CodeValue of the ModelSelector
|
|
54
|
-
* @param models Array of models to select for display
|
|
55
|
-
* @returns The newly constructed ModelSelector element.
|
|
56
|
-
* @throws [[IModelError]] if unable to create the element.
|
|
57
|
-
*/
|
|
58
|
-
static create(iModelDb, definitionModelId, name, models) {
|
|
59
|
-
const modelSelectorProps = {
|
|
60
|
-
classFullName: this.classFullName,
|
|
61
|
-
code: this.createCode(iModelDb, definitionModelId, name),
|
|
62
|
-
model: definitionModelId,
|
|
63
|
-
models,
|
|
64
|
-
isPrivate: false,
|
|
65
|
-
};
|
|
66
|
-
return new ModelSelector(modelSelectorProps, iModelDb);
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Insert a ModelSelector to select which Models are displayed by a ViewDefinition.
|
|
70
|
-
* @param iModelDb Insert into this iModel
|
|
71
|
-
* @param definitionModelId Insert the new ModelSelector into this DefinitionModel
|
|
72
|
-
* @param name The name/CodeValue of the ModelSelector
|
|
73
|
-
* @param models Array of models to select for display
|
|
74
|
-
* @returns The Id of the newly inserted ModelSelector element.
|
|
75
|
-
* @throws [[IModelError]] if unable to insert the element.
|
|
76
|
-
*/
|
|
77
|
-
static insert(iModelDb, definitionModelId, name, models) {
|
|
78
|
-
const modelSelector = this.create(iModelDb, definitionModelId, name, models);
|
|
79
|
-
return iModelDb.elements.insertElement(modelSelector.toJSON());
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
exports.ModelSelector = ModelSelector;
|
|
83
|
-
/** Holds a list of Ids of Categories to be displayed in a view.
|
|
84
|
-
* @see [CategorySelectorState]($frontend)
|
|
85
|
-
* See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).
|
|
86
|
-
* @public
|
|
87
|
-
*/
|
|
88
|
-
class CategorySelector extends Element_1.DefinitionElement {
|
|
89
|
-
/** @internal */
|
|
90
|
-
constructor(props, iModel) {
|
|
91
|
-
super(props, iModel);
|
|
92
|
-
this.categories = props.categories;
|
|
93
|
-
}
|
|
94
|
-
/** @internal */
|
|
95
|
-
static get className() { return "CategorySelector"; }
|
|
96
|
-
/** @internal */
|
|
97
|
-
toJSON() {
|
|
98
|
-
const val = super.toJSON();
|
|
99
|
-
val.categories = this.categories;
|
|
100
|
-
return val;
|
|
101
|
-
}
|
|
102
|
-
/** @internal */
|
|
103
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
104
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
105
|
-
this.categories.forEach((categoryId) => referenceIds.addElement(categoryId));
|
|
106
|
-
}
|
|
107
|
-
/** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
108
|
-
* @param iModel The IModelDb
|
|
109
|
-
* @param scopeModelId The Id of the DefinitionModel that contains the CategorySelector and provides the scope for its name.
|
|
110
|
-
* @param codeValue The CategorySelector name
|
|
111
|
-
*/
|
|
112
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
113
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.categorySelector);
|
|
114
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
115
|
-
}
|
|
116
|
-
/**
|
|
117
|
-
* Create a CategorySelector to select which categories are displayed by a ViewDefinition.
|
|
118
|
-
* @param iModelDb The iModel
|
|
119
|
-
* @param definitionModelId The [[DefinitionModel]]
|
|
120
|
-
* @param name The name of the CategorySelector
|
|
121
|
-
* @param categories Array of categories to select for display
|
|
122
|
-
* @returns The newly constructed CategorySelector element.
|
|
123
|
-
* @throws [[IModelError]] if unable to create the element.
|
|
124
|
-
*/
|
|
125
|
-
static create(iModelDb, definitionModelId, name, categories) {
|
|
126
|
-
const categorySelectorProps = {
|
|
127
|
-
classFullName: this.classFullName,
|
|
128
|
-
code: this.createCode(iModelDb, definitionModelId, name),
|
|
129
|
-
model: definitionModelId,
|
|
130
|
-
categories,
|
|
131
|
-
isPrivate: false,
|
|
132
|
-
};
|
|
133
|
-
return new CategorySelector(categorySelectorProps, iModelDb);
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Insert a CategorySelector to select which categories are displayed by a ViewDefinition.
|
|
137
|
-
* @param iModelDb Insert into this iModel
|
|
138
|
-
* @param definitionModelId Insert the new CategorySelector into this DefinitionModel
|
|
139
|
-
* @param name The name of the CategorySelector
|
|
140
|
-
* @param categories Array of categories to select for display
|
|
141
|
-
* @returns The Id of the newly inserted CategorySelector element.
|
|
142
|
-
* @throws [[IModelError]] if unable to insert the element.
|
|
143
|
-
*/
|
|
144
|
-
static insert(iModelDb, definitionModelId, name, categories) {
|
|
145
|
-
const categorySelector = this.create(iModelDb, definitionModelId, name, categories);
|
|
146
|
-
return iModelDb.elements.insertElement(categorySelector.toJSON());
|
|
147
|
-
}
|
|
148
|
-
}
|
|
149
|
-
exports.CategorySelector = CategorySelector;
|
|
150
|
-
/**
|
|
151
|
-
* The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
|
|
152
|
-
* plus additional view-specific parameters in their [[Element.jsonProperties]].
|
|
153
|
-
*
|
|
154
|
-
* Subclasses of ViewDefinition determine which model(s) are viewed.
|
|
155
|
-
*
|
|
156
|
-
* **Example: Obtaining the background color for a view**
|
|
157
|
-
* ``` ts
|
|
158
|
-
* [[include:ViewDefinition.getBackgroundColor]]
|
|
159
|
-
* ```
|
|
160
|
-
*
|
|
161
|
-
* @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
|
|
162
|
-
* @public
|
|
163
|
-
*/
|
|
164
|
-
class ViewDefinition extends (_b = Element_1.DefinitionElement) {
|
|
165
|
-
/** @internal */
|
|
166
|
-
constructor(props, iModel) {
|
|
167
|
-
super(props, iModel);
|
|
168
|
-
this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
|
|
169
|
-
if (!core_bentley_1.Id64.isValid(this.categorySelectorId))
|
|
170
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `categorySelectorId is invalid`);
|
|
171
|
-
this.displayStyleId = core_bentley_1.Id64.fromJSON(props.displayStyleId);
|
|
172
|
-
if (!core_bentley_1.Id64.isValid(this.displayStyleId))
|
|
173
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `displayStyleId is invalid`);
|
|
174
|
-
}
|
|
175
|
-
/** @internal */
|
|
176
|
-
static get className() { return "ViewDefinition"; }
|
|
177
|
-
/** @internal */
|
|
178
|
-
toJSON() {
|
|
179
|
-
const json = super.toJSON();
|
|
180
|
-
json.categorySelectorId = this.categorySelectorId;
|
|
181
|
-
json.displayStyleId = this.displayStyleId;
|
|
182
|
-
return json;
|
|
183
|
-
}
|
|
184
|
-
/** @internal */
|
|
185
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
186
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
187
|
-
referenceIds.addElement(this.categorySelectorId);
|
|
188
|
-
referenceIds.addElement(this.displayStyleId);
|
|
189
|
-
const acsId = this.getAuxiliaryCoordinateSystemId();
|
|
190
|
-
if (core_bentley_1.Id64.isValidId64(acsId)) {
|
|
191
|
-
referenceIds.addElement(acsId);
|
|
192
|
-
}
|
|
193
|
-
}
|
|
194
|
-
/** @internal */
|
|
195
|
-
static onCloned(context, sourceElementProps, targetElementProps) {
|
|
196
|
-
super.onCloned(context, sourceElementProps, targetElementProps);
|
|
197
|
-
if (context.isBetweenIModels && targetElementProps.jsonProperties && targetElementProps.jsonProperties.viewDetails) {
|
|
198
|
-
const acsId = core_bentley_1.Id64.fromJSON(targetElementProps.jsonProperties.viewDetails.acs);
|
|
199
|
-
if (core_bentley_1.Id64.isValidId64(acsId)) {
|
|
200
|
-
targetElementProps.jsonProperties.viewDetails.acs = context.findTargetElementId(acsId);
|
|
201
|
-
}
|
|
202
|
-
}
|
|
203
|
-
}
|
|
204
|
-
/** Type guard for `instanceof ViewDefinition3d` */
|
|
205
|
-
isView3d() { return this instanceof ViewDefinition3d; }
|
|
206
|
-
/** Type guard for 'instanceof ViewDefinition2d` */
|
|
207
|
-
isView2d() { return this instanceof ViewDefinition2d; }
|
|
208
|
-
/** Type guard for `instanceof SpatialViewDefinition` */
|
|
209
|
-
isSpatialView() { return this instanceof SpatialViewDefinition; }
|
|
210
|
-
/** Type guard for 'instanceof DrawingViewDefinition' */
|
|
211
|
-
isDrawingView() { return this instanceof DrawingViewDefinition; }
|
|
212
|
-
/** Load this view's DisplayStyle from the IModelDb. */
|
|
213
|
-
loadDisplayStyle() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
214
|
-
/** Load this view's CategorySelector from the IModelDb. */
|
|
215
|
-
loadCategorySelector() { return this.iModel.elements.getElement(this.categorySelectorId); }
|
|
216
|
-
/** The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined. */
|
|
217
|
-
getAuxiliaryCoordinateSystemId() {
|
|
218
|
-
return this.details.auxiliaryCoordinateSystemId;
|
|
219
|
-
}
|
|
220
|
-
/** Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
|
|
221
|
-
* @param acsId The Id of the new AuxiliaryCoordinateSystem. If `Id64.invalid` is passed, then no AuxiliaryCoordinateSystem will be used.
|
|
222
|
-
*/
|
|
223
|
-
setAuxiliaryCoordinateSystemId(acsId) {
|
|
224
|
-
this.details.auxiliaryCoordinateSystemId = acsId;
|
|
225
|
-
}
|
|
226
|
-
/** Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
227
|
-
* @param iModel The IModelDb
|
|
228
|
-
* @param scopeModelId The Id of the DefinitionModel to contain the ViewDefinition and provides the scope for its name.
|
|
229
|
-
* @param codeValue The ViewDefinition name
|
|
230
|
-
*/
|
|
231
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
232
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.viewDefinition);
|
|
233
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
234
|
-
}
|
|
235
|
-
}
|
|
236
|
-
exports.ViewDefinition = ViewDefinition;
|
|
237
|
-
_a = ViewDefinition;
|
|
238
|
-
/** @beta */
|
|
239
|
-
ViewDefinition.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "categorySelectorId", "displayStyleId"];
|
|
240
|
-
/** @alpha */
|
|
241
|
-
ViewDefinition.requiredReferenceKeyTypeMap = {
|
|
242
|
-
...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
|
|
243
|
-
categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
|
|
244
|
-
displayStyleId: core_common_1.ConcreteEntityTypes.Element,
|
|
245
|
-
};
|
|
246
|
-
/** Defines a view of one or more 3d models.
|
|
247
|
-
* @public
|
|
248
|
-
*/
|
|
249
|
-
class ViewDefinition3d extends ViewDefinition {
|
|
250
|
-
/** @internal */
|
|
251
|
-
constructor(props, iModel) {
|
|
252
|
-
super(props, iModel);
|
|
253
|
-
this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
|
|
254
|
-
this.origin = core_geometry_1.Point3d.fromJSON(props.origin);
|
|
255
|
-
this.extents = core_geometry_1.Vector3d.fromJSON(props.extents);
|
|
256
|
-
this.angles = core_geometry_1.YawPitchRollAngles.fromJSON(props.angles);
|
|
257
|
-
this.camera = new core_common_1.Camera(props.camera);
|
|
258
|
-
this._details = new core_common_1.ViewDetails3d(this.jsonProperties);
|
|
259
|
-
}
|
|
260
|
-
/** @internal */
|
|
261
|
-
static get className() { return "ViewDefinition3d"; }
|
|
262
|
-
/** @internal */
|
|
263
|
-
toJSON() {
|
|
264
|
-
const val = super.toJSON();
|
|
265
|
-
val.cameraOn = this.cameraOn;
|
|
266
|
-
val.origin = this.origin;
|
|
267
|
-
val.extents = this.extents;
|
|
268
|
-
val.angles = this.angles;
|
|
269
|
-
val.camera = this.camera;
|
|
270
|
-
return val;
|
|
271
|
-
}
|
|
272
|
-
/** Provides access to optional detail settings for this view. */
|
|
273
|
-
get details() { return this._details; }
|
|
274
|
-
/** Load this view's DisplayStyle3d from the IModelDb. */
|
|
275
|
-
loadDisplayStyle3d() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
276
|
-
}
|
|
277
|
-
exports.ViewDefinition3d = ViewDefinition3d;
|
|
278
|
-
/** Defines a view of one or more SpatialModels.
|
|
279
|
-
* The list of viewed models is stored by the ModelSelector.
|
|
280
|
-
*
|
|
281
|
-
* This is how a SpatialViewDefinition selects the elements to display:
|
|
282
|
-
*
|
|
283
|
-
* SpatialViewDefinition
|
|
284
|
-
* * ModelSelector
|
|
285
|
-
* * ModelIds -------> SpatialModels <----------GeometricElement3d.Model
|
|
286
|
-
* * CategorySelector
|
|
287
|
-
* * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
|
|
288
|
-
* @public
|
|
289
|
-
*/
|
|
290
|
-
class SpatialViewDefinition extends (_d = ViewDefinition3d) {
|
|
291
|
-
/** @internal */
|
|
292
|
-
constructor(props, iModel) {
|
|
293
|
-
super(props, iModel);
|
|
294
|
-
this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
|
|
295
|
-
if (!core_bentley_1.Id64.isValid(this.modelSelectorId))
|
|
296
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `modelSelectorId is invalid`);
|
|
297
|
-
}
|
|
298
|
-
/** @internal */
|
|
299
|
-
static get className() { return "SpatialViewDefinition"; }
|
|
300
|
-
/** @internal */
|
|
301
|
-
toJSON() {
|
|
302
|
-
const json = super.toJSON();
|
|
303
|
-
json.modelSelectorId = this.modelSelectorId;
|
|
304
|
-
return json;
|
|
305
|
-
}
|
|
306
|
-
/** @internal */
|
|
307
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
308
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
309
|
-
referenceIds.addElement(this.modelSelectorId);
|
|
310
|
-
}
|
|
311
|
-
/** Load this view's ModelSelector from the IModelDb. */
|
|
312
|
-
loadModelSelector() { return this.iModel.elements.getElement(this.modelSelectorId); }
|
|
313
|
-
/**
|
|
314
|
-
* Create an SpatialViewDefinition with camera.
|
|
315
|
-
* @param iModelDb The iModel
|
|
316
|
-
* @param definitionModelId The [[DefinitionModel]]
|
|
317
|
-
* @param name The name/CodeValue of the view
|
|
318
|
-
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
319
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
320
|
-
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
321
|
-
* @param range Defines the view origin and extents
|
|
322
|
-
* @param standardView Optionally defines the view's rotation
|
|
323
|
-
* @param cameraAngle Camera angle in radians.
|
|
324
|
-
* @returns The newly constructed OrthographicViewDefinition element
|
|
325
|
-
* @throws [[IModelError]] if there is a problem creating the view
|
|
326
|
-
*/
|
|
327
|
-
static createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
|
|
328
|
-
const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
|
|
329
|
-
const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
|
|
330
|
-
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
331
|
-
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
332
|
-
const cameraDistance = 2 * (rotatedRange.diagonal().magnitudeXY() / 2.0) / Math.tan(cameraAngle / 2.0);
|
|
333
|
-
const cameraLocation = rotatedRange.diagonalFractionToPoint(.5); // Start at center.
|
|
334
|
-
cameraLocation.z += cameraDistance; // Back up by camera distance.
|
|
335
|
-
rotation.multiplyTransposeVectorInPlace(cameraLocation);
|
|
336
|
-
const viewDefinitionProps = {
|
|
337
|
-
classFullName: this.classFullName,
|
|
338
|
-
model: definitionModelId,
|
|
339
|
-
code: this.createCode(iModelDb, definitionModelId, name),
|
|
340
|
-
modelSelectorId,
|
|
341
|
-
categorySelectorId,
|
|
342
|
-
displayStyleId,
|
|
343
|
-
origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
|
|
344
|
-
extents: rotatedRange.diagonal(),
|
|
345
|
-
angles,
|
|
346
|
-
cameraOn: true,
|
|
347
|
-
camera: { lens: { radians: cameraAngle }, focusDist: cameraDistance, eye: cameraLocation },
|
|
348
|
-
};
|
|
349
|
-
return new SpatialViewDefinition(viewDefinitionProps, iModelDb);
|
|
350
|
-
}
|
|
351
|
-
/**
|
|
352
|
-
* Insert an SpatialViewDefinition with camera On
|
|
353
|
-
* @param iModelDb Insert into this iModel
|
|
354
|
-
* @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
|
|
355
|
-
* @param name The name/CodeValue of the view
|
|
356
|
-
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
357
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
358
|
-
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
359
|
-
* @param range Defines the view origin and extents
|
|
360
|
-
* @param standardView Optionally defines the view's rotation
|
|
361
|
-
* @param cameraAngle Camera angle in radians.
|
|
362
|
-
* @returns The Id of the newly inserted OrthographicViewDefinition element
|
|
363
|
-
* @throws [[IModelError]] if there is an insert problem.
|
|
364
|
-
*/
|
|
365
|
-
static insertWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
|
|
366
|
-
const viewDefinition = this.createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView, cameraAngle);
|
|
367
|
-
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
368
|
-
}
|
|
369
|
-
}
|
|
370
|
-
exports.SpatialViewDefinition = SpatialViewDefinition;
|
|
371
|
-
_c = SpatialViewDefinition;
|
|
372
|
-
/** @beta */
|
|
373
|
-
SpatialViewDefinition.requiredReferenceKeys = [...Reflect.get(_d, "requiredReferenceKeys", _c), "modelSelectorId"];
|
|
374
|
-
/** @alpha */
|
|
375
|
-
SpatialViewDefinition.requiredReferenceKeyTypeMap = {
|
|
376
|
-
...Reflect.get(_d, "requiredReferenceKeyTypeMap", _c),
|
|
377
|
-
modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
|
|
378
|
-
};
|
|
379
|
-
/** Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
|
|
380
|
-
* See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
|
|
381
|
-
* @public
|
|
382
|
-
*/
|
|
383
|
-
class OrthographicViewDefinition extends SpatialViewDefinition {
|
|
384
|
-
/** @internal */
|
|
385
|
-
static get className() { return "OrthographicViewDefinition"; }
|
|
386
|
-
constructor(props, iModel) { super(props, iModel); }
|
|
387
|
-
/**
|
|
388
|
-
* Create an OrthographicViewDefinition
|
|
389
|
-
* @param iModelDb The iModel
|
|
390
|
-
* @param definitionModelId The [[DefinitionModel]]
|
|
391
|
-
* @param name The name/CodeValue of the view
|
|
392
|
-
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
393
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
394
|
-
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
395
|
-
* @param range Defines the view origin and extents
|
|
396
|
-
* @param standardView Optionally defines the view's rotation
|
|
397
|
-
* @returns The newly constructed OrthographicViewDefinition element
|
|
398
|
-
* @throws [[IModelError]] if there is a problem creating the view
|
|
399
|
-
*/
|
|
400
|
-
static create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
|
|
401
|
-
const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
|
|
402
|
-
const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
|
|
403
|
-
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
404
|
-
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
405
|
-
const viewDefinitionProps = {
|
|
406
|
-
classFullName: this.classFullName,
|
|
407
|
-
model: definitionModelId,
|
|
408
|
-
code: this.createCode(iModelDb, definitionModelId, name),
|
|
409
|
-
modelSelectorId,
|
|
410
|
-
categorySelectorId,
|
|
411
|
-
displayStyleId,
|
|
412
|
-
origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
|
|
413
|
-
extents: rotatedRange.diagonal(),
|
|
414
|
-
angles,
|
|
415
|
-
cameraOn: false,
|
|
416
|
-
camera: new core_common_1.Camera(), // not used when cameraOn === false
|
|
417
|
-
};
|
|
418
|
-
return new OrthographicViewDefinition(viewDefinitionProps, iModelDb);
|
|
419
|
-
}
|
|
420
|
-
/**
|
|
421
|
-
* Insert an OrthographicViewDefinition
|
|
422
|
-
* @param iModelDb Insert into this iModel
|
|
423
|
-
* @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
|
|
424
|
-
* @param name The name/CodeValue of the view
|
|
425
|
-
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
426
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
427
|
-
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
428
|
-
* @param range Defines the view origin and extents
|
|
429
|
-
* @param standardView Optionally defines the view's rotation
|
|
430
|
-
* @returns The Id of the newly inserted OrthographicViewDefinition element
|
|
431
|
-
* @throws [[IModelError]] if there is an insert problem.
|
|
432
|
-
*/
|
|
433
|
-
static insert(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
|
|
434
|
-
const viewDefinition = this.create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView);
|
|
435
|
-
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
436
|
-
}
|
|
437
|
-
/** Set a new viewed range without changing the rotation or any other properties. */
|
|
438
|
-
setRange(range) {
|
|
439
|
-
const rotation = this.angles.toMatrix3d();
|
|
440
|
-
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
441
|
-
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
442
|
-
this.origin = core_geometry_1.Point3d.createFrom(rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z));
|
|
443
|
-
this.extents = rotatedRange.diagonal();
|
|
444
|
-
}
|
|
445
|
-
}
|
|
446
|
-
exports.OrthographicViewDefinition = OrthographicViewDefinition;
|
|
447
|
-
/** Defines a view of a single 2d model. Each 2d model has its own coordinate system, so only one may appear per view.
|
|
448
|
-
* @public
|
|
449
|
-
*/
|
|
450
|
-
class ViewDefinition2d extends ViewDefinition {
|
|
451
|
-
/** @internal */
|
|
452
|
-
constructor(props, iModel) {
|
|
453
|
-
super(props, iModel);
|
|
454
|
-
this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
|
|
455
|
-
this.origin = core_geometry_1.Point2d.fromJSON(props.origin);
|
|
456
|
-
this.delta = core_geometry_1.Point2d.fromJSON(props.delta);
|
|
457
|
-
this.angle = core_geometry_1.Angle.fromJSON(props.angle);
|
|
458
|
-
this._details = new core_common_1.ViewDetails(this.jsonProperties);
|
|
459
|
-
}
|
|
460
|
-
/** @internal */
|
|
461
|
-
static get className() { return "ViewDefinition2d"; }
|
|
462
|
-
/** @internal */
|
|
463
|
-
toJSON() {
|
|
464
|
-
const val = super.toJSON();
|
|
465
|
-
val.baseModelId = this.baseModelId;
|
|
466
|
-
val.origin = this.origin;
|
|
467
|
-
val.delta = this.delta;
|
|
468
|
-
val.angle = this.angle;
|
|
469
|
-
return val;
|
|
470
|
-
}
|
|
471
|
-
/** @internal */
|
|
472
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
473
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
474
|
-
referenceIds.addElement(this.baseModelId);
|
|
475
|
-
}
|
|
476
|
-
/** Provides access to optional detail settings for this view. */
|
|
477
|
-
get details() { return this._details; }
|
|
478
|
-
/** Load this view's DisplayStyle2d from the IModelDb. */
|
|
479
|
-
loadDisplayStyle2d() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
480
|
-
}
|
|
481
|
-
exports.ViewDefinition2d = ViewDefinition2d;
|
|
482
|
-
/** Defines a view of a [[DrawingModel]].
|
|
483
|
-
* @public
|
|
484
|
-
*/
|
|
485
|
-
class DrawingViewDefinition extends ViewDefinition2d {
|
|
486
|
-
/** @internal */
|
|
487
|
-
static get className() { return "DrawingViewDefinition"; }
|
|
488
|
-
/** @internal */
|
|
489
|
-
constructor(props, iModel) {
|
|
490
|
-
super(props, iModel);
|
|
491
|
-
}
|
|
492
|
-
/** Create a DrawingViewDefinition
|
|
493
|
-
* @param iModelDb The iModel
|
|
494
|
-
* @param definitionModelId The [[DefinitionModel]]
|
|
495
|
-
* @param name The name/CodeValue of the view
|
|
496
|
-
* @param baseModelId The base [[DrawingModel]]
|
|
497
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
498
|
-
* @param displayStyleId The [[DisplayStyle2d]] that this view should use
|
|
499
|
-
* @param range Defines the view origin and extents
|
|
500
|
-
* @throws [[IModelError]] if there is a problem creating the element.
|
|
501
|
-
*/
|
|
502
|
-
static create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
|
|
503
|
-
const viewDefinitionProps = {
|
|
504
|
-
classFullName: this.classFullName,
|
|
505
|
-
model: definitionModelId,
|
|
506
|
-
code: this.createCode(iModelDb, definitionModelId, name),
|
|
507
|
-
baseModelId,
|
|
508
|
-
categorySelectorId,
|
|
509
|
-
displayStyleId,
|
|
510
|
-
origin: { x: range.low.x, y: range.low.y },
|
|
511
|
-
delta: range.diagonal(),
|
|
512
|
-
angle: 0,
|
|
513
|
-
};
|
|
514
|
-
return new DrawingViewDefinition(viewDefinitionProps, iModelDb);
|
|
515
|
-
}
|
|
516
|
-
/** Insert a DrawingViewDefinition
|
|
517
|
-
* @param iModelDb Insert into this iModel
|
|
518
|
-
* @param definitionModelId Insert the new DrawingViewDefinition into this [[DefinitionModel]]
|
|
519
|
-
* @param name The name/CodeValue of the view
|
|
520
|
-
* @param baseModelId The base [[DrawingModel]]
|
|
521
|
-
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
522
|
-
* @param displayStyleId The [[DisplayStyle2d]] that this view should use
|
|
523
|
-
* @param range Defines the view origin and extents
|
|
524
|
-
* @throws [[IModelError]] if there is an insert problem.
|
|
525
|
-
*/
|
|
526
|
-
static insert(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
|
|
527
|
-
const viewDefinition = this.create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range);
|
|
528
|
-
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
529
|
-
}
|
|
530
|
-
}
|
|
531
|
-
exports.DrawingViewDefinition = DrawingViewDefinition;
|
|
532
|
-
/** Defines a view of a [[SheetModel]].
|
|
533
|
-
* @public
|
|
534
|
-
*/
|
|
535
|
-
class SheetViewDefinition extends ViewDefinition2d {
|
|
536
|
-
/** @internal */
|
|
537
|
-
static get className() { return "SheetViewDefinition"; }
|
|
538
|
-
}
|
|
539
|
-
exports.SheetViewDefinition = SheetViewDefinition;
|
|
540
|
-
/** A ViewDefinition used to display a 2d template model.
|
|
541
|
-
* @internal
|
|
542
|
-
*/
|
|
543
|
-
class TemplateViewDefinition2d extends ViewDefinition2d {
|
|
544
|
-
/** @internal */
|
|
545
|
-
static get className() { return "TemplateViewDefinition2d"; }
|
|
546
|
-
}
|
|
547
|
-
exports.TemplateViewDefinition2d = TemplateViewDefinition2d;
|
|
548
|
-
/** A ViewDefinition used to display a 3d template model.
|
|
549
|
-
* @internal
|
|
550
|
-
*/
|
|
551
|
-
class TemplateViewDefinition3d extends ViewDefinition3d {
|
|
552
|
-
/** @internal */
|
|
553
|
-
static get className() { return "TemplateViewDefinition3d"; }
|
|
554
|
-
}
|
|
555
|
-
exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
|
|
556
|
-
/** An auxiliary coordinate system element. Auxiliary coordinate systems can be used by views to show
|
|
557
|
-
* coordinate information in different units and/or orientations.
|
|
558
|
-
* @public
|
|
559
|
-
*/
|
|
560
|
-
class AuxCoordSystem extends Element_1.DefinitionElement {
|
|
561
|
-
constructor(props, iModel) { super(props, iModel); }
|
|
562
|
-
/** @internal */
|
|
563
|
-
static get className() { return "AuxCoordSystem"; }
|
|
564
|
-
}
|
|
565
|
-
exports.AuxCoordSystem = AuxCoordSystem;
|
|
566
|
-
/** A 2d auxiliary coordinate system.
|
|
567
|
-
* @public
|
|
568
|
-
*/
|
|
569
|
-
class AuxCoordSystem2d extends AuxCoordSystem {
|
|
570
|
-
constructor(props, iModel) { super(props, iModel); }
|
|
571
|
-
/** @internal */
|
|
572
|
-
static get className() { return "AuxCoordSystem2d"; }
|
|
573
|
-
/** Create a Code for a AuxCoordSystem2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
574
|
-
* @param iModel The IModelDb
|
|
575
|
-
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem2d element and provides the scope for its name.
|
|
576
|
-
* @param codeValue The AuxCoordSystem2d name
|
|
577
|
-
*/
|
|
578
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
579
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem2d);
|
|
580
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
581
|
-
}
|
|
582
|
-
}
|
|
583
|
-
exports.AuxCoordSystem2d = AuxCoordSystem2d;
|
|
584
|
-
/** A 3d auxiliary coordinate system.
|
|
585
|
-
* @public
|
|
586
|
-
*/
|
|
587
|
-
class AuxCoordSystem3d extends AuxCoordSystem {
|
|
588
|
-
constructor(props, iModel) { super(props, iModel); }
|
|
589
|
-
/** @internal */
|
|
590
|
-
static get className() { return "AuxCoordSystem3d"; }
|
|
591
|
-
/** Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
592
|
-
* @param iModel The IModelDb
|
|
593
|
-
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem3d element and provides the scope for its name.
|
|
594
|
-
* @param codeValue The AuxCoordSystem3d name
|
|
595
|
-
*/
|
|
596
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
597
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem3d);
|
|
598
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
599
|
-
}
|
|
600
|
-
}
|
|
601
|
-
exports.AuxCoordSystem3d = AuxCoordSystem3d;
|
|
602
|
-
/** A spatial auxiliary coordinate system.
|
|
603
|
-
* @public
|
|
604
|
-
*/
|
|
605
|
-
class AuxCoordSystemSpatial extends AuxCoordSystem3d {
|
|
606
|
-
/** @internal */
|
|
607
|
-
static get className() { return "AuxCoordSystemSpatial"; }
|
|
608
|
-
/** Create a Code for a AuxCoordSystemSpatial element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
609
|
-
* @param iModel The IModelDb
|
|
610
|
-
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystemSpatial element and provides the scope for its name.
|
|
611
|
-
* @param codeValue The AuxCoordSystemSpatial name
|
|
612
|
-
*/
|
|
613
|
-
static createCode(iModel, scopeModelId, codeValue) {
|
|
614
|
-
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystemSpatial);
|
|
615
|
-
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
616
|
-
}
|
|
617
|
-
}
|
|
618
|
-
exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
|
|
619
|
-
/** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
|
|
620
|
-
* @public
|
|
621
|
-
*/
|
|
622
|
-
class ViewAttachment extends Element_1.GraphicalElement2d {
|
|
623
|
-
constructor(props, iModel) {
|
|
624
|
-
super(props, iModel);
|
|
625
|
-
this.view = new core_common_1.RelatedElement(props.view);
|
|
626
|
-
// ###NOTE: scale, displayPriority, and clipping vectors are stored in ViewAttachmentProps.jsonProperties.
|
|
627
|
-
}
|
|
628
|
-
/** @internal */
|
|
629
|
-
static get className() { return "ViewAttachment"; }
|
|
630
|
-
/** @internal */
|
|
631
|
-
collectReferenceConcreteIds(referenceIds) {
|
|
632
|
-
super.collectReferenceConcreteIds(referenceIds);
|
|
633
|
-
referenceIds.addElement(this.view.id);
|
|
634
|
-
}
|
|
635
|
-
}
|
|
636
|
-
exports.ViewAttachment = ViewAttachment;
|
|
637
|
-
/** The position in space of a Light.
|
|
638
|
-
* @internal
|
|
639
|
-
*/
|
|
640
|
-
class LightLocation extends Element_1.SpatialLocationElement {
|
|
641
|
-
/** @internal */
|
|
642
|
-
constructor(props, iModel) { super(props, iModel); }
|
|
643
|
-
/** @internal */
|
|
644
|
-
static get className() { return "LightLocation"; }
|
|
645
|
-
}
|
|
646
|
-
exports.LightLocation = LightLocation;
|
|
1
|
+
"use strict";
|
|
2
|
+
/*---------------------------------------------------------------------------------------------
|
|
3
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
+
*--------------------------------------------------------------------------------------------*/
|
|
6
|
+
/** @packageDocumentation
|
|
7
|
+
* @module ViewDefinitions
|
|
8
|
+
*/
|
|
9
|
+
var _a, _b, _c, _d;
|
|
10
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
+
exports.LightLocation = exports.ViewAttachment = exports.AuxCoordSystemSpatial = exports.AuxCoordSystem3d = exports.AuxCoordSystem2d = exports.AuxCoordSystem = exports.TemplateViewDefinition3d = exports.TemplateViewDefinition2d = exports.SheetViewDefinition = exports.DrawingViewDefinition = exports.ViewDefinition2d = exports.OrthographicViewDefinition = exports.SpatialViewDefinition = exports.ViewDefinition3d = exports.ViewDefinition = exports.CategorySelector = exports.ModelSelector = void 0;
|
|
12
|
+
const core_bentley_1 = require("@itwin/core-bentley");
|
|
13
|
+
const core_geometry_1 = require("@itwin/core-geometry");
|
|
14
|
+
const core_common_1 = require("@itwin/core-common");
|
|
15
|
+
const Element_1 = require("./Element");
|
|
16
|
+
/** Holds the list of Ids of GeometricModels displayed by a [[SpatialViewDefinition]]. Multiple SpatialViewDefinitions may point to the same ModelSelector.
|
|
17
|
+
* @see [ModelSelectorState]($frontend)
|
|
18
|
+
* See [how to create a ModelSelector]$(docs/learning/backend/CreateElements.md#ModelSelector).
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
class ModelSelector extends Element_1.DefinitionElement {
|
|
22
|
+
/** @internal */
|
|
23
|
+
constructor(props, iModel) {
|
|
24
|
+
super(props, iModel);
|
|
25
|
+
this.models = props.models;
|
|
26
|
+
}
|
|
27
|
+
/** @internal */
|
|
28
|
+
static get className() { return "ModelSelector"; }
|
|
29
|
+
/** @internal */
|
|
30
|
+
toJSON() {
|
|
31
|
+
const val = super.toJSON();
|
|
32
|
+
val.models = this.models;
|
|
33
|
+
return val;
|
|
34
|
+
}
|
|
35
|
+
/** @internal */
|
|
36
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
37
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
38
|
+
this.models.forEach((modelId) => referenceIds.addModel(modelId));
|
|
39
|
+
}
|
|
40
|
+
/** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
41
|
+
* @param iModel The IModelDb
|
|
42
|
+
* @param scopeModelId The Id of the DefinitionModel that contains the ModelSelector and provides the scope for its name.
|
|
43
|
+
* @param codeValue The ModelSelector name
|
|
44
|
+
*/
|
|
45
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
46
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.modelSelector);
|
|
47
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Create a ModelSelector to select which Models are displayed by a ViewDefinition.
|
|
51
|
+
* @param iModelDb The iModel
|
|
52
|
+
* @param definitionModelId The [[DefinitionModel]]
|
|
53
|
+
* @param name The name/CodeValue of the ModelSelector
|
|
54
|
+
* @param models Array of models to select for display
|
|
55
|
+
* @returns The newly constructed ModelSelector element.
|
|
56
|
+
* @throws [[IModelError]] if unable to create the element.
|
|
57
|
+
*/
|
|
58
|
+
static create(iModelDb, definitionModelId, name, models) {
|
|
59
|
+
const modelSelectorProps = {
|
|
60
|
+
classFullName: this.classFullName,
|
|
61
|
+
code: this.createCode(iModelDb, definitionModelId, name),
|
|
62
|
+
model: definitionModelId,
|
|
63
|
+
models,
|
|
64
|
+
isPrivate: false,
|
|
65
|
+
};
|
|
66
|
+
return new ModelSelector(modelSelectorProps, iModelDb);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Insert a ModelSelector to select which Models are displayed by a ViewDefinition.
|
|
70
|
+
* @param iModelDb Insert into this iModel
|
|
71
|
+
* @param definitionModelId Insert the new ModelSelector into this DefinitionModel
|
|
72
|
+
* @param name The name/CodeValue of the ModelSelector
|
|
73
|
+
* @param models Array of models to select for display
|
|
74
|
+
* @returns The Id of the newly inserted ModelSelector element.
|
|
75
|
+
* @throws [[IModelError]] if unable to insert the element.
|
|
76
|
+
*/
|
|
77
|
+
static insert(iModelDb, definitionModelId, name, models) {
|
|
78
|
+
const modelSelector = this.create(iModelDb, definitionModelId, name, models);
|
|
79
|
+
return iModelDb.elements.insertElement(modelSelector.toJSON());
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
exports.ModelSelector = ModelSelector;
|
|
83
|
+
/** Holds a list of Ids of Categories to be displayed in a view.
|
|
84
|
+
* @see [CategorySelectorState]($frontend)
|
|
85
|
+
* See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
class CategorySelector extends Element_1.DefinitionElement {
|
|
89
|
+
/** @internal */
|
|
90
|
+
constructor(props, iModel) {
|
|
91
|
+
super(props, iModel);
|
|
92
|
+
this.categories = props.categories;
|
|
93
|
+
}
|
|
94
|
+
/** @internal */
|
|
95
|
+
static get className() { return "CategorySelector"; }
|
|
96
|
+
/** @internal */
|
|
97
|
+
toJSON() {
|
|
98
|
+
const val = super.toJSON();
|
|
99
|
+
val.categories = this.categories;
|
|
100
|
+
return val;
|
|
101
|
+
}
|
|
102
|
+
/** @internal */
|
|
103
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
104
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
105
|
+
this.categories.forEach((categoryId) => referenceIds.addElement(categoryId));
|
|
106
|
+
}
|
|
107
|
+
/** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
108
|
+
* @param iModel The IModelDb
|
|
109
|
+
* @param scopeModelId The Id of the DefinitionModel that contains the CategorySelector and provides the scope for its name.
|
|
110
|
+
* @param codeValue The CategorySelector name
|
|
111
|
+
*/
|
|
112
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
113
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.categorySelector);
|
|
114
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Create a CategorySelector to select which categories are displayed by a ViewDefinition.
|
|
118
|
+
* @param iModelDb The iModel
|
|
119
|
+
* @param definitionModelId The [[DefinitionModel]]
|
|
120
|
+
* @param name The name of the CategorySelector
|
|
121
|
+
* @param categories Array of categories to select for display
|
|
122
|
+
* @returns The newly constructed CategorySelector element.
|
|
123
|
+
* @throws [[IModelError]] if unable to create the element.
|
|
124
|
+
*/
|
|
125
|
+
static create(iModelDb, definitionModelId, name, categories) {
|
|
126
|
+
const categorySelectorProps = {
|
|
127
|
+
classFullName: this.classFullName,
|
|
128
|
+
code: this.createCode(iModelDb, definitionModelId, name),
|
|
129
|
+
model: definitionModelId,
|
|
130
|
+
categories,
|
|
131
|
+
isPrivate: false,
|
|
132
|
+
};
|
|
133
|
+
return new CategorySelector(categorySelectorProps, iModelDb);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Insert a CategorySelector to select which categories are displayed by a ViewDefinition.
|
|
137
|
+
* @param iModelDb Insert into this iModel
|
|
138
|
+
* @param definitionModelId Insert the new CategorySelector into this DefinitionModel
|
|
139
|
+
* @param name The name of the CategorySelector
|
|
140
|
+
* @param categories Array of categories to select for display
|
|
141
|
+
* @returns The Id of the newly inserted CategorySelector element.
|
|
142
|
+
* @throws [[IModelError]] if unable to insert the element.
|
|
143
|
+
*/
|
|
144
|
+
static insert(iModelDb, definitionModelId, name, categories) {
|
|
145
|
+
const categorySelector = this.create(iModelDb, definitionModelId, name, categories);
|
|
146
|
+
return iModelDb.elements.insertElement(categorySelector.toJSON());
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
exports.CategorySelector = CategorySelector;
|
|
150
|
+
/**
|
|
151
|
+
* The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
|
|
152
|
+
* plus additional view-specific parameters in their [[Element.jsonProperties]].
|
|
153
|
+
*
|
|
154
|
+
* Subclasses of ViewDefinition determine which model(s) are viewed.
|
|
155
|
+
*
|
|
156
|
+
* **Example: Obtaining the background color for a view**
|
|
157
|
+
* ``` ts
|
|
158
|
+
* [[include:ViewDefinition.getBackgroundColor]]
|
|
159
|
+
* ```
|
|
160
|
+
*
|
|
161
|
+
* @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
class ViewDefinition extends (_b = Element_1.DefinitionElement) {
|
|
165
|
+
/** @internal */
|
|
166
|
+
constructor(props, iModel) {
|
|
167
|
+
super(props, iModel);
|
|
168
|
+
this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
|
|
169
|
+
if (!core_bentley_1.Id64.isValid(this.categorySelectorId))
|
|
170
|
+
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `categorySelectorId is invalid`);
|
|
171
|
+
this.displayStyleId = core_bentley_1.Id64.fromJSON(props.displayStyleId);
|
|
172
|
+
if (!core_bentley_1.Id64.isValid(this.displayStyleId))
|
|
173
|
+
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `displayStyleId is invalid`);
|
|
174
|
+
}
|
|
175
|
+
/** @internal */
|
|
176
|
+
static get className() { return "ViewDefinition"; }
|
|
177
|
+
/** @internal */
|
|
178
|
+
toJSON() {
|
|
179
|
+
const json = super.toJSON();
|
|
180
|
+
json.categorySelectorId = this.categorySelectorId;
|
|
181
|
+
json.displayStyleId = this.displayStyleId;
|
|
182
|
+
return json;
|
|
183
|
+
}
|
|
184
|
+
/** @internal */
|
|
185
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
186
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
187
|
+
referenceIds.addElement(this.categorySelectorId);
|
|
188
|
+
referenceIds.addElement(this.displayStyleId);
|
|
189
|
+
const acsId = this.getAuxiliaryCoordinateSystemId();
|
|
190
|
+
if (core_bentley_1.Id64.isValidId64(acsId)) {
|
|
191
|
+
referenceIds.addElement(acsId);
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
/** @internal */
|
|
195
|
+
static onCloned(context, sourceElementProps, targetElementProps) {
|
|
196
|
+
super.onCloned(context, sourceElementProps, targetElementProps);
|
|
197
|
+
if (context.isBetweenIModels && targetElementProps.jsonProperties && targetElementProps.jsonProperties.viewDetails) {
|
|
198
|
+
const acsId = core_bentley_1.Id64.fromJSON(targetElementProps.jsonProperties.viewDetails.acs);
|
|
199
|
+
if (core_bentley_1.Id64.isValidId64(acsId)) {
|
|
200
|
+
targetElementProps.jsonProperties.viewDetails.acs = context.findTargetElementId(acsId);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
/** Type guard for `instanceof ViewDefinition3d` */
|
|
205
|
+
isView3d() { return this instanceof ViewDefinition3d; }
|
|
206
|
+
/** Type guard for 'instanceof ViewDefinition2d` */
|
|
207
|
+
isView2d() { return this instanceof ViewDefinition2d; }
|
|
208
|
+
/** Type guard for `instanceof SpatialViewDefinition` */
|
|
209
|
+
isSpatialView() { return this instanceof SpatialViewDefinition; }
|
|
210
|
+
/** Type guard for 'instanceof DrawingViewDefinition' */
|
|
211
|
+
isDrawingView() { return this instanceof DrawingViewDefinition; }
|
|
212
|
+
/** Load this view's DisplayStyle from the IModelDb. */
|
|
213
|
+
loadDisplayStyle() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
214
|
+
/** Load this view's CategorySelector from the IModelDb. */
|
|
215
|
+
loadCategorySelector() { return this.iModel.elements.getElement(this.categorySelectorId); }
|
|
216
|
+
/** The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined. */
|
|
217
|
+
getAuxiliaryCoordinateSystemId() {
|
|
218
|
+
return this.details.auxiliaryCoordinateSystemId;
|
|
219
|
+
}
|
|
220
|
+
/** Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
|
|
221
|
+
* @param acsId The Id of the new AuxiliaryCoordinateSystem. If `Id64.invalid` is passed, then no AuxiliaryCoordinateSystem will be used.
|
|
222
|
+
*/
|
|
223
|
+
setAuxiliaryCoordinateSystemId(acsId) {
|
|
224
|
+
this.details.auxiliaryCoordinateSystemId = acsId;
|
|
225
|
+
}
|
|
226
|
+
/** Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
227
|
+
* @param iModel The IModelDb
|
|
228
|
+
* @param scopeModelId The Id of the DefinitionModel to contain the ViewDefinition and provides the scope for its name.
|
|
229
|
+
* @param codeValue The ViewDefinition name
|
|
230
|
+
*/
|
|
231
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
232
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.viewDefinition);
|
|
233
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
exports.ViewDefinition = ViewDefinition;
|
|
237
|
+
_a = ViewDefinition;
|
|
238
|
+
/** @beta */
|
|
239
|
+
ViewDefinition.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "categorySelectorId", "displayStyleId"];
|
|
240
|
+
/** @alpha */
|
|
241
|
+
ViewDefinition.requiredReferenceKeyTypeMap = {
|
|
242
|
+
...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
|
|
243
|
+
categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
|
|
244
|
+
displayStyleId: core_common_1.ConcreteEntityTypes.Element,
|
|
245
|
+
};
|
|
246
|
+
/** Defines a view of one or more 3d models.
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
class ViewDefinition3d extends ViewDefinition {
|
|
250
|
+
/** @internal */
|
|
251
|
+
constructor(props, iModel) {
|
|
252
|
+
super(props, iModel);
|
|
253
|
+
this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
|
|
254
|
+
this.origin = core_geometry_1.Point3d.fromJSON(props.origin);
|
|
255
|
+
this.extents = core_geometry_1.Vector3d.fromJSON(props.extents);
|
|
256
|
+
this.angles = core_geometry_1.YawPitchRollAngles.fromJSON(props.angles);
|
|
257
|
+
this.camera = new core_common_1.Camera(props.camera);
|
|
258
|
+
this._details = new core_common_1.ViewDetails3d(this.jsonProperties);
|
|
259
|
+
}
|
|
260
|
+
/** @internal */
|
|
261
|
+
static get className() { return "ViewDefinition3d"; }
|
|
262
|
+
/** @internal */
|
|
263
|
+
toJSON() {
|
|
264
|
+
const val = super.toJSON();
|
|
265
|
+
val.cameraOn = this.cameraOn;
|
|
266
|
+
val.origin = this.origin;
|
|
267
|
+
val.extents = this.extents;
|
|
268
|
+
val.angles = this.angles;
|
|
269
|
+
val.camera = this.camera;
|
|
270
|
+
return val;
|
|
271
|
+
}
|
|
272
|
+
/** Provides access to optional detail settings for this view. */
|
|
273
|
+
get details() { return this._details; }
|
|
274
|
+
/** Load this view's DisplayStyle3d from the IModelDb. */
|
|
275
|
+
loadDisplayStyle3d() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
276
|
+
}
|
|
277
|
+
exports.ViewDefinition3d = ViewDefinition3d;
|
|
278
|
+
/** Defines a view of one or more SpatialModels.
|
|
279
|
+
* The list of viewed models is stored by the ModelSelector.
|
|
280
|
+
*
|
|
281
|
+
* This is how a SpatialViewDefinition selects the elements to display:
|
|
282
|
+
*
|
|
283
|
+
* SpatialViewDefinition
|
|
284
|
+
* * ModelSelector
|
|
285
|
+
* * ModelIds -------> SpatialModels <----------GeometricElement3d.Model
|
|
286
|
+
* * CategorySelector
|
|
287
|
+
* * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
class SpatialViewDefinition extends (_d = ViewDefinition3d) {
|
|
291
|
+
/** @internal */
|
|
292
|
+
constructor(props, iModel) {
|
|
293
|
+
super(props, iModel);
|
|
294
|
+
this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
|
|
295
|
+
if (!core_bentley_1.Id64.isValid(this.modelSelectorId))
|
|
296
|
+
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `modelSelectorId is invalid`);
|
|
297
|
+
}
|
|
298
|
+
/** @internal */
|
|
299
|
+
static get className() { return "SpatialViewDefinition"; }
|
|
300
|
+
/** @internal */
|
|
301
|
+
toJSON() {
|
|
302
|
+
const json = super.toJSON();
|
|
303
|
+
json.modelSelectorId = this.modelSelectorId;
|
|
304
|
+
return json;
|
|
305
|
+
}
|
|
306
|
+
/** @internal */
|
|
307
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
308
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
309
|
+
referenceIds.addElement(this.modelSelectorId);
|
|
310
|
+
}
|
|
311
|
+
/** Load this view's ModelSelector from the IModelDb. */
|
|
312
|
+
loadModelSelector() { return this.iModel.elements.getElement(this.modelSelectorId); }
|
|
313
|
+
/**
|
|
314
|
+
* Create an SpatialViewDefinition with camera.
|
|
315
|
+
* @param iModelDb The iModel
|
|
316
|
+
* @param definitionModelId The [[DefinitionModel]]
|
|
317
|
+
* @param name The name/CodeValue of the view
|
|
318
|
+
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
319
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
320
|
+
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
321
|
+
* @param range Defines the view origin and extents
|
|
322
|
+
* @param standardView Optionally defines the view's rotation
|
|
323
|
+
* @param cameraAngle Camera angle in radians.
|
|
324
|
+
* @returns The newly constructed OrthographicViewDefinition element
|
|
325
|
+
* @throws [[IModelError]] if there is a problem creating the view
|
|
326
|
+
*/
|
|
327
|
+
static createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
|
|
328
|
+
const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
|
|
329
|
+
const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
|
|
330
|
+
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
331
|
+
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
332
|
+
const cameraDistance = 2 * (rotatedRange.diagonal().magnitudeXY() / 2.0) / Math.tan(cameraAngle / 2.0);
|
|
333
|
+
const cameraLocation = rotatedRange.diagonalFractionToPoint(.5); // Start at center.
|
|
334
|
+
cameraLocation.z += cameraDistance; // Back up by camera distance.
|
|
335
|
+
rotation.multiplyTransposeVectorInPlace(cameraLocation);
|
|
336
|
+
const viewDefinitionProps = {
|
|
337
|
+
classFullName: this.classFullName,
|
|
338
|
+
model: definitionModelId,
|
|
339
|
+
code: this.createCode(iModelDb, definitionModelId, name),
|
|
340
|
+
modelSelectorId,
|
|
341
|
+
categorySelectorId,
|
|
342
|
+
displayStyleId,
|
|
343
|
+
origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
|
|
344
|
+
extents: rotatedRange.diagonal(),
|
|
345
|
+
angles,
|
|
346
|
+
cameraOn: true,
|
|
347
|
+
camera: { lens: { radians: cameraAngle }, focusDist: cameraDistance, eye: cameraLocation },
|
|
348
|
+
};
|
|
349
|
+
return new SpatialViewDefinition(viewDefinitionProps, iModelDb);
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Insert an SpatialViewDefinition with camera On
|
|
353
|
+
* @param iModelDb Insert into this iModel
|
|
354
|
+
* @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
|
|
355
|
+
* @param name The name/CodeValue of the view
|
|
356
|
+
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
357
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
358
|
+
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
359
|
+
* @param range Defines the view origin and extents
|
|
360
|
+
* @param standardView Optionally defines the view's rotation
|
|
361
|
+
* @param cameraAngle Camera angle in radians.
|
|
362
|
+
* @returns The Id of the newly inserted OrthographicViewDefinition element
|
|
363
|
+
* @throws [[IModelError]] if there is an insert problem.
|
|
364
|
+
*/
|
|
365
|
+
static insertWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
|
|
366
|
+
const viewDefinition = this.createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView, cameraAngle);
|
|
367
|
+
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
exports.SpatialViewDefinition = SpatialViewDefinition;
|
|
371
|
+
_c = SpatialViewDefinition;
|
|
372
|
+
/** @beta */
|
|
373
|
+
SpatialViewDefinition.requiredReferenceKeys = [...Reflect.get(_d, "requiredReferenceKeys", _c), "modelSelectorId"];
|
|
374
|
+
/** @alpha */
|
|
375
|
+
SpatialViewDefinition.requiredReferenceKeyTypeMap = {
|
|
376
|
+
...Reflect.get(_d, "requiredReferenceKeyTypeMap", _c),
|
|
377
|
+
modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
|
|
378
|
+
};
|
|
379
|
+
/** Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
|
|
380
|
+
* See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
class OrthographicViewDefinition extends SpatialViewDefinition {
|
|
384
|
+
/** @internal */
|
|
385
|
+
static get className() { return "OrthographicViewDefinition"; }
|
|
386
|
+
constructor(props, iModel) { super(props, iModel); }
|
|
387
|
+
/**
|
|
388
|
+
* Create an OrthographicViewDefinition
|
|
389
|
+
* @param iModelDb The iModel
|
|
390
|
+
* @param definitionModelId The [[DefinitionModel]]
|
|
391
|
+
* @param name The name/CodeValue of the view
|
|
392
|
+
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
393
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
394
|
+
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
395
|
+
* @param range Defines the view origin and extents
|
|
396
|
+
* @param standardView Optionally defines the view's rotation
|
|
397
|
+
* @returns The newly constructed OrthographicViewDefinition element
|
|
398
|
+
* @throws [[IModelError]] if there is a problem creating the view
|
|
399
|
+
*/
|
|
400
|
+
static create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
|
|
401
|
+
const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
|
|
402
|
+
const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
|
|
403
|
+
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
404
|
+
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
405
|
+
const viewDefinitionProps = {
|
|
406
|
+
classFullName: this.classFullName,
|
|
407
|
+
model: definitionModelId,
|
|
408
|
+
code: this.createCode(iModelDb, definitionModelId, name),
|
|
409
|
+
modelSelectorId,
|
|
410
|
+
categorySelectorId,
|
|
411
|
+
displayStyleId,
|
|
412
|
+
origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
|
|
413
|
+
extents: rotatedRange.diagonal(),
|
|
414
|
+
angles,
|
|
415
|
+
cameraOn: false,
|
|
416
|
+
camera: new core_common_1.Camera(), // not used when cameraOn === false
|
|
417
|
+
};
|
|
418
|
+
return new OrthographicViewDefinition(viewDefinitionProps, iModelDb);
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Insert an OrthographicViewDefinition
|
|
422
|
+
* @param iModelDb Insert into this iModel
|
|
423
|
+
* @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
|
|
424
|
+
* @param name The name/CodeValue of the view
|
|
425
|
+
* @param modelSelectorId The [[ModelSelector]] that this view should use
|
|
426
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
427
|
+
* @param displayStyleId The [[DisplayStyle3d]] that this view should use
|
|
428
|
+
* @param range Defines the view origin and extents
|
|
429
|
+
* @param standardView Optionally defines the view's rotation
|
|
430
|
+
* @returns The Id of the newly inserted OrthographicViewDefinition element
|
|
431
|
+
* @throws [[IModelError]] if there is an insert problem.
|
|
432
|
+
*/
|
|
433
|
+
static insert(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
|
|
434
|
+
const viewDefinition = this.create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView);
|
|
435
|
+
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
436
|
+
}
|
|
437
|
+
/** Set a new viewed range without changing the rotation or any other properties. */
|
|
438
|
+
setRange(range) {
|
|
439
|
+
const rotation = this.angles.toMatrix3d();
|
|
440
|
+
const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
|
|
441
|
+
const rotatedRange = rotationTransform.multiplyRange(range);
|
|
442
|
+
this.origin = core_geometry_1.Point3d.createFrom(rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z));
|
|
443
|
+
this.extents = rotatedRange.diagonal();
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
exports.OrthographicViewDefinition = OrthographicViewDefinition;
|
|
447
|
+
/** Defines a view of a single 2d model. Each 2d model has its own coordinate system, so only one may appear per view.
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
class ViewDefinition2d extends ViewDefinition {
|
|
451
|
+
/** @internal */
|
|
452
|
+
constructor(props, iModel) {
|
|
453
|
+
super(props, iModel);
|
|
454
|
+
this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
|
|
455
|
+
this.origin = core_geometry_1.Point2d.fromJSON(props.origin);
|
|
456
|
+
this.delta = core_geometry_1.Point2d.fromJSON(props.delta);
|
|
457
|
+
this.angle = core_geometry_1.Angle.fromJSON(props.angle);
|
|
458
|
+
this._details = new core_common_1.ViewDetails(this.jsonProperties);
|
|
459
|
+
}
|
|
460
|
+
/** @internal */
|
|
461
|
+
static get className() { return "ViewDefinition2d"; }
|
|
462
|
+
/** @internal */
|
|
463
|
+
toJSON() {
|
|
464
|
+
const val = super.toJSON();
|
|
465
|
+
val.baseModelId = this.baseModelId;
|
|
466
|
+
val.origin = this.origin;
|
|
467
|
+
val.delta = this.delta;
|
|
468
|
+
val.angle = this.angle;
|
|
469
|
+
return val;
|
|
470
|
+
}
|
|
471
|
+
/** @internal */
|
|
472
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
473
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
474
|
+
referenceIds.addElement(this.baseModelId);
|
|
475
|
+
}
|
|
476
|
+
/** Provides access to optional detail settings for this view. */
|
|
477
|
+
get details() { return this._details; }
|
|
478
|
+
/** Load this view's DisplayStyle2d from the IModelDb. */
|
|
479
|
+
loadDisplayStyle2d() { return this.iModel.elements.getElement(this.displayStyleId); }
|
|
480
|
+
}
|
|
481
|
+
exports.ViewDefinition2d = ViewDefinition2d;
|
|
482
|
+
/** Defines a view of a [[DrawingModel]].
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
class DrawingViewDefinition extends ViewDefinition2d {
|
|
486
|
+
/** @internal */
|
|
487
|
+
static get className() { return "DrawingViewDefinition"; }
|
|
488
|
+
/** @internal */
|
|
489
|
+
constructor(props, iModel) {
|
|
490
|
+
super(props, iModel);
|
|
491
|
+
}
|
|
492
|
+
/** Create a DrawingViewDefinition
|
|
493
|
+
* @param iModelDb The iModel
|
|
494
|
+
* @param definitionModelId The [[DefinitionModel]]
|
|
495
|
+
* @param name The name/CodeValue of the view
|
|
496
|
+
* @param baseModelId The base [[DrawingModel]]
|
|
497
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
498
|
+
* @param displayStyleId The [[DisplayStyle2d]] that this view should use
|
|
499
|
+
* @param range Defines the view origin and extents
|
|
500
|
+
* @throws [[IModelError]] if there is a problem creating the element.
|
|
501
|
+
*/
|
|
502
|
+
static create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
|
|
503
|
+
const viewDefinitionProps = {
|
|
504
|
+
classFullName: this.classFullName,
|
|
505
|
+
model: definitionModelId,
|
|
506
|
+
code: this.createCode(iModelDb, definitionModelId, name),
|
|
507
|
+
baseModelId,
|
|
508
|
+
categorySelectorId,
|
|
509
|
+
displayStyleId,
|
|
510
|
+
origin: { x: range.low.x, y: range.low.y },
|
|
511
|
+
delta: range.diagonal(),
|
|
512
|
+
angle: 0,
|
|
513
|
+
};
|
|
514
|
+
return new DrawingViewDefinition(viewDefinitionProps, iModelDb);
|
|
515
|
+
}
|
|
516
|
+
/** Insert a DrawingViewDefinition
|
|
517
|
+
* @param iModelDb Insert into this iModel
|
|
518
|
+
* @param definitionModelId Insert the new DrawingViewDefinition into this [[DefinitionModel]]
|
|
519
|
+
* @param name The name/CodeValue of the view
|
|
520
|
+
* @param baseModelId The base [[DrawingModel]]
|
|
521
|
+
* @param categorySelectorId The [[CategorySelector]] that this view should use
|
|
522
|
+
* @param displayStyleId The [[DisplayStyle2d]] that this view should use
|
|
523
|
+
* @param range Defines the view origin and extents
|
|
524
|
+
* @throws [[IModelError]] if there is an insert problem.
|
|
525
|
+
*/
|
|
526
|
+
static insert(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
|
|
527
|
+
const viewDefinition = this.create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range);
|
|
528
|
+
return iModelDb.elements.insertElement(viewDefinition.toJSON());
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
exports.DrawingViewDefinition = DrawingViewDefinition;
|
|
532
|
+
/** Defines a view of a [[SheetModel]].
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
class SheetViewDefinition extends ViewDefinition2d {
|
|
536
|
+
/** @internal */
|
|
537
|
+
static get className() { return "SheetViewDefinition"; }
|
|
538
|
+
}
|
|
539
|
+
exports.SheetViewDefinition = SheetViewDefinition;
|
|
540
|
+
/** A ViewDefinition used to display a 2d template model.
|
|
541
|
+
* @internal
|
|
542
|
+
*/
|
|
543
|
+
class TemplateViewDefinition2d extends ViewDefinition2d {
|
|
544
|
+
/** @internal */
|
|
545
|
+
static get className() { return "TemplateViewDefinition2d"; }
|
|
546
|
+
}
|
|
547
|
+
exports.TemplateViewDefinition2d = TemplateViewDefinition2d;
|
|
548
|
+
/** A ViewDefinition used to display a 3d template model.
|
|
549
|
+
* @internal
|
|
550
|
+
*/
|
|
551
|
+
class TemplateViewDefinition3d extends ViewDefinition3d {
|
|
552
|
+
/** @internal */
|
|
553
|
+
static get className() { return "TemplateViewDefinition3d"; }
|
|
554
|
+
}
|
|
555
|
+
exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
|
|
556
|
+
/** An auxiliary coordinate system element. Auxiliary coordinate systems can be used by views to show
|
|
557
|
+
* coordinate information in different units and/or orientations.
|
|
558
|
+
* @public
|
|
559
|
+
*/
|
|
560
|
+
class AuxCoordSystem extends Element_1.DefinitionElement {
|
|
561
|
+
constructor(props, iModel) { super(props, iModel); }
|
|
562
|
+
/** @internal */
|
|
563
|
+
static get className() { return "AuxCoordSystem"; }
|
|
564
|
+
}
|
|
565
|
+
exports.AuxCoordSystem = AuxCoordSystem;
|
|
566
|
+
/** A 2d auxiliary coordinate system.
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
class AuxCoordSystem2d extends AuxCoordSystem {
|
|
570
|
+
constructor(props, iModel) { super(props, iModel); }
|
|
571
|
+
/** @internal */
|
|
572
|
+
static get className() { return "AuxCoordSystem2d"; }
|
|
573
|
+
/** Create a Code for a AuxCoordSystem2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
574
|
+
* @param iModel The IModelDb
|
|
575
|
+
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem2d element and provides the scope for its name.
|
|
576
|
+
* @param codeValue The AuxCoordSystem2d name
|
|
577
|
+
*/
|
|
578
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
579
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem2d);
|
|
580
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
581
|
+
}
|
|
582
|
+
}
|
|
583
|
+
exports.AuxCoordSystem2d = AuxCoordSystem2d;
|
|
584
|
+
/** A 3d auxiliary coordinate system.
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
class AuxCoordSystem3d extends AuxCoordSystem {
|
|
588
|
+
constructor(props, iModel) { super(props, iModel); }
|
|
589
|
+
/** @internal */
|
|
590
|
+
static get className() { return "AuxCoordSystem3d"; }
|
|
591
|
+
/** Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
592
|
+
* @param iModel The IModelDb
|
|
593
|
+
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem3d element and provides the scope for its name.
|
|
594
|
+
* @param codeValue The AuxCoordSystem3d name
|
|
595
|
+
*/
|
|
596
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
597
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem3d);
|
|
598
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
599
|
+
}
|
|
600
|
+
}
|
|
601
|
+
exports.AuxCoordSystem3d = AuxCoordSystem3d;
|
|
602
|
+
/** A spatial auxiliary coordinate system.
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
class AuxCoordSystemSpatial extends AuxCoordSystem3d {
|
|
606
|
+
/** @internal */
|
|
607
|
+
static get className() { return "AuxCoordSystemSpatial"; }
|
|
608
|
+
/** Create a Code for a AuxCoordSystemSpatial element given a name that is meant to be unique within the scope of the specified DefinitionModel.
|
|
609
|
+
* @param iModel The IModelDb
|
|
610
|
+
* @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystemSpatial element and provides the scope for its name.
|
|
611
|
+
* @param codeValue The AuxCoordSystemSpatial name
|
|
612
|
+
*/
|
|
613
|
+
static createCode(iModel, scopeModelId, codeValue) {
|
|
614
|
+
const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystemSpatial);
|
|
615
|
+
return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
|
|
616
|
+
}
|
|
617
|
+
}
|
|
618
|
+
exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
|
|
619
|
+
/** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
class ViewAttachment extends Element_1.GraphicalElement2d {
|
|
623
|
+
constructor(props, iModel) {
|
|
624
|
+
super(props, iModel);
|
|
625
|
+
this.view = new core_common_1.RelatedElement(props.view);
|
|
626
|
+
// ###NOTE: scale, displayPriority, and clipping vectors are stored in ViewAttachmentProps.jsonProperties.
|
|
627
|
+
}
|
|
628
|
+
/** @internal */
|
|
629
|
+
static get className() { return "ViewAttachment"; }
|
|
630
|
+
/** @internal */
|
|
631
|
+
collectReferenceConcreteIds(referenceIds) {
|
|
632
|
+
super.collectReferenceConcreteIds(referenceIds);
|
|
633
|
+
referenceIds.addElement(this.view.id);
|
|
634
|
+
}
|
|
635
|
+
}
|
|
636
|
+
exports.ViewAttachment = ViewAttachment;
|
|
637
|
+
/** The position in space of a Light.
|
|
638
|
+
* @internal
|
|
639
|
+
*/
|
|
640
|
+
class LightLocation extends Element_1.SpatialLocationElement {
|
|
641
|
+
/** @internal */
|
|
642
|
+
constructor(props, iModel) { super(props, iModel); }
|
|
643
|
+
/** @internal */
|
|
644
|
+
static get className() { return "LightLocation"; }
|
|
645
|
+
}
|
|
646
|
+
exports.LightLocation = LightLocation;
|
|
647
647
|
//# sourceMappingURL=ViewDefinition.js.map
|