@itwin/presentation-backend 5.0.0-dev.11 → 5.0.0-dev.110
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 +61 -1
- package/lib/cjs/package.json +1 -0
- package/lib/cjs/presentation-backend/ElementPropertiesHelper.d.ts +31 -4
- package/lib/cjs/presentation-backend/ElementPropertiesHelper.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/ElementPropertiesHelper.js +161 -56
- package/lib/cjs/presentation-backend/ElementPropertiesHelper.js.map +1 -1
- package/lib/cjs/presentation-backend/InternalSymbols.d.ts +5 -0
- package/lib/cjs/presentation-backend/InternalSymbols.d.ts.map +1 -0
- package/lib/cjs/presentation-backend/InternalSymbols.js +16 -0
- package/lib/cjs/presentation-backend/InternalSymbols.js.map +1 -0
- package/lib/cjs/presentation-backend/NativePlatform.d.ts +2 -2
- package/lib/cjs/presentation-backend/NativePlatform.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/NativePlatform.js +5 -3
- package/lib/cjs/presentation-backend/NativePlatform.js.map +1 -1
- package/lib/cjs/presentation-backend/Presentation.d.ts +2 -7
- package/lib/cjs/presentation-backend/Presentation.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/Presentation.js +40 -29
- package/lib/cjs/presentation-backend/Presentation.js.map +1 -1
- package/lib/cjs/presentation-backend/PresentationIpcHandler.d.ts +3 -3
- package/lib/cjs/presentation-backend/PresentationIpcHandler.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/PresentationIpcHandler.js +5 -7
- package/lib/cjs/presentation-backend/PresentationIpcHandler.js.map +1 -1
- package/lib/cjs/presentation-backend/PresentationManager.d.ts +13 -90
- package/lib/cjs/presentation-backend/PresentationManager.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/PresentationManager.js +79 -130
- package/lib/cjs/presentation-backend/PresentationManager.js.map +1 -1
- package/lib/cjs/presentation-backend/PresentationManagerDetail.d.ts +19 -10
- package/lib/cjs/presentation-backend/PresentationManagerDetail.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/PresentationManagerDetail.js +83 -76
- package/lib/cjs/presentation-backend/PresentationManagerDetail.js.map +1 -1
- package/lib/cjs/presentation-backend/PresentationRpcImpl.d.ts +11 -11
- package/lib/cjs/presentation-backend/PresentationRpcImpl.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/PresentationRpcImpl.js +110 -118
- package/lib/cjs/presentation-backend/PresentationRpcImpl.js.map +1 -1
- package/lib/cjs/presentation-backend/RulesetEmbedder.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/RulesetEmbedder.js +23 -24
- package/lib/cjs/presentation-backend/RulesetEmbedder.js.map +1 -1
- package/lib/cjs/presentation-backend/RulesetManager.d.ts +1 -1
- package/lib/cjs/presentation-backend/RulesetManager.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/RulesetManager.js +2 -1
- package/lib/cjs/presentation-backend/RulesetManager.js.map +1 -1
- package/lib/cjs/presentation-backend/RulesetVariablesManager.d.ts +1 -1
- package/lib/cjs/presentation-backend/RulesetVariablesManager.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/RulesetVariablesManager.js +2 -0
- package/lib/cjs/presentation-backend/RulesetVariablesManager.js.map +1 -1
- package/lib/cjs/presentation-backend/SelectionScopesHelper.d.ts +2 -4
- package/lib/cjs/presentation-backend/SelectionScopesHelper.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/SelectionScopesHelper.js +70 -83
- package/lib/cjs/presentation-backend/SelectionScopesHelper.js.map +1 -1
- package/lib/cjs/presentation-backend/TemporaryStorage.d.ts +2 -3
- package/lib/cjs/presentation-backend/TemporaryStorage.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/TemporaryStorage.js +30 -28
- package/lib/cjs/presentation-backend/TemporaryStorage.js.map +1 -1
- package/lib/cjs/presentation-backend/Utils.d.ts.map +1 -1
- package/lib/cjs/presentation-backend/Utils.js +15 -21
- package/lib/cjs/presentation-backend/Utils.js.map +1 -1
- package/lib/cjs/presentation-backend/domain/PresentationRulesDomain.js +2 -2
- package/lib/cjs/presentation-backend/domain/PresentationRulesDomain.js.map +1 -1
- package/lib/cjs/presentation-backend/domain/RulesetElements.js +4 -4
- package/lib/cjs/presentation-backend/domain/RulesetElements.js.map +1 -1
- package/lib/cjs/presentation-backend-internal.d.ts +2 -0
- package/lib/cjs/presentation-backend-internal.d.ts.map +1 -0
- package/lib/cjs/presentation-backend-internal.js +12 -0
- package/lib/cjs/presentation-backend-internal.js.map +1 -0
- package/lib/cjs/presentation-backend.d.ts +7 -7
- package/lib/cjs/presentation-backend.d.ts.map +1 -1
- package/lib/cjs/presentation-backend.js +11 -21
- package/lib/cjs/presentation-backend.js.map +1 -1
- package/lib/esm/presentation-backend/BackendLoggerCategory.d.ts +62 -0
- package/lib/esm/presentation-backend/BackendLoggerCategory.d.ts.map +1 -0
- package/lib/esm/presentation-backend/BackendLoggerCategory.js +69 -0
- package/lib/esm/presentation-backend/BackendLoggerCategory.js.map +1 -0
- package/lib/esm/presentation-backend/ElementPropertiesHelper.d.ts +45 -0
- package/lib/esm/presentation-backend/ElementPropertiesHelper.d.ts.map +1 -0
- package/lib/esm/presentation-backend/ElementPropertiesHelper.js +187 -0
- package/lib/esm/presentation-backend/ElementPropertiesHelper.js.map +1 -0
- package/lib/esm/presentation-backend/InternalSymbols.d.ts +5 -0
- package/lib/esm/presentation-backend/InternalSymbols.d.ts.map +1 -0
- package/lib/esm/presentation-backend/InternalSymbols.js +13 -0
- package/lib/esm/presentation-backend/InternalSymbols.js.map +1 -0
- package/lib/esm/presentation-backend/NativePlatform.d.ts +89 -0
- package/lib/esm/presentation-backend/NativePlatform.d.ts.map +1 -0
- package/lib/esm/presentation-backend/NativePlatform.js +156 -0
- package/lib/esm/presentation-backend/NativePlatform.js.map +1 -0
- package/lib/esm/presentation-backend/Presentation.d.ts +97 -0
- package/lib/esm/presentation-backend/Presentation.d.ts.map +1 -0
- package/lib/esm/presentation-backend/Presentation.js +147 -0
- package/lib/esm/presentation-backend/Presentation.js.map +1 -0
- package/lib/esm/presentation-backend/PresentationIpcHandler.d.ts +12 -0
- package/lib/esm/presentation-backend/PresentationIpcHandler.d.ts.map +1 -0
- package/lib/esm/presentation-backend/PresentationIpcHandler.js +25 -0
- package/lib/esm/presentation-backend/PresentationIpcHandler.js.map +1 -0
- package/lib/esm/presentation-backend/PresentationManager.d.ts +387 -0
- package/lib/esm/presentation-backend/PresentationManager.d.ts.map +1 -0
- package/lib/esm/presentation-backend/PresentationManager.js +352 -0
- package/lib/esm/presentation-backend/PresentationManager.js.map +1 -0
- package/lib/esm/presentation-backend/PresentationManagerDetail.d.ts +74 -0
- package/lib/esm/presentation-backend/PresentationManagerDetail.d.ts.map +1 -0
- package/lib/esm/presentation-backend/PresentationManagerDetail.js +446 -0
- package/lib/esm/presentation-backend/PresentationManagerDetail.js.map +1 -0
- package/lib/esm/presentation-backend/PresentationRpcImpl.d.ts +63 -0
- package/lib/esm/presentation-backend/PresentationRpcImpl.d.ts.map +1 -0
- package/lib/esm/presentation-backend/PresentationRpcImpl.js +409 -0
- package/lib/esm/presentation-backend/PresentationRpcImpl.js.map +1 -0
- package/lib/esm/presentation-backend/RulesetEmbedder.d.ts +109 -0
- package/lib/esm/presentation-backend/RulesetEmbedder.d.ts.map +1 -0
- package/lib/esm/presentation-backend/RulesetEmbedder.js +269 -0
- package/lib/esm/presentation-backend/RulesetEmbedder.js.map +1 -0
- package/lib/esm/presentation-backend/RulesetManager.d.ts +54 -0
- package/lib/esm/presentation-backend/RulesetManager.d.ts.map +1 -0
- package/lib/esm/presentation-backend/RulesetManager.js +74 -0
- package/lib/esm/presentation-backend/RulesetManager.js.map +1 -0
- package/lib/esm/presentation-backend/RulesetVariablesManager.d.ts +141 -0
- package/lib/esm/presentation-backend/RulesetVariablesManager.d.ts.map +1 -0
- package/lib/esm/presentation-backend/RulesetVariablesManager.js +140 -0
- package/lib/esm/presentation-backend/RulesetVariablesManager.js.map +1 -0
- package/lib/esm/presentation-backend/SelectionScopesHelper.d.ts +27 -0
- package/lib/esm/presentation-backend/SelectionScopesHelper.d.ts.map +1 -0
- package/lib/esm/presentation-backend/SelectionScopesHelper.js +227 -0
- package/lib/esm/presentation-backend/SelectionScopesHelper.js.map +1 -0
- package/lib/esm/presentation-backend/TemporaryStorage.d.ts +123 -0
- package/lib/esm/presentation-backend/TemporaryStorage.d.ts.map +1 -0
- package/lib/esm/presentation-backend/TemporaryStorage.js +157 -0
- package/lib/esm/presentation-backend/TemporaryStorage.js.map +1 -0
- package/lib/esm/presentation-backend/Utils.d.ts +50 -0
- package/lib/esm/presentation-backend/Utils.d.ts.map +1 -0
- package/lib/esm/presentation-backend/Utils.js +101 -0
- package/lib/esm/presentation-backend/Utils.js.map +1 -0
- package/lib/esm/presentation-backend/domain/PresentationRulesDomain.d.ts +17 -0
- package/lib/esm/presentation-backend/domain/PresentationRulesDomain.d.ts.map +1 -0
- package/lib/esm/presentation-backend/domain/PresentationRulesDomain.js +31 -0
- package/lib/esm/presentation-backend/domain/PresentationRulesDomain.js.map +1 -0
- package/lib/esm/presentation-backend/domain/RulesetElements.d.ts +22 -0
- package/lib/esm/presentation-backend/domain/RulesetElements.d.ts.map +1 -0
- package/lib/esm/presentation-backend/domain/RulesetElements.js +38 -0
- package/lib/esm/presentation-backend/domain/RulesetElements.js.map +1 -0
- package/lib/esm/presentation-backend/primary-presentation-rules/ElementProperties.PresentationRuleSet.json +14 -0
- package/lib/esm/presentation-backend/supplemental-presentation-rules/BisCore.PresentationRuleSet.json +701 -0
- package/lib/esm/presentation-backend/supplemental-presentation-rules/Functional.PresentationRuleSet.json +139 -0
- package/lib/esm/presentation-backend-internal.d.ts +2 -0
- package/lib/esm/presentation-backend-internal.d.ts.map +1 -0
- package/lib/esm/presentation-backend-internal.js +8 -0
- package/lib/esm/presentation-backend-internal.js.map +1 -0
- package/lib/esm/presentation-backend.d.ts +20 -0
- package/lib/esm/presentation-backend.d.ts.map +1 -0
- package/lib/esm/presentation-backend.js +21 -0
- package/lib/esm/presentation-backend.js.map +1 -0
- package/package.json +42 -35
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
|
2
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
|
5
|
+
/** @packageDocumentation
|
|
6
|
+
* @module Core
|
|
7
|
+
*/
|
|
8
|
+
import { VariableValueTypes } from "@itwin/presentation-common";
|
|
9
|
+
/**
|
|
10
|
+
* Presentation ruleset variables registry implementation.
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
export class RulesetVariablesManagerImpl {
|
|
14
|
+
_getNativePlatform;
|
|
15
|
+
_rulesetId;
|
|
16
|
+
constructor(getNativeAddon, rulesetId) {
|
|
17
|
+
this._getNativePlatform = getNativeAddon;
|
|
18
|
+
this._rulesetId = rulesetId;
|
|
19
|
+
}
|
|
20
|
+
setValueInternal(variableId, type, value) {
|
|
21
|
+
this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);
|
|
22
|
+
}
|
|
23
|
+
getValueInternal(variableId, type) {
|
|
24
|
+
return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;
|
|
25
|
+
}
|
|
26
|
+
setValue(variableId, type, value) {
|
|
27
|
+
switch (type) {
|
|
28
|
+
case VariableValueTypes.Bool:
|
|
29
|
+
return this.setBool(variableId, value);
|
|
30
|
+
case VariableValueTypes.Id64:
|
|
31
|
+
return this.setId64(variableId, value);
|
|
32
|
+
case VariableValueTypes.Id64Array:
|
|
33
|
+
return this.setId64s(variableId, value);
|
|
34
|
+
case VariableValueTypes.Int:
|
|
35
|
+
return this.setInt(variableId, value);
|
|
36
|
+
case VariableValueTypes.IntArray:
|
|
37
|
+
return this.setInts(variableId, value);
|
|
38
|
+
case VariableValueTypes.String:
|
|
39
|
+
return this.setString(variableId, value);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
unset(variableId) {
|
|
43
|
+
this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);
|
|
44
|
+
}
|
|
45
|
+
getValue(variableId, type) {
|
|
46
|
+
switch (type) {
|
|
47
|
+
case VariableValueTypes.Bool:
|
|
48
|
+
return this.getBool(variableId);
|
|
49
|
+
case VariableValueTypes.Id64:
|
|
50
|
+
return this.getId64(variableId);
|
|
51
|
+
case VariableValueTypes.Id64Array:
|
|
52
|
+
return this.getId64s(variableId);
|
|
53
|
+
case VariableValueTypes.Int:
|
|
54
|
+
return this.getInt(variableId);
|
|
55
|
+
case VariableValueTypes.IntArray:
|
|
56
|
+
return this.getInts(variableId);
|
|
57
|
+
case VariableValueTypes.String:
|
|
58
|
+
return this.getString(variableId);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Retrieves `string` variable value.
|
|
63
|
+
* Returns empty string if variable does not exist or does not convert to string.
|
|
64
|
+
*/
|
|
65
|
+
getString(variableId) {
|
|
66
|
+
return this.getValueInternal(variableId, VariableValueTypes.String);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Sets `string` variable value
|
|
70
|
+
*/
|
|
71
|
+
setString(variableId, value) {
|
|
72
|
+
this.setValueInternal(variableId, VariableValueTypes.String, value);
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Retrieves `boolean` variable value.
|
|
76
|
+
* Returns `false` if variable does not exist or does not convert to boolean.
|
|
77
|
+
*/
|
|
78
|
+
getBool(variableId) {
|
|
79
|
+
return this.getValueInternal(variableId, VariableValueTypes.Bool);
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Sets `boolean` variable value
|
|
83
|
+
*/
|
|
84
|
+
setBool(variableId, value) {
|
|
85
|
+
this.setValueInternal(variableId, VariableValueTypes.Bool, value);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Retrieves `number` variable value.
|
|
89
|
+
* Returns `0` if variable does not exist or does not convert to integer.
|
|
90
|
+
*/
|
|
91
|
+
getInt(variableId) {
|
|
92
|
+
return this.getValueInternal(variableId, VariableValueTypes.Int);
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Sets `number` variable value
|
|
96
|
+
*/
|
|
97
|
+
setInt(variableId, value) {
|
|
98
|
+
this.setValueInternal(variableId, VariableValueTypes.Int, value);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Retrieves `number[]` variable value.
|
|
102
|
+
* Returns empty array if variable does not exist or does not convert to integer array.
|
|
103
|
+
*/
|
|
104
|
+
getInts(variableId) {
|
|
105
|
+
return this.getValueInternal(variableId, VariableValueTypes.IntArray);
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Sets `number[]` variable value
|
|
109
|
+
*/
|
|
110
|
+
setInts(variableId, value) {
|
|
111
|
+
this.setValueInternal(variableId, VariableValueTypes.IntArray, value);
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Retrieves `Id64String` variable value.
|
|
115
|
+
* Returns invalid Id64String if variable does not exist or does not convert to Id64String.
|
|
116
|
+
*/
|
|
117
|
+
getId64(variableId) {
|
|
118
|
+
return this.getValueInternal(variableId, VariableValueTypes.Id64);
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Sets `Id64String` variable value
|
|
122
|
+
*/
|
|
123
|
+
setId64(variableId, value) {
|
|
124
|
+
this.setValueInternal(variableId, VariableValueTypes.Id64, value);
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Retrieves `Id64String[]` variable value.
|
|
128
|
+
* Returns empty array if variable does not exist or does not convert to Id64String array.
|
|
129
|
+
*/
|
|
130
|
+
getId64s(variableId) {
|
|
131
|
+
return this.getValueInternal(variableId, VariableValueTypes.Id64Array);
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Sets `Id64String[]` variable value
|
|
135
|
+
*/
|
|
136
|
+
setId64s(variableId, value) {
|
|
137
|
+
this.setValueInternal(variableId, VariableValueTypes.Id64Array, value);
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
//# sourceMappingURL=RulesetVariablesManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RulesetVariablesManager.js","sourceRoot":"","sources":["../../../src/presentation-backend/RulesetVariablesManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAiB,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AA4E/E;;;GAGG;AACH,MAAM,OAAO,2BAA2B;IAC9B,kBAAkB,CAAiC;IACnD,UAAU,CAAS;IAE3B,YAAY,cAA8C,EAAE,SAAiB;QAC3E,IAAI,CAAC,kBAAkB,GAAG,cAAc,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEM,gBAAgB,CAAC,UAAkB,EAAE,IAAwB,EAAE,KAAoB;QACxF,IAAI,CAAC,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9F,CAAC;IAEM,gBAAgB,CAAC,UAAkB,EAAE,IAAwB;QAClE,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC;IACrG,CAAC;IAEM,QAAQ,CAAC,UAAkB,EAAE,IAAwB,EAAE,KAAoB;QAChF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAgB,CAAC,CAAC;YACpD,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAmB,CAAC,CAAC;YACvD,KAAK,kBAAkB,CAAC,SAAS;gBAC/B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAqB,CAAC,CAAC;YAC1D,KAAK,kBAAkB,CAAC,GAAG;gBACzB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,KAAe,CAAC,CAAC;YAClD,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAiB,CAAC,CAAC;YACrD,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,KAAe,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,UAAkB;QAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACnF,CAAC;IAEM,QAAQ,CAAC,UAAkB,EAAE,IAAwB;QAC1D,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClC,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClC,KAAK,kBAAkB,CAAC,SAAS;gBAC/B,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACnC,KAAK,kBAAkB,CAAC,GAAG;gBACzB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACjC,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClC,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,UAAkB;QACjC,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,CAAW,CAAC;IAChF,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,UAAkB,EAAE,KAAa;QAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAY,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAc;QAC/C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,UAAkB;QAC9B,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,GAAG,CAAW,CAAC;IAC7E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAkB,EAAE,KAAa;QAC7C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAa,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAe;QAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAe,CAAC;IAClF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAiB;QAClD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,UAAkB;QAChC,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,CAAiB,CAAC;IACzF,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,UAAkB,EAAE,KAAmB;QACrD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { VariableValue, VariableValueTypes } from \"@itwin/presentation-common\";\r\nimport { NativePlatformDefinition } from \"./NativePlatform.js\";\r\n\r\n/**\r\n * Presentation ruleset variables registry.\r\n * @public\r\n */\r\nexport interface RulesetVariablesManager {\r\n /** Gets a value of the specified type and ID */\r\n getValue(variableId: string, type: VariableValueTypes): VariableValue;\r\n /** Sets a value of the specified type */\r\n setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;\r\n /** Unsets variable with given id. */\r\n unset(variableId: string): void;\r\n\r\n /**\r\n * Retrieves `string` variable value.\r\n * Returns empty string if variable does not exist or does not convert to string.\r\n */\r\n getString(variableId: string): string;\r\n /**\r\n * Sets `string` variable value\r\n */\r\n setString(variableId: string, value: string): void;\r\n\r\n /**\r\n * Retrieves `boolean` variable value.\r\n * Returns `false` if variable does not exist or does not convert to boolean.\r\n */\r\n getBool(variableId: string): boolean;\r\n /**\r\n * Sets `boolean` variable value\r\n */\r\n setBool(variableId: string, value: boolean): void;\r\n\r\n /**\r\n * Retrieves `number` variable value.\r\n * Returns `0` if variable does not exist or does not convert to integer.\r\n */\r\n getInt(variableId: string): number;\r\n /**\r\n * Sets `number` variable value\r\n */\r\n setInt(variableId: string, value: number): void;\r\n\r\n /**\r\n * Retrieves `number[]` variable value.\r\n * Returns empty array if variable does not exist or does not convert to integer array.\r\n */\r\n getInts(variableId: string): number[];\r\n /**\r\n * Sets `number[]` variable value\r\n */\r\n setInts(variableId: string, value: number[]): void;\r\n\r\n /**\r\n * Retrieves `Id64String` variable value.\r\n * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\r\n */\r\n getId64(variableId: string): Id64String;\r\n /**\r\n * Sets `Id64String` variable value\r\n */\r\n setId64(variableId: string, value: Id64String): void;\r\n\r\n /**\r\n * Retrieves `Id64String[]` variable value.\r\n * Returns empty array if variable does not exist or does not convert to Id64String array.\r\n */\r\n getId64s(variableId: string): Id64String[];\r\n /**\r\n * Sets `Id64String[]` variable value\r\n */\r\n setId64s(variableId: string, value: Id64String[]): void;\r\n}\r\n\r\n/**\r\n * Presentation ruleset variables registry implementation.\r\n * @internal\r\n */\r\nexport class RulesetVariablesManagerImpl implements RulesetVariablesManager {\r\n private _getNativePlatform: () => NativePlatformDefinition;\r\n private _rulesetId: string;\r\n\r\n constructor(getNativeAddon: () => NativePlatformDefinition, rulesetId: string) {\r\n this._getNativePlatform = getNativeAddon;\r\n this._rulesetId = rulesetId;\r\n }\r\n\r\n public setValueInternal(variableId: string, type: VariableValueTypes, value: VariableValue): void {\r\n this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);\r\n }\r\n\r\n public getValueInternal(variableId: string, type: VariableValueTypes): VariableValue {\r\n return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;\r\n }\r\n\r\n public setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void {\r\n switch (type) {\r\n case VariableValueTypes.Bool:\r\n return this.setBool(variableId, value as boolean);\r\n case VariableValueTypes.Id64:\r\n return this.setId64(variableId, value as Id64String);\r\n case VariableValueTypes.Id64Array:\r\n return this.setId64s(variableId, value as Id64String[]);\r\n case VariableValueTypes.Int:\r\n return this.setInt(variableId, value as number);\r\n case VariableValueTypes.IntArray:\r\n return this.setInts(variableId, value as number[]);\r\n case VariableValueTypes.String:\r\n return this.setString(variableId, value as string);\r\n }\r\n }\r\n\r\n public unset(variableId: string): void {\r\n this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);\r\n }\r\n\r\n public getValue(variableId: string, type: VariableValueTypes): VariableValue {\r\n switch (type) {\r\n case VariableValueTypes.Bool:\r\n return this.getBool(variableId);\r\n case VariableValueTypes.Id64:\r\n return this.getId64(variableId);\r\n case VariableValueTypes.Id64Array:\r\n return this.getId64s(variableId);\r\n case VariableValueTypes.Int:\r\n return this.getInt(variableId);\r\n case VariableValueTypes.IntArray:\r\n return this.getInts(variableId);\r\n case VariableValueTypes.String:\r\n return this.getString(variableId);\r\n }\r\n }\r\n\r\n /**\r\n * Retrieves `string` variable value.\r\n * Returns empty string if variable does not exist or does not convert to string.\r\n */\r\n public getString(variableId: string): string {\r\n return this.getValueInternal(variableId, VariableValueTypes.String) as string;\r\n }\r\n\r\n /**\r\n * Sets `string` variable value\r\n */\r\n public setString(variableId: string, value: string): void {\r\n this.setValueInternal(variableId, VariableValueTypes.String, value);\r\n }\r\n\r\n /**\r\n * Retrieves `boolean` variable value.\r\n * Returns `false` if variable does not exist or does not convert to boolean.\r\n */\r\n public getBool(variableId: string): boolean {\r\n return this.getValueInternal(variableId, VariableValueTypes.Bool) as boolean;\r\n }\r\n\r\n /**\r\n * Sets `boolean` variable value\r\n */\r\n public setBool(variableId: string, value: boolean): void {\r\n this.setValueInternal(variableId, VariableValueTypes.Bool, value);\r\n }\r\n\r\n /**\r\n * Retrieves `number` variable value.\r\n * Returns `0` if variable does not exist or does not convert to integer.\r\n */\r\n public getInt(variableId: string): number {\r\n return this.getValueInternal(variableId, VariableValueTypes.Int) as number;\r\n }\r\n\r\n /**\r\n * Sets `number` variable value\r\n */\r\n public setInt(variableId: string, value: number): void {\r\n this.setValueInternal(variableId, VariableValueTypes.Int, value);\r\n }\r\n\r\n /**\r\n * Retrieves `number[]` variable value.\r\n * Returns empty array if variable does not exist or does not convert to integer array.\r\n */\r\n public getInts(variableId: string): number[] {\r\n return this.getValueInternal(variableId, VariableValueTypes.IntArray) as number[];\r\n }\r\n\r\n /**\r\n * Sets `number[]` variable value\r\n */\r\n public setInts(variableId: string, value: number[]): void {\r\n this.setValueInternal(variableId, VariableValueTypes.IntArray, value);\r\n }\r\n\r\n /**\r\n * Retrieves `Id64String` variable value.\r\n * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\r\n */\r\n public getId64(variableId: string): Id64String {\r\n return this.getValueInternal(variableId, VariableValueTypes.Id64) as Id64String;\r\n }\r\n\r\n /**\r\n * Sets `Id64String` variable value\r\n */\r\n public setId64(variableId: string, value: Id64String): void {\r\n this.setValueInternal(variableId, VariableValueTypes.Id64, value);\r\n }\r\n\r\n /**\r\n * Retrieves `Id64String[]` variable value.\r\n * Returns empty array if variable does not exist or does not convert to Id64String array.\r\n */\r\n public getId64s(variableId: string): Id64String[] {\r\n return this.getValueInternal(variableId, VariableValueTypes.Id64Array) as Id64String[];\r\n }\r\n\r\n /**\r\n * Sets `Id64String[]` variable value\r\n */\r\n public setId64s(variableId: string, value: Id64String[]): void {\r\n this.setValueInternal(variableId, VariableValueTypes.Id64Array, value);\r\n }\r\n}\r\n"]}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Core
|
|
3
|
+
*/
|
|
4
|
+
import { IModelDb } from "@itwin/core-backend";
|
|
5
|
+
import { ComputeSelectionRequestOptions, KeySet, SelectionScope } from "@itwin/presentation-common";
|
|
6
|
+
/**
|
|
7
|
+
* Contains helper methods for computing selection scopes. Will get removed
|
|
8
|
+
* once rules-driven scopes are implemented.
|
|
9
|
+
*
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
export declare class SelectionScopesHelper {
|
|
13
|
+
private constructor();
|
|
14
|
+
static getSelectionScopes(): SelectionScope[];
|
|
15
|
+
private static getElementKey;
|
|
16
|
+
private static computeElementSelection;
|
|
17
|
+
private static computeCategorySelection;
|
|
18
|
+
private static computeModelSelection;
|
|
19
|
+
private static getRelatedFunctionalElementKey;
|
|
20
|
+
private static findFirstRelatedFunctionalElementKey;
|
|
21
|
+
private static elementClassDerivesFrom;
|
|
22
|
+
private static computeFunctionalElementSelection;
|
|
23
|
+
private static computeFunctionalAssemblySelection;
|
|
24
|
+
private static computeFunctionalTopAssemblySelection;
|
|
25
|
+
static computeSelection({ imodel, scope, elementIds }: ComputeSelectionRequestOptions<IModelDb>): Promise<KeySet>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=SelectionScopesHelper.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SelectionScopesHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/SelectionScopesHelper.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAoB,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGjE,OAAO,EACL,8BAA8B,EAG9B,MAAM,EAGN,cAAc,EACf,MAAM,4BAA4B,CAAC;AAGpC;;;;;GAKG;AACH,qBAAa,qBAAqB;IAEhC,OAAO;WAEO,kBAAkB,IAAI,cAAc,EAAE;IAgBpD,OAAO,CAAC,MAAM,CAAC,aAAa;mBAWP,uBAAuB;mBASvB,wBAAwB;mBAYxB,qBAAqB;mBAYrB,8BAA8B;mBAuB9B,oCAAoC;mBAYpC,uBAAuB;mBAoBvB,iCAAiC;mBAyBjC,kCAAkC;mBA2BlC,qCAAqC;WA2BtC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,8BAA8B,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAsB/H"}
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
|
2
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
3
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
|
5
|
+
/* eslint-disable @typescript-eslint/no-deprecated */
|
|
6
|
+
/** @packageDocumentation
|
|
7
|
+
* @module Core
|
|
8
|
+
*/
|
|
9
|
+
import { Id64 } from "@itwin/core-bentley";
|
|
10
|
+
import { QueryBinder } from "@itwin/core-common";
|
|
11
|
+
import { KeySet, PresentationError, PresentationStatus, } from "@itwin/presentation-common";
|
|
12
|
+
import { getElementKey } from "./Utils.js";
|
|
13
|
+
/**
|
|
14
|
+
* Contains helper methods for computing selection scopes. Will get removed
|
|
15
|
+
* once rules-driven scopes are implemented.
|
|
16
|
+
*
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
export class SelectionScopesHelper {
|
|
20
|
+
/* c8 ignore next */
|
|
21
|
+
constructor() { }
|
|
22
|
+
static getSelectionScopes() {
|
|
23
|
+
const createSelectionScope = (scopeId, label, description) => ({
|
|
24
|
+
id: scopeId,
|
|
25
|
+
label,
|
|
26
|
+
description,
|
|
27
|
+
});
|
|
28
|
+
return [
|
|
29
|
+
createSelectionScope("element", "Element", "Select the picked element"),
|
|
30
|
+
createSelectionScope("assembly", "Assembly", "Select parent of the picked element"),
|
|
31
|
+
createSelectionScope("top-assembly", "Top Assembly", "Select the topmost parent of the picked element"),
|
|
32
|
+
// WIP: temporarily comment-out "category" and "model" scopes since we can't hilite contents of them fast enough
|
|
33
|
+
// createSelectionScope("category", "Category", "Select all elements in the picked element's category"),
|
|
34
|
+
// createSelectionScope("model", "Model", "Select all elements in the picked element's model"),
|
|
35
|
+
];
|
|
36
|
+
}
|
|
37
|
+
static getElementKey(iModel, elementId, ancestorLevel) {
|
|
38
|
+
let currId = elementId;
|
|
39
|
+
let parentId = iModel.elements.tryGetElementProps(currId)?.parent?.id;
|
|
40
|
+
while (parentId && ancestorLevel !== 0) {
|
|
41
|
+
currId = parentId;
|
|
42
|
+
parentId = iModel.elements.tryGetElementProps(currId)?.parent?.id;
|
|
43
|
+
--ancestorLevel;
|
|
44
|
+
}
|
|
45
|
+
return getElementKey(iModel, currId);
|
|
46
|
+
}
|
|
47
|
+
static async computeElementSelection(iModel, elementIds, ancestorLevel) {
|
|
48
|
+
const parentKeys = new KeySet();
|
|
49
|
+
await forEachNonTransientId(elementIds, async (id) => {
|
|
50
|
+
const key = this.getElementKey(iModel, id, ancestorLevel);
|
|
51
|
+
key && parentKeys.add(key);
|
|
52
|
+
});
|
|
53
|
+
return parentKeys;
|
|
54
|
+
}
|
|
55
|
+
static async computeCategorySelection(iModel, ids) {
|
|
56
|
+
const categoryKeys = new KeySet();
|
|
57
|
+
await forEachNonTransientId(ids, async (id) => {
|
|
58
|
+
const el = iModel.elements.tryGetElement(id);
|
|
59
|
+
const category = el?.category ? iModel.elements.tryGetElementProps(el.category) : undefined;
|
|
60
|
+
if (category) {
|
|
61
|
+
categoryKeys.add({ className: category.classFullName, id: category.id });
|
|
62
|
+
}
|
|
63
|
+
});
|
|
64
|
+
return categoryKeys;
|
|
65
|
+
}
|
|
66
|
+
static async computeModelSelection(iModel, ids) {
|
|
67
|
+
const modelKeys = new KeySet();
|
|
68
|
+
await forEachNonTransientId(ids, async (id) => {
|
|
69
|
+
const el = iModel.elements.tryGetElementProps(id);
|
|
70
|
+
const model = el ? iModel.models.tryGetModelProps(el.model) : undefined;
|
|
71
|
+
if (model) {
|
|
72
|
+
modelKeys.add({ className: model.classFullName, id: model.id });
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
return modelKeys;
|
|
76
|
+
}
|
|
77
|
+
static async getRelatedFunctionalElementKey(imodel, graphicalElementId) {
|
|
78
|
+
const query = `
|
|
79
|
+
SELECT funcSchemaDef.Name || '.' || funcClassDef.Name funcElClassName, fe.ECInstanceId funcElId
|
|
80
|
+
FROM bis.Element e
|
|
81
|
+
LEFT JOIN func.PhysicalElementFulfillsFunction rel1 ON rel1.SourceECInstanceId = e.ECInstanceId
|
|
82
|
+
LEFT JOIN func.DrawingGraphicRepresentsFunctionalElement rel2 ON rel2.SourceECInstanceId = e.ECInstanceId
|
|
83
|
+
LEFT JOIN func.FunctionalElement fe ON fe.ECInstanceId IN (rel1.TargetECInstanceId, rel2.TargetECInstanceId)
|
|
84
|
+
INNER JOIN meta.ECClassDef funcClassDef ON funcClassDef.ECInstanceId = fe.ECClassId
|
|
85
|
+
INNER JOIN meta.ECSchemaDef funcSchemaDef ON funcSchemaDef.ECInstanceId = funcClassDef.Schema.Id
|
|
86
|
+
WHERE e.ECInstanceId = ?
|
|
87
|
+
`;
|
|
88
|
+
const bindings = new QueryBinder();
|
|
89
|
+
bindings.bindId(1, graphicalElementId);
|
|
90
|
+
for await (const row of imodel.createQueryReader(query, bindings)) {
|
|
91
|
+
if (row.funcElClassName && row.funcElId) {
|
|
92
|
+
return { className: row.funcElClassName.replace(".", ":"), id: row.funcElId };
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
return undefined;
|
|
96
|
+
}
|
|
97
|
+
static async findFirstRelatedFunctionalElementKey(imodel, graphicalElementId) {
|
|
98
|
+
let currId = graphicalElementId;
|
|
99
|
+
while (currId) {
|
|
100
|
+
const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(imodel, currId);
|
|
101
|
+
if (relatedFunctionalKey) {
|
|
102
|
+
return relatedFunctionalKey;
|
|
103
|
+
}
|
|
104
|
+
currId = imodel.elements.tryGetElementProps(currId)?.parent?.id;
|
|
105
|
+
}
|
|
106
|
+
return undefined;
|
|
107
|
+
}
|
|
108
|
+
static async elementClassDerivesFrom(imodel, elementId, baseClassFullName) {
|
|
109
|
+
const query = `
|
|
110
|
+
SELECT 1
|
|
111
|
+
FROM bis.Element e
|
|
112
|
+
INNER JOIN meta.ClassHasAllBaseClasses baseClassRels ON baseClassRels.SourceECInstanceId = e.ECClassId
|
|
113
|
+
INNER JOIN meta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId
|
|
114
|
+
INNER JOIN meta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id
|
|
115
|
+
WHERE e.ECInstanceId = ? AND (baseSchema.Name || ':' || baseClass.Name) = ?
|
|
116
|
+
`;
|
|
117
|
+
const bindings = new QueryBinder();
|
|
118
|
+
bindings.bindId(1, elementId);
|
|
119
|
+
bindings.bindString(2, baseClassFullName);
|
|
120
|
+
for await (const _ of imodel.createQueryReader(query, bindings)) {
|
|
121
|
+
return true;
|
|
122
|
+
}
|
|
123
|
+
return false;
|
|
124
|
+
}
|
|
125
|
+
static async computeFunctionalElementSelection(iModel, ids) {
|
|
126
|
+
const keys = new KeySet();
|
|
127
|
+
await forEachNonTransientId(ids, async (id) => {
|
|
128
|
+
const is3d = await this.elementClassDerivesFrom(iModel, id, "BisCore.GeometricElement3d");
|
|
129
|
+
if (!is3d) {
|
|
130
|
+
// if the input is not a 3d element, we try to find the first related functional element
|
|
131
|
+
const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);
|
|
132
|
+
if (firstFunctionalKey) {
|
|
133
|
+
keys.add(firstFunctionalKey);
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
let keyToAdd;
|
|
138
|
+
if (is3d) {
|
|
139
|
+
// if we're computing scope for a 3d element, try to switch to its related functional element
|
|
140
|
+
keyToAdd = await this.getRelatedFunctionalElementKey(iModel, id);
|
|
141
|
+
}
|
|
142
|
+
if (!keyToAdd) {
|
|
143
|
+
keyToAdd = getElementKey(iModel, id);
|
|
144
|
+
}
|
|
145
|
+
keyToAdd && keys.add(keyToAdd);
|
|
146
|
+
});
|
|
147
|
+
return keys;
|
|
148
|
+
}
|
|
149
|
+
static async computeFunctionalAssemblySelection(iModel, ids) {
|
|
150
|
+
const keys = new KeySet();
|
|
151
|
+
await forEachNonTransientId(ids, async (id) => {
|
|
152
|
+
let idToGetAssemblyFor = id;
|
|
153
|
+
const is3d = await this.elementClassDerivesFrom(iModel, id, "BisCore.GeometricElement3d");
|
|
154
|
+
if (!is3d) {
|
|
155
|
+
// if the input is not a 3d element, we try to find the first related functional element
|
|
156
|
+
const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);
|
|
157
|
+
if (firstFunctionalKey) {
|
|
158
|
+
idToGetAssemblyFor = firstFunctionalKey.id;
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
// find the assembly of either the given element or the functional element
|
|
162
|
+
const assemblyKey = this.getElementKey(iModel, idToGetAssemblyFor, 1);
|
|
163
|
+
let keyToAdd = assemblyKey;
|
|
164
|
+
if (is3d && keyToAdd) {
|
|
165
|
+
// if we're computing scope for a 3d element, try to switch to its related functional element
|
|
166
|
+
const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(iModel, keyToAdd.id);
|
|
167
|
+
if (relatedFunctionalKey) {
|
|
168
|
+
keyToAdd = relatedFunctionalKey;
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
keyToAdd && keys.add(keyToAdd);
|
|
172
|
+
});
|
|
173
|
+
return keys;
|
|
174
|
+
}
|
|
175
|
+
static async computeFunctionalTopAssemblySelection(iModel, ids) {
|
|
176
|
+
const keys = new KeySet();
|
|
177
|
+
await forEachNonTransientId(ids, async (id) => {
|
|
178
|
+
let idToGetAssemblyFor = id;
|
|
179
|
+
const is3d = await this.elementClassDerivesFrom(iModel, id, "BisCore.GeometricElement3d");
|
|
180
|
+
if (!is3d) {
|
|
181
|
+
// if the input is not a 3d element, we try to find the first related functional element
|
|
182
|
+
const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);
|
|
183
|
+
if (firstFunctionalKey) {
|
|
184
|
+
idToGetAssemblyFor = firstFunctionalKey.id;
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
// find the top assembly of either the given element or the functional element
|
|
188
|
+
const topAssemblyKey = this.getElementKey(iModel, idToGetAssemblyFor, Number.MAX_SAFE_INTEGER);
|
|
189
|
+
let keyToAdd = topAssemblyKey;
|
|
190
|
+
if (is3d && keyToAdd) {
|
|
191
|
+
// if we're computing scope for a 3d element, try to switch to its related functional element
|
|
192
|
+
const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(iModel, keyToAdd.id);
|
|
193
|
+
if (relatedFunctionalKey) {
|
|
194
|
+
keyToAdd = relatedFunctionalKey;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
keyToAdd && keys.add(keyToAdd);
|
|
198
|
+
});
|
|
199
|
+
return keys;
|
|
200
|
+
}
|
|
201
|
+
static async computeSelection({ imodel, scope, elementIds }) {
|
|
202
|
+
switch (scope.id) {
|
|
203
|
+
case "element":
|
|
204
|
+
return this.computeElementSelection(imodel, elementIds, scope.ancestorLevel ?? 0);
|
|
205
|
+
case "assembly":
|
|
206
|
+
return this.computeElementSelection(imodel, elementIds, 1);
|
|
207
|
+
case "top-assembly":
|
|
208
|
+
return this.computeElementSelection(imodel, elementIds, Number.MAX_SAFE_INTEGER);
|
|
209
|
+
case "category":
|
|
210
|
+
return this.computeCategorySelection(imodel, elementIds);
|
|
211
|
+
case "model":
|
|
212
|
+
return this.computeModelSelection(imodel, elementIds);
|
|
213
|
+
case "functional":
|
|
214
|
+
case "functional-element":
|
|
215
|
+
return this.computeFunctionalElementSelection(imodel, elementIds);
|
|
216
|
+
case "functional-assembly":
|
|
217
|
+
return this.computeFunctionalAssemblySelection(imodel, elementIds);
|
|
218
|
+
case "functional-top-assembly":
|
|
219
|
+
return this.computeFunctionalTopAssemblySelection(imodel, elementIds);
|
|
220
|
+
}
|
|
221
|
+
throw new PresentationError(PresentationStatus.InvalidArgument, "scopeId");
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
async function forEachNonTransientId(ids, callback) {
|
|
225
|
+
await Promise.all(ids.filter((id) => !Id64.isTransient(id)).map(callback));
|
|
226
|
+
}
|
|
227
|
+
//# sourceMappingURL=SelectionScopesHelper.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SelectionScopesHelper.js","sourceRoot":"","sources":["../../../src/presentation-backend/SelectionScopesHelper.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG,qDAAqD;AACrD;;GAEG;AAGH,OAAO,EAAE,IAAI,EAAyB,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAIL,MAAM,EACN,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAChC,oBAAoB;IACpB,gBAAwB,CAAC;IAElB,MAAM,CAAC,kBAAkB;QAC9B,MAAM,oBAAoB,GAAG,CAAC,OAAe,EAAE,KAAa,EAAE,WAAmB,EAAkB,EAAE,CAAC,CAAC;YACrG,EAAE,EAAE,OAAO;YACX,KAAK;YACL,WAAW;SACZ,CAAC,CAAC;QACH,OAAO;YACL,oBAAoB,CAAC,SAAS,EAAE,SAAS,EAAE,2BAA2B,CAAC;YACvE,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,qCAAqC,CAAC;YACnF,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,iDAAiD,CAAC;YACvG,gHAAgH;YAChH,wGAAwG;YACxG,+FAA+F;SAChG,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,SAAqB,EAAE,aAAqB;QACzF,IAAI,MAAM,GAAG,SAAS,CAAC;QACvB,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;QACtE,OAAO,QAAQ,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;YACvC,MAAM,GAAG,QAAQ,CAAC;YAClB,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;YAClE,EAAE,aAAa,CAAC;QAClB,CAAC;QACD,OAAO,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,MAAgB,EAAE,UAAwB,EAAE,aAAqB;QAC5G,MAAM,UAAU,GAAG,IAAI,MAAM,EAAE,CAAC;QAChC,MAAM,qBAAqB,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;YAC1D,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,MAAgB,EAAE,GAAiB;QAC/E,MAAM,YAAY,GAAG,IAAI,MAAM,EAAE,CAAC;QAClC,MAAM,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5C,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAmB,EAAE,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5F,IAAI,QAAQ,EAAE,CAAC;gBACb,YAAY,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAG,EAAE,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAgB,EAAE,GAAiB;QAC5E,MAAM,SAAS,GAAG,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5C,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YAClD,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,IAAI,KAAK,EAAE,CAAC;gBACV,SAAS,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,EAAG,EAAE,CAAC,CAAC;YACnE,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAA8B;QAClG,MAAM,KAAK,GAAG;;;;;;;;;KASb,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;QACnC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAEvC,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClE,IAAI,GAAG,CAAC,eAAe,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACxC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;YAChF,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,MAAgB,EAAE,kBAA8B;QACxG,IAAI,MAAM,GAA2B,kBAAkB,CAAC;QACxD,OAAO,MAAM,EAAE,CAAC;YACd,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACvF,IAAI,oBAAoB,EAAE,CAAC;gBACzB,OAAO,oBAAoB,CAAC;YAC9B,CAAC;YACD,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;QAClE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,MAAgB,EAAE,SAAqB,EAAE,iBAAyB;QAC7G,MAAM,KAAK,GAAG;;;;;;;KAOb,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;QACnC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9B,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAE1C,IAAI,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;YAChE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,iCAAiC,CAAC,MAAgB,EAAE,GAAiB;QACxF,MAAM,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,EAAE,EAAE,4BAA4B,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvF,IAAI,kBAAkB,EAAE,CAAC;oBACvB,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBAC7B,OAAO;gBACT,CAAC;YACH,CAAC;YACD,IAAI,QAAiC,CAAC;YACtC,IAAI,IAAI,EAAE,CAAC;gBACT,6FAA6F;gBAC7F,QAAQ,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACvC,CAAC;YACD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,MAAgB,EAAE,GAAiB;QACzF,MAAM,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5C,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,EAAE,EAAE,4BAA4B,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvF,IAAI,kBAAkB,EAAE,CAAC;oBACvB,kBAAkB,GAAG,kBAAkB,CAAC,EAAE,CAAC;gBAC7C,CAAC;YACH,CAAC;YACD,0EAA0E;YAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;YACtE,IAAI,QAAQ,GAAG,WAAW,CAAC;YAC3B,IAAI,IAAI,IAAI,QAAQ,EAAE,CAAC;gBACrB,6FAA6F;gBAC7F,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC5F,IAAI,oBAAoB,EAAE,CAAC;oBACzB,QAAQ,GAAG,oBAAoB,CAAC;gBAClC,CAAC;YACH,CAAC;YACD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,MAAgB,EAAE,GAAiB;QAC5F,MAAM,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5C,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,EAAE,EAAE,4BAA4B,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvF,IAAI,kBAAkB,EAAE,CAAC;oBACvB,kBAAkB,GAAG,kBAAkB,CAAC,EAAE,CAAC;gBAC7C,CAAC;YACH,CAAC;YACD,8EAA8E;YAC9E,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAC/F,IAAI,QAAQ,GAAG,cAAc,CAAC;YAC9B,IAAI,IAAI,IAAI,QAAQ,EAAE,CAAC;gBACrB,6FAA6F;gBAC7F,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC5F,IAAI,oBAAoB,EAAE,CAAC;oBACzB,QAAQ,GAAG,oBAAoB,CAAC;gBAClC,CAAC;YACH,CAAC;YACD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAA4C;QAC1G,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;YACjB,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAG,KAAoC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;YACpH,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAC7D,KAAK,cAAc;gBACjB,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;YACnF,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAC3D,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACxD,KAAK,YAAY,CAAC;YAClB,KAAK,oBAAoB;gBACvB,OAAO,IAAI,CAAC,iCAAiC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACpE,KAAK,qBAAqB;gBACxB,OAAO,IAAI,CAAC,kCAAkC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACrE,KAAK,yBAAyB;gBAC5B,OAAO,IAAI,CAAC,qCAAqC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;CACF;AAED,KAAK,UAAU,qBAAqB,CAAC,GAAc,EAAE,QAA2C;IAC9F,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC7E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { GeometricElement, IModelDb } from \"@itwin/core-backend\";\r\nimport { Id64, Id64Array, Id64String } from \"@itwin/core-bentley\";\r\nimport { QueryBinder } from \"@itwin/core-common\";\r\nimport {\r\n ComputeSelectionRequestOptions,\r\n ElementSelectionScopeProps,\r\n InstanceKey,\r\n KeySet,\r\n PresentationError,\r\n PresentationStatus,\r\n SelectionScope,\r\n} from \"@itwin/presentation-common\";\r\nimport { getElementKey } from \"./Utils.js\";\r\n\r\n/**\r\n * Contains helper methods for computing selection scopes. Will get removed\r\n * once rules-driven scopes are implemented.\r\n *\r\n * @internal\r\n */\r\nexport class SelectionScopesHelper {\r\n /* c8 ignore next */\r\n private constructor() { }\r\n\r\n public static getSelectionScopes(): SelectionScope[] {\r\n const createSelectionScope = (scopeId: string, label: string, description: string): SelectionScope => ({\r\n id: scopeId,\r\n label,\r\n description,\r\n });\r\n return [\r\n createSelectionScope(\"element\", \"Element\", \"Select the picked element\"),\r\n createSelectionScope(\"assembly\", \"Assembly\", \"Select parent of the picked element\"),\r\n createSelectionScope(\"top-assembly\", \"Top Assembly\", \"Select the topmost parent of the picked element\"),\r\n // WIP: temporarily comment-out \"category\" and \"model\" scopes since we can't hilite contents of them fast enough\r\n // createSelectionScope(\"category\", \"Category\", \"Select all elements in the picked element's category\"),\r\n // createSelectionScope(\"model\", \"Model\", \"Select all elements in the picked element's model\"),\r\n ];\r\n }\r\n\r\n private static getElementKey(iModel: IModelDb, elementId: Id64String, ancestorLevel: number) {\r\n let currId = elementId;\r\n let parentId = iModel.elements.tryGetElementProps(currId)?.parent?.id;\r\n while (parentId && ancestorLevel !== 0) {\r\n currId = parentId;\r\n parentId = iModel.elements.tryGetElementProps(currId)?.parent?.id;\r\n --ancestorLevel;\r\n }\r\n return getElementKey(iModel, currId);\r\n }\r\n\r\n private static async computeElementSelection(iModel: IModelDb, elementIds: Id64String[], ancestorLevel: number) {\r\n const parentKeys = new KeySet();\r\n await forEachNonTransientId(elementIds, async (id) => {\r\n const key = this.getElementKey(iModel, id, ancestorLevel);\r\n key && parentKeys.add(key);\r\n });\r\n return parentKeys;\r\n }\r\n\r\n private static async computeCategorySelection(iModel: IModelDb, ids: Id64String[]) {\r\n const categoryKeys = new KeySet();\r\n await forEachNonTransientId(ids, async (id) => {\r\n const el = iModel.elements.tryGetElement<GeometricElement>(id);\r\n const category = el?.category ? iModel.elements.tryGetElementProps(el.category) : undefined;\r\n if (category) {\r\n categoryKeys.add({ className: category.classFullName, id: category.id! });\r\n }\r\n });\r\n return categoryKeys;\r\n }\r\n\r\n private static async computeModelSelection(iModel: IModelDb, ids: Id64String[]) {\r\n const modelKeys = new KeySet();\r\n await forEachNonTransientId(ids, async (id) => {\r\n const el = iModel.elements.tryGetElementProps(id);\r\n const model = el ? iModel.models.tryGetModelProps(el.model) : undefined;\r\n if (model) {\r\n modelKeys.add({ className: model.classFullName, id: model.id! });\r\n }\r\n });\r\n return modelKeys;\r\n }\r\n\r\n private static async getRelatedFunctionalElementKey(imodel: IModelDb, graphicalElementId: Id64String): Promise<InstanceKey | undefined> {\r\n const query = `\r\n SELECT funcSchemaDef.Name || '.' || funcClassDef.Name funcElClassName, fe.ECInstanceId funcElId\r\n FROM bis.Element e\r\n LEFT JOIN func.PhysicalElementFulfillsFunction rel1 ON rel1.SourceECInstanceId = e.ECInstanceId\r\n LEFT JOIN func.DrawingGraphicRepresentsFunctionalElement rel2 ON rel2.SourceECInstanceId = e.ECInstanceId\r\n LEFT JOIN func.FunctionalElement fe ON fe.ECInstanceId IN (rel1.TargetECInstanceId, rel2.TargetECInstanceId)\r\n INNER JOIN meta.ECClassDef funcClassDef ON funcClassDef.ECInstanceId = fe.ECClassId\r\n INNER JOIN meta.ECSchemaDef funcSchemaDef ON funcSchemaDef.ECInstanceId = funcClassDef.Schema.Id\r\n WHERE e.ECInstanceId = ?\r\n `;\r\n\r\n const bindings = new QueryBinder();\r\n bindings.bindId(1, graphicalElementId);\r\n\r\n for await (const row of imodel.createQueryReader(query, bindings)) {\r\n if (row.funcElClassName && row.funcElId) {\r\n return { className: row.funcElClassName.replace(\".\", \":\"), id: row.funcElId };\r\n }\r\n }\r\n return undefined;\r\n }\r\n\r\n private static async findFirstRelatedFunctionalElementKey(imodel: IModelDb, graphicalElementId: Id64String): Promise<InstanceKey | undefined> {\r\n let currId: Id64String | undefined = graphicalElementId;\r\n while (currId) {\r\n const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(imodel, currId);\r\n if (relatedFunctionalKey) {\r\n return relatedFunctionalKey;\r\n }\r\n currId = imodel.elements.tryGetElementProps(currId)?.parent?.id;\r\n }\r\n return undefined;\r\n }\r\n\r\n private static async elementClassDerivesFrom(imodel: IModelDb, elementId: Id64String, baseClassFullName: string): Promise<boolean> {\r\n const query = `\r\n SELECT 1\r\n FROM bis.Element e\r\n INNER JOIN meta.ClassHasAllBaseClasses baseClassRels ON baseClassRels.SourceECInstanceId = e.ECClassId\r\n INNER JOIN meta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId\r\n INNER JOIN meta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id\r\n WHERE e.ECInstanceId = ? AND (baseSchema.Name || ':' || baseClass.Name) = ?\r\n `;\r\n\r\n const bindings = new QueryBinder();\r\n bindings.bindId(1, elementId);\r\n bindings.bindString(2, baseClassFullName);\r\n\r\n for await (const _ of imodel.createQueryReader(query, bindings)) {\r\n return true;\r\n }\r\n return false;\r\n }\r\n\r\n private static async computeFunctionalElementSelection(iModel: IModelDb, ids: Id64String[]) {\r\n const keys = new KeySet();\r\n await forEachNonTransientId(ids, async (id) => {\r\n const is3d = await this.elementClassDerivesFrom(iModel, id, \"BisCore.GeometricElement3d\");\r\n if (!is3d) {\r\n // if the input is not a 3d element, we try to find the first related functional element\r\n const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);\r\n if (firstFunctionalKey) {\r\n keys.add(firstFunctionalKey);\r\n return;\r\n }\r\n }\r\n let keyToAdd: InstanceKey | undefined;\r\n if (is3d) {\r\n // if we're computing scope for a 3d element, try to switch to its related functional element\r\n keyToAdd = await this.getRelatedFunctionalElementKey(iModel, id);\r\n }\r\n if (!keyToAdd) {\r\n keyToAdd = getElementKey(iModel, id);\r\n }\r\n keyToAdd && keys.add(keyToAdd);\r\n });\r\n return keys;\r\n }\r\n\r\n private static async computeFunctionalAssemblySelection(iModel: IModelDb, ids: Id64String[]) {\r\n const keys = new KeySet();\r\n await forEachNonTransientId(ids, async (id) => {\r\n let idToGetAssemblyFor = id;\r\n const is3d = await this.elementClassDerivesFrom(iModel, id, \"BisCore.GeometricElement3d\");\r\n if (!is3d) {\r\n // if the input is not a 3d element, we try to find the first related functional element\r\n const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);\r\n if (firstFunctionalKey) {\r\n idToGetAssemblyFor = firstFunctionalKey.id;\r\n }\r\n }\r\n // find the assembly of either the given element or the functional element\r\n const assemblyKey = this.getElementKey(iModel, idToGetAssemblyFor, 1);\r\n let keyToAdd = assemblyKey;\r\n if (is3d && keyToAdd) {\r\n // if we're computing scope for a 3d element, try to switch to its related functional element\r\n const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(iModel, keyToAdd.id);\r\n if (relatedFunctionalKey) {\r\n keyToAdd = relatedFunctionalKey;\r\n }\r\n }\r\n keyToAdd && keys.add(keyToAdd);\r\n });\r\n return keys;\r\n }\r\n\r\n private static async computeFunctionalTopAssemblySelection(iModel: IModelDb, ids: Id64String[]) {\r\n const keys = new KeySet();\r\n await forEachNonTransientId(ids, async (id) => {\r\n let idToGetAssemblyFor = id;\r\n const is3d = await this.elementClassDerivesFrom(iModel, id, \"BisCore.GeometricElement3d\");\r\n if (!is3d) {\r\n // if the input is not a 3d element, we try to find the first related functional element\r\n const firstFunctionalKey = await this.findFirstRelatedFunctionalElementKey(iModel, id);\r\n if (firstFunctionalKey) {\r\n idToGetAssemblyFor = firstFunctionalKey.id;\r\n }\r\n }\r\n // find the top assembly of either the given element or the functional element\r\n const topAssemblyKey = this.getElementKey(iModel, idToGetAssemblyFor, Number.MAX_SAFE_INTEGER);\r\n let keyToAdd = topAssemblyKey;\r\n if (is3d && keyToAdd) {\r\n // if we're computing scope for a 3d element, try to switch to its related functional element\r\n const relatedFunctionalKey = await this.getRelatedFunctionalElementKey(iModel, keyToAdd.id);\r\n if (relatedFunctionalKey) {\r\n keyToAdd = relatedFunctionalKey;\r\n }\r\n }\r\n keyToAdd && keys.add(keyToAdd);\r\n });\r\n return keys;\r\n }\r\n\r\n public static async computeSelection({ imodel, scope, elementIds }: ComputeSelectionRequestOptions<IModelDb>): Promise<KeySet> {\r\n switch (scope.id) {\r\n case \"element\":\r\n return this.computeElementSelection(imodel, elementIds, (scope as ElementSelectionScopeProps).ancestorLevel ?? 0);\r\n case \"assembly\":\r\n return this.computeElementSelection(imodel, elementIds, 1);\r\n case \"top-assembly\":\r\n return this.computeElementSelection(imodel, elementIds, Number.MAX_SAFE_INTEGER);\r\n case \"category\":\r\n return this.computeCategorySelection(imodel, elementIds);\r\n case \"model\":\r\n return this.computeModelSelection(imodel, elementIds);\r\n case \"functional\":\r\n case \"functional-element\":\r\n return this.computeFunctionalElementSelection(imodel, elementIds);\r\n case \"functional-assembly\":\r\n return this.computeFunctionalAssemblySelection(imodel, elementIds);\r\n case \"functional-top-assembly\":\r\n return this.computeFunctionalTopAssemblySelection(imodel, elementIds);\r\n }\r\n throw new PresentationError(PresentationStatus.InvalidArgument, \"scopeId\");\r\n }\r\n}\r\n\r\nasync function forEachNonTransientId(ids: Id64Array, callback: (id: Id64String) => Promise<void>): Promise<void> {\r\n await Promise.all(ids.filter((id) => !Id64.isTransient(id)).map(callback));\r\n}\r\n"]}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Core
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Configuration properties for [[TemporaryStorage]].
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export interface TemporaryStorageProps<T> {
|
|
9
|
+
/** A method that's called for every value before it's removed from storage */
|
|
10
|
+
cleanupHandler?: (id: string, value: T, reason: "timeout" | "dispose" | "request") => void;
|
|
11
|
+
onDisposedSingle?: (id: string) => void;
|
|
12
|
+
onDisposedAll?: () => void;
|
|
13
|
+
/**
|
|
14
|
+
* An interval at which the storage attempts to clean up its values.
|
|
15
|
+
* When `0` or `undefined` is specified, values are not cleaned up
|
|
16
|
+
* automatically and cleanup has to be initiated manually by calling
|
|
17
|
+
* [[TemporaryStorage.disposeOutdatedValues]].
|
|
18
|
+
*/
|
|
19
|
+
cleanupInterval?: number;
|
|
20
|
+
/**
|
|
21
|
+
* Shortest period of time which the value should be kept in storage
|
|
22
|
+
* unused before it's cleaned up.
|
|
23
|
+
*
|
|
24
|
+
* `undefined` means the values may be kept unused in the storage indefinitely.
|
|
25
|
+
* `0` means the values are removed from the storage on every cleanup (either manual
|
|
26
|
+
* call to [[TemporaryStorage.disposeOutdatedValues]] or scheduled (controlled
|
|
27
|
+
* by [[cleanupInterval]])).
|
|
28
|
+
*/
|
|
29
|
+
unusedValueLifetime?: number;
|
|
30
|
+
/**
|
|
31
|
+
* The maximum period of time which the value should be kept in storage
|
|
32
|
+
* before it's cleaned up. The time is measured from the moment the value is added
|
|
33
|
+
* to the storage.
|
|
34
|
+
*
|
|
35
|
+
* `undefined` means the values may be kept indefinitely. `0` means they're removed
|
|
36
|
+
* up on every cleanup (either manual call to [[TemporaryStorage.disposeOutdatedValues]]
|
|
37
|
+
* or scheduled (controlled by [[cleanupInterval]])).
|
|
38
|
+
*/
|
|
39
|
+
maxValueLifetime?: number;
|
|
40
|
+
}
|
|
41
|
+
/** Value with know last used time */
|
|
42
|
+
interface TemporaryValue<T> {
|
|
43
|
+
created: Date;
|
|
44
|
+
lastUsed: Date;
|
|
45
|
+
value: T;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Storage for values that get removed from it after being unused (not-requested
|
|
49
|
+
* for a specified amount of time).
|
|
50
|
+
*
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
export declare class TemporaryStorage<T> implements Disposable {
|
|
54
|
+
private _timer?;
|
|
55
|
+
protected _values: Map<string, TemporaryValue<T>>;
|
|
56
|
+
readonly props: TemporaryStorageProps<T>;
|
|
57
|
+
/**
|
|
58
|
+
* Constructor. Creates the storage using supplied params.
|
|
59
|
+
*/
|
|
60
|
+
constructor(props: TemporaryStorageProps<T>);
|
|
61
|
+
/**
|
|
62
|
+
* Destructor. Must be called to clean up the stored values
|
|
63
|
+
* and other resources
|
|
64
|
+
*/
|
|
65
|
+
[Symbol.dispose](): void;
|
|
66
|
+
/**
|
|
67
|
+
* Cleans up values that are currently outdated (based
|
|
68
|
+
* on their max and unused value lifetimes specified through [[Props]]).
|
|
69
|
+
*/
|
|
70
|
+
disposeOutdatedValues: () => void;
|
|
71
|
+
private deleteExistingEntry;
|
|
72
|
+
/**
|
|
73
|
+
* Get a value from the storage.
|
|
74
|
+
*
|
|
75
|
+
* **Note:** requesting a value with this method updates it's last used time.
|
|
76
|
+
*/
|
|
77
|
+
getValue(id: string): T | undefined;
|
|
78
|
+
notifyValueUsed(id: string): void;
|
|
79
|
+
/**
|
|
80
|
+
* Adds a value into the storage.
|
|
81
|
+
* @throws An error when trying to add a value with ID that's already stored in the storage.
|
|
82
|
+
*/
|
|
83
|
+
addValue(id: string, value: T): void;
|
|
84
|
+
/** Deletes a value with given id. */
|
|
85
|
+
deleteValue(id: string): void;
|
|
86
|
+
/**
|
|
87
|
+
* Get all values currently in this storage.
|
|
88
|
+
*
|
|
89
|
+
* **Note:** requesting values with this method **doesn't**
|
|
90
|
+
* update their last used times.
|
|
91
|
+
*/
|
|
92
|
+
get values(): T[];
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Configuration properties for [[FactoryBasedTemporaryStorage]].
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
export interface FactoryBasedTemporaryStorageProps<T> extends TemporaryStorageProps<T> {
|
|
99
|
+
/** A factory method that creates a stored value given it's identifier */
|
|
100
|
+
factory: (id: string, onValueUsed: () => void) => T;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Storage for values that get removed from it after being unused (not-requested
|
|
104
|
+
* for a specified amount of time).
|
|
105
|
+
*
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
export declare class FactoryBasedTemporaryStorage<T> extends TemporaryStorage<T> {
|
|
109
|
+
readonly props: FactoryBasedTemporaryStorageProps<T>;
|
|
110
|
+
/**
|
|
111
|
+
* Constructor. Creates the storage using supplied params.
|
|
112
|
+
*/
|
|
113
|
+
constructor(props: FactoryBasedTemporaryStorageProps<T>);
|
|
114
|
+
/**
|
|
115
|
+
* Get a value from the storage. If the value with the specified id
|
|
116
|
+
* doesn't exist, it gets created.
|
|
117
|
+
*
|
|
118
|
+
* **Note:** requesting a value with this method updates it's last used time.
|
|
119
|
+
*/
|
|
120
|
+
getValue(id: string): T;
|
|
121
|
+
}
|
|
122
|
+
export {};
|
|
123
|
+
//# sourceMappingURL=TemporaryStorage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"TemporaryStorage.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/TemporaryStorage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,8EAA8E;IAC9E,cAAc,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,KAAK,IAAI,CAAC;IAE3F,gBAAgB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,qCAAqC;AACrC,UAAU,cAAc,CAAC,CAAC;IACxB,OAAO,EAAE,IAAI,CAAC;IACd,QAAQ,EAAE,IAAI,CAAC;IACf,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;;;;GAKG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,YAAW,UAAU;IACpD,OAAO,CAAC,MAAM,CAAC,CAAiB;IAChC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,SAAgB,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEhD;;OAEG;gBACS,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAQ3C;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;IAcvB;;;OAGG;IACI,qBAAqB,aAoB1B;IAEF,OAAO,CAAC,mBAAmB;IAO3B;;;;OAIG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IASnC,eAAe,CAAC,EAAE,EAAE,MAAM;IAOjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAOpC,qCAAqC;IAC9B,WAAW,CAAC,EAAE,EAAE,MAAM;IAM7B;;;;;OAKG;IACH,IAAW,MAAM,IAAI,CAAC,EAAE,CAMvB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC,CAAC,CAAC,CAAE,SAAQ,qBAAqB,CAAC,CAAC,CAAC;IACpF,yEAAyE;IACzE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,qBAAa,4BAA4B,CAAC,CAAC,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IACtE,SAAyB,KAAK,EAAE,iCAAiC,CAAC,CAAC,CAAC,CAAC;IAErE;;OAEG;gBACS,KAAK,EAAE,iCAAiC,CAAC,CAAC,CAAC;IAKvD;;;;;OAKG;IACa,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC;CAUxC"}
|