@combeenation/3d-viewer 9.3.0 → 10.0.0-alpha3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/README.md +9 -111
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +666 -667
  8. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  9. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  10. package/dist/lib-cjs/api/classes/event.js +424 -424
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  12. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  13. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  14. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  15. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
  16. package/dist/lib-cjs/api/classes/parameter.js +642 -642
  17. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  18. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  19. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  20. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  21. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  22. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  23. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  24. package/dist/lib-cjs/api/classes/variant.js +871 -871
  25. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  26. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  27. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  28. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  29. package/dist/lib-cjs/api/classes/viewer.d.ts +211 -213
  30. package/dist/lib-cjs/api/classes/viewer.js +736 -717
  31. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  32. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  33. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  34. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  35. package/dist/lib-cjs/api/classes/viewerLight.js +344 -348
  36. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -1
  37. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  38. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  39. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  40. package/dist/lib-cjs/api/internal/sceneSetup.js +224 -226
  41. package/dist/lib-cjs/api/internal/sceneSetup.js.map +1 -1
  42. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  43. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  44. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +102 -102
  45. package/dist/lib-cjs/api/manager/gltfExportManager.js +322 -322
  46. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  47. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  48. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  49. package/dist/lib-cjs/api/manager/tagManager.js +535 -535
  50. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  51. package/dist/lib-cjs/api/manager/textureLoadManager.js +98 -98
  52. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  53. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  54. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  55. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  56. package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
  57. package/dist/lib-cjs/api/util/babylonHelper.js +826 -826
  58. package/dist/lib-cjs/api/util/geometryHelper.d.ts +7 -7
  59. package/dist/lib-cjs/api/util/geometryHelper.js +115 -115
  60. package/dist/lib-cjs/api/util/globalTypes.d.ts +484 -484
  61. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  62. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  63. package/dist/lib-cjs/api/util/resourceHelper.js +214 -214
  64. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  66. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  67. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  68. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  69. package/dist/lib-cjs/api/util/structureHelper.js +64 -64
  70. package/dist/lib-cjs/buildinfo.json +3 -3
  71. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  72. package/dist/lib-cjs/index.d.ts +54 -54
  73. package/dist/lib-cjs/index.js +117 -117
  74. package/package.json +84 -82
  75. package/src/api/classes/animationInterface.ts +10 -10
  76. package/src/api/classes/dottedPath.ts +181 -181
  77. package/src/api/classes/element.ts +723 -723
  78. package/src/api/classes/event.ts +457 -457
  79. package/src/api/classes/eventBroadcaster.ts +52 -52
  80. package/src/api/classes/fuzzyMap.ts +21 -21
  81. package/src/api/classes/parameter.ts +686 -686
  82. package/src/api/classes/parameterObservable.ts +73 -73
  83. package/src/api/classes/parameterizable.ts +87 -87
  84. package/src/api/classes/placementAnimation.ts +162 -162
  85. package/src/api/classes/variant.ts +964 -964
  86. package/src/api/classes/variantInstance.ts +123 -123
  87. package/src/api/classes/variantParameterizable.ts +83 -83
  88. package/src/api/classes/viewer.ts +786 -770
  89. package/src/api/classes/viewerError.ts +63 -63
  90. package/src/api/classes/viewerLight.ts +335 -339
  91. package/src/api/internal/debugViewer.ts +90 -90
  92. package/src/api/internal/lensRendering.ts +9 -9
  93. package/src/api/internal/sceneSetup.ts +203 -205
  94. package/src/api/manager/animationManager.ts +143 -143
  95. package/src/api/manager/gltfExportManager.ts +312 -312
  96. package/src/api/manager/sceneManager.ts +134 -134
  97. package/src/api/manager/tagManager.ts +576 -576
  98. package/src/api/manager/textureLoadManager.ts +96 -96
  99. package/src/api/manager/variantInstanceManager.ts +306 -306
  100. package/src/api/store/specStorage.ts +68 -68
  101. package/src/api/util/babylonHelper.ts +915 -915
  102. package/src/api/util/geometryHelper.ts +140 -140
  103. package/src/api/util/globalTypes.ts +560 -560
  104. package/src/api/util/resourceHelper.ts +201 -201
  105. package/src/api/util/sceneLoaderHelper.ts +170 -170
  106. package/src/api/util/stringHelper.ts +30 -30
  107. package/src/api/util/structureHelper.ts +63 -63
  108. package/src/buildinfo.json +3 -3
  109. package/src/dev.ts +70 -62
  110. package/src/index.ts +103 -103
  111. package/src/types.d.ts +49 -38
@@ -1,181 +1,181 @@
1
- export class DottedPath {
2
- static DELIMITER: string = '.';
3
-
4
- static SAFE_CHAR: string = '·';
5
-
6
- public parts: string[] = [];
7
-
8
- /**
9
- * Magic factory function that creates a DottedPath based on the argument type.
10
- */
11
- public static create(dottedPath?: DottedPathArgument): DottedPath {
12
- if (dottedPath?.constructor === DottedPath) {
13
- return (dottedPath as DottedPath).clone();
14
- }
15
- if (dottedPath?.constructor === String) {
16
- return DottedPath.createFromPath(dottedPath as string);
17
- }
18
- if (dottedPath?.constructor === Array) {
19
- return DottedPath.createFromParts(dottedPath as string[]);
20
- }
21
- return DottedPath.createEmpty();
22
- }
23
-
24
- /**
25
- * Creates a DottedPath from a string.
26
- * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
27
- * E.g. "part1.part2.'part.3'.part_4"
28
- */
29
- public static createFromPath(path: string): DottedPath {
30
- if (path.length === 0) {
31
- return this.createEmpty();
32
- }
33
- if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
34
- const bd = '[\'|"]';
35
- const search = new RegExp(`${bd}(.*)${bd}`, 'g');
36
- let matches = search.exec(path);
37
- while (matches !== null) {
38
- const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
39
- path = path.replace(_search, this.sanitizePart(matches[1]));
40
- matches = search.exec(path);
41
- }
42
- }
43
- return this.createFromParts(path.split(DottedPath.DELIMITER));
44
- }
45
-
46
- /**
47
- * Creates a DottedPath from a string list.
48
- */
49
- public static createFromParts(parts: string[]): DottedPath {
50
- const dottedPath = new DottedPath();
51
- parts.forEach(part => dottedPath.addPart(part));
52
- return dottedPath;
53
- }
54
-
55
- /**
56
- * Creates an empty DottedPath.
57
- */
58
- public static createEmpty(): DottedPath {
59
- return new DottedPath();
60
- }
61
-
62
- /**
63
- * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
64
- * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
65
- * (i) Does not trim whitespace.
66
- */
67
- public static sanitizePart(part: string): string {
68
- return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
69
- }
70
-
71
- /**
72
- * Constructor
73
- */
74
- private constructor() {}
75
-
76
- /**
77
- * The path.
78
- * (i) Does not return an empty dot for no path.
79
- */
80
- get path(): string {
81
- return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
82
- }
83
-
84
- /**
85
- * The first part.
86
- */
87
- get firstPart(): string | null {
88
- if (this.parts.length > 0) {
89
- return this.parts[0];
90
- }
91
- return null;
92
- }
93
-
94
- /**
95
- * The last part.
96
- */
97
- get lastPart(): string | null {
98
- if (this.parts.length > 0) {
99
- return this.parts[this.parts.length - 1];
100
- }
101
- return null;
102
- }
103
-
104
- /**
105
- * Gets the tokens to each leaf of the DottedPath tree.
106
- * E.g. "part1.part2.part_3" will return an array like
107
- * ["part1", "part1.part2", "part1.part2.part_3"]
108
- */
109
- get leafTokens(): string[] {
110
- const parents: string[] = [];
111
- return this.parts.map(part => {
112
- parents.push(part);
113
- return DottedPath.create(parents).path;
114
- });
115
- }
116
-
117
- /**
118
- * Removes the first part and returns it.
119
- */
120
- public shiftPart(): string | undefined {
121
- return this.parts.shift();
122
- }
123
-
124
- /**
125
- * Adds part to the beginning of parts list.
126
- */
127
- public unshiftPart(part: string, duplicateCheck: boolean = false): DottedPath {
128
- part = DottedPath.sanitizePart(part);
129
- if (duplicateCheck && this.firstPart === part) {
130
- return this;
131
- }
132
- this.parts.unshift(part);
133
- return this;
134
- }
135
-
136
- /**
137
- * Adds part to the end of parts list.
138
- * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
139
- */
140
- public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
141
- if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
142
- return this;
143
- }
144
- part = DottedPath.sanitizePart(part);
145
- if (duplicateCheck && this.lastPart === part) {
146
- return this;
147
- }
148
- this.parts.push(part);
149
- return this;
150
- }
151
-
152
- /**
153
- * Adds multiple parts to the end of parts list.
154
- */
155
- public addParts(parts: string[], duplicateCheck: boolean = false): DottedPath {
156
- parts.forEach(part => this.addPart(part, duplicateCheck));
157
- return this;
158
- }
159
-
160
- /**
161
- * Removes the last part and returns it.
162
- */
163
- public popPart(): string | undefined {
164
- return this.parts.pop();
165
- }
166
-
167
- public toString(): string {
168
- return this.path;
169
- }
170
-
171
- public valueOf(): string {
172
- return this.path;
173
- }
174
-
175
- /**
176
- * Clones the DottedPath.
177
- */
178
- public clone(): DottedPath {
179
- return DottedPath.createFromParts(this.parts);
180
- }
181
- }
1
+ export class DottedPath {
2
+ static DELIMITER: string = '.';
3
+
4
+ static SAFE_CHAR: string = '·';
5
+
6
+ public parts: string[] = [];
7
+
8
+ /**
9
+ * Magic factory function that creates a DottedPath based on the argument type.
10
+ */
11
+ public static create(dottedPath?: DottedPathArgument): DottedPath {
12
+ if (dottedPath?.constructor === DottedPath) {
13
+ return (dottedPath as DottedPath).clone();
14
+ }
15
+ if (dottedPath?.constructor === String) {
16
+ return DottedPath.createFromPath(dottedPath as string);
17
+ }
18
+ if (dottedPath?.constructor === Array) {
19
+ return DottedPath.createFromParts(dottedPath as string[]);
20
+ }
21
+ return DottedPath.createEmpty();
22
+ }
23
+
24
+ /**
25
+ * Creates a DottedPath from a string.
26
+ * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
27
+ * E.g. "part1.part2.'part.3'.part_4"
28
+ */
29
+ public static createFromPath(path: string): DottedPath {
30
+ if (path.length === 0) {
31
+ return this.createEmpty();
32
+ }
33
+ if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
34
+ const bd = '[\'|"]';
35
+ const search = new RegExp(`${bd}(.*)${bd}`, 'g');
36
+ let matches = search.exec(path);
37
+ while (matches !== null) {
38
+ const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
39
+ path = path.replace(_search, this.sanitizePart(matches[1]));
40
+ matches = search.exec(path);
41
+ }
42
+ }
43
+ return this.createFromParts(path.split(DottedPath.DELIMITER));
44
+ }
45
+
46
+ /**
47
+ * Creates a DottedPath from a string list.
48
+ */
49
+ public static createFromParts(parts: string[]): DottedPath {
50
+ const dottedPath = new DottedPath();
51
+ parts.forEach(part => dottedPath.addPart(part));
52
+ return dottedPath;
53
+ }
54
+
55
+ /**
56
+ * Creates an empty DottedPath.
57
+ */
58
+ public static createEmpty(): DottedPath {
59
+ return new DottedPath();
60
+ }
61
+
62
+ /**
63
+ * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
64
+ * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
65
+ * (i) Does not trim whitespace.
66
+ */
67
+ public static sanitizePart(part: string): string {
68
+ return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
69
+ }
70
+
71
+ /**
72
+ * Constructor
73
+ */
74
+ private constructor() {}
75
+
76
+ /**
77
+ * The path.
78
+ * (i) Does not return an empty dot for no path.
79
+ */
80
+ get path(): string {
81
+ return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
82
+ }
83
+
84
+ /**
85
+ * The first part.
86
+ */
87
+ get firstPart(): string | null {
88
+ if (this.parts.length > 0) {
89
+ return this.parts[0];
90
+ }
91
+ return null;
92
+ }
93
+
94
+ /**
95
+ * The last part.
96
+ */
97
+ get lastPart(): string | null {
98
+ if (this.parts.length > 0) {
99
+ return this.parts[this.parts.length - 1];
100
+ }
101
+ return null;
102
+ }
103
+
104
+ /**
105
+ * Gets the tokens to each leaf of the DottedPath tree.
106
+ * E.g. "part1.part2.part_3" will return an array like
107
+ * ["part1", "part1.part2", "part1.part2.part_3"]
108
+ */
109
+ get leafTokens(): string[] {
110
+ const parents: string[] = [];
111
+ return this.parts.map(part => {
112
+ parents.push(part);
113
+ return DottedPath.create(parents).path;
114
+ });
115
+ }
116
+
117
+ /**
118
+ * Removes the first part and returns it.
119
+ */
120
+ public shiftPart(): string | undefined {
121
+ return this.parts.shift();
122
+ }
123
+
124
+ /**
125
+ * Adds part to the beginning of parts list.
126
+ */
127
+ public unshiftPart(part: string, duplicateCheck: boolean = false): DottedPath {
128
+ part = DottedPath.sanitizePart(part);
129
+ if (duplicateCheck && this.firstPart === part) {
130
+ return this;
131
+ }
132
+ this.parts.unshift(part);
133
+ return this;
134
+ }
135
+
136
+ /**
137
+ * Adds part to the end of parts list.
138
+ * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
139
+ */
140
+ public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
141
+ if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
142
+ return this;
143
+ }
144
+ part = DottedPath.sanitizePart(part);
145
+ if (duplicateCheck && this.lastPart === part) {
146
+ return this;
147
+ }
148
+ this.parts.push(part);
149
+ return this;
150
+ }
151
+
152
+ /**
153
+ * Adds multiple parts to the end of parts list.
154
+ */
155
+ public addParts(parts: string[], duplicateCheck: boolean = false): DottedPath {
156
+ parts.forEach(part => this.addPart(part, duplicateCheck));
157
+ return this;
158
+ }
159
+
160
+ /**
161
+ * Removes the last part and returns it.
162
+ */
163
+ public popPart(): string | undefined {
164
+ return this.parts.pop();
165
+ }
166
+
167
+ public toString(): string {
168
+ return this.path;
169
+ }
170
+
171
+ public valueOf(): string {
172
+ return this.path;
173
+ }
174
+
175
+ /**
176
+ * Clones the DottedPath.
177
+ */
178
+ public clone(): DottedPath {
179
+ return DottedPath.createFromParts(this.parts);
180
+ }
181
+ }