@combeenation/3d-viewer 4.2.0 → 5.0.0-alpha1

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 (95) hide show
  1. package/README.md +2 -2
  2. package/dist/lib-cjs/api/classes/dottedPath.js +2 -5
  3. package/dist/lib-cjs/api/classes/dottedPath.js.map +1 -1
  4. package/dist/lib-cjs/api/classes/element.d.ts +9 -0
  5. package/dist/lib-cjs/api/classes/element.js +114 -66
  6. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  7. package/dist/lib-cjs/api/classes/event.js.map +1 -1
  8. package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +1 -1
  9. package/dist/lib-cjs/api/classes/parameter.js +3 -2
  10. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  11. package/dist/lib-cjs/api/classes/parameterObservable.js.map +1 -1
  12. package/dist/lib-cjs/api/classes/parameterizable.js.map +1 -1
  13. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +1 -0
  14. package/dist/lib-cjs/api/classes/placementAnimation.js +2 -2
  15. package/dist/lib-cjs/api/classes/placementAnimation.js.map +1 -1
  16. package/dist/lib-cjs/api/classes/variant.js +26 -19
  17. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  18. package/dist/lib-cjs/api/classes/variantInstance.js +19 -19
  19. package/dist/lib-cjs/api/classes/variantInstance.js.map +1 -1
  20. package/dist/lib-cjs/api/classes/variantParameterizable.js.map +1 -1
  21. package/dist/lib-cjs/api/classes/viewer.d.ts +40 -1
  22. package/dist/lib-cjs/api/classes/viewer.js +144 -48
  23. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  24. package/dist/lib-cjs/api/classes/viewerLight.js +25 -25
  25. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -1
  26. package/dist/lib-cjs/api/internal/debugViewer.js +1 -2
  27. package/dist/lib-cjs/api/internal/debugViewer.js.map +1 -1
  28. package/dist/lib-cjs/api/internal/lensRendering.js.map +1 -1
  29. package/dist/lib-cjs/api/internal/sceneSetup.js +25 -22
  30. package/dist/lib-cjs/api/internal/sceneSetup.js.map +1 -1
  31. package/dist/lib-cjs/api/manager/animationManager.js +24 -15
  32. package/dist/lib-cjs/api/manager/animationManager.js.map +1 -1
  33. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +40 -10
  34. package/dist/lib-cjs/api/manager/gltfExportManager.js +135 -20
  35. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  36. package/dist/lib-cjs/api/manager/sceneManager.js +3 -3
  37. package/dist/lib-cjs/api/manager/sceneManager.js.map +1 -1
  38. package/dist/lib-cjs/api/manager/variantInstanceManager.js +10 -7
  39. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  40. package/dist/lib-cjs/api/store/specStorage.js.map +1 -1
  41. package/dist/lib-cjs/api/util/babylonHelper.d.ts +1 -1
  42. package/dist/lib-cjs/api/util/babylonHelper.js +12 -15
  43. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  44. package/dist/lib-cjs/api/util/globalTypes.d.ts +41 -25
  45. package/dist/lib-cjs/api/util/resourceHelper.js +3 -1
  46. package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
  47. package/dist/lib-cjs/api/util/stringHelper.d.ts +1 -1
  48. package/dist/lib-cjs/api/util/stringHelper.js +2 -2
  49. package/dist/lib-cjs/api/util/stringHelper.js.map +1 -1
  50. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -0
  51. package/dist/lib-cjs/api/util/structureHelper.js +45 -0
  52. package/dist/lib-cjs/api/util/structureHelper.js.map +1 -0
  53. package/dist/lib-cjs/index.js +1 -0
  54. package/dist/lib-cjs/index.js.map +1 -1
  55. package/package.json +11 -7
  56. package/src/api/classes/animationInterface.ts +4 -6
  57. package/src/api/classes/dottedPath.ts +179 -187
  58. package/src/api/classes/element.ts +665 -621
  59. package/src/api/classes/event.ts +310 -313
  60. package/src/api/classes/eventBroadcaster.ts +47 -49
  61. package/src/api/classes/parameter.ts +394 -397
  62. package/src/api/classes/parameterObservable.ts +84 -83
  63. package/src/api/classes/parameterizable.ts +71 -73
  64. package/src/api/classes/placementAnimation.ts +130 -130
  65. package/src/api/classes/variant.ts +806 -778
  66. package/src/api/classes/variantInstance.ts +60 -52
  67. package/src/api/classes/variantParameterizable.ts +72 -67
  68. package/src/api/classes/viewer.ts +592 -490
  69. package/src/api/classes/viewerLight.ts +301 -301
  70. package/src/api/internal/debugViewer.ts +61 -53
  71. package/src/api/internal/lensRendering.ts +2 -3
  72. package/src/api/internal/sceneSetup.ts +144 -137
  73. package/src/api/manager/animationManager.ts +122 -97
  74. package/src/api/manager/gltfExportManager.ts +192 -0
  75. package/src/api/manager/sceneManager.ts +83 -86
  76. package/src/api/manager/variantInstanceManager.ts +234 -224
  77. package/src/api/store/specStorage.ts +48 -51
  78. package/src/api/util/babylonHelper.ts +329 -325
  79. package/src/api/util/globalTypes.ts +260 -246
  80. package/src/api/util/resourceHelper.ts +97 -109
  81. package/src/api/util/stringHelper.ts +13 -16
  82. package/src/api/util/structureHelper.ts +43 -0
  83. package/src/buildinfo.json +2 -2
  84. package/src/commonjs.tsconfig.json +8 -11
  85. package/src/declaration.tsconfig.json +6 -8
  86. package/src/dev.ts +28 -29
  87. package/src/es6.tsconfig.json +8 -11
  88. package/src/index.ts +40 -39
  89. package/src/pagesconfig.json +4 -0
  90. package/src/tsconfig.json +30 -41
  91. package/src/tsconfig.types.json +8 -9
  92. package/src/types.d.ts +0 -1
  93. package/dist/lib-cjs/api/classes/elementParameterizable.d.ts +0 -14
  94. package/dist/lib-cjs/api/classes/elementParameterizable.js +0 -135
  95. package/dist/lib-cjs/api/classes/elementParameterizable.js.map +0 -1
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@combeenation/3d-viewer",
3
3
  "description": "Combeenation 3D Viewer",
4
- "version": "4.2.0",
4
+ "version": "5.0.0-alpha1",
5
5
  "homepage": "https://github.com/Combeenation/3d-viewer#readme",
6
6
  "keywords": [],
7
7
  "author": "",
@@ -39,18 +39,20 @@
39
39
  "pub-alpha": "npm run dist-cjs && npm publish --tag alpha",
40
40
  "pub-beta": "npm run dist-cjs && npm publish --tag beta",
41
41
  "pub-rc": "npm run dist-cjs && npm publish --tag rc",
42
- "pack": "npm run dist-cjs && npm pack"
42
+ "pack": "npm run dist-cjs && npm pack",
43
+ "format": "prettier --write ."
43
44
  },
44
45
  "dependencies": {
45
- "@babylonjs/core": "4.2.1",
46
- "@babylonjs/inspector": "4.2.1",
47
- "@babylonjs/loaders": "4.2.1",
48
- "@babylonjs/materials": "4.2.1",
46
+ "@babylonjs/core": "^5.6.0",
47
+ "@babylonjs/inspector": "5.6.0",
48
+ "@babylonjs/loaders": "5.6.0",
49
+ "@babylonjs/materials": "5.6.0",
49
50
  "eventemitter3": "^4.0.0",
50
51
  "gsap": "^3.5.1",
51
52
  "lodash-es": "^4.17.15"
52
53
  },
53
54
  "devDependencies": {
55
+ "@combeenation/prettier-config": "^0.0.1",
54
56
  "@types/lodash": "^4.14",
55
57
  "@types/lodash-es": "^4.17",
56
58
  "bundle-loader": "^0.5.6",
@@ -63,6 +65,7 @@
63
65
  "file-loader": "^4.2.0",
64
66
  "html-loader": "^0.5.5",
65
67
  "html-webpack-plugin": "^3.2.0",
68
+ "prettier": "^2.5.1",
66
69
  "replace": "1.2.0",
67
70
  "source-map-loader": "^0.2.4",
68
71
  "style-loader": "^1.0.0",
@@ -79,5 +82,6 @@
79
82
  "webpack-cli": "^3.3.11",
80
83
  "webpack-dev-server": "^3.11.2",
81
84
  "webpack-merge": "^4.2.2"
82
- }
85
+ },
86
+ "prettier": "@combeenation/prettier-config"
83
87
  }
@@ -2,11 +2,9 @@
2
2
  * An Interface defining the basic functionality of an animation.
3
3
  */
4
4
  interface AnimationInterface {
5
+ play(): Promise<AnimationInterface>;
5
6
 
6
- play(): Promise<AnimationInterface>;
7
+ pause(): AnimationInterface;
7
8
 
8
- pause(): AnimationInterface;
9
-
10
- kill(): AnimationInterface;
11
-
12
- }
9
+ kill(): AnimationInterface;
10
+ }
@@ -1,189 +1,181 @@
1
1
  export class DottedPath {
2
-
3
- static DELIMITER: string = '.';
4
-
5
- static SAFE_CHAR: string = '·';
6
-
7
- public parts: string[] = [];
8
-
9
- /**
10
- * Magic factory function that creates a DottedPath based on the argument type.
11
- */
12
- public static create( dottedPath?: DottedPathArgument ): DottedPath {
13
- if( dottedPath?.constructor === DottedPath ) {
14
- return (dottedPath as DottedPath).clone();
15
- }
16
- if( dottedPath?.constructor === String ) {
17
- return DottedPath.createFromPath( dottedPath as string );
18
- }
19
- if( dottedPath?.constructor === Array ) {
20
- return DottedPath.createFromParts( dottedPath as string[] );
21
- }
22
- return DottedPath.createEmpty();
23
- }
24
-
25
- /**
26
- * Creates a DottedPath from a string.
27
- * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
28
- * E.g. "part1.part2.'part.3'.part_4"
29
- */
30
- public static createFromPath( path: string ): DottedPath {
31
- if( path.length === 0 ) {
32
- return this.createEmpty();
33
- }
34
- if ( path.indexOf("'") > -1 || path.indexOf('"') > -1 ) {
35
- const bd = '[\'|"]';
36
- const search = new RegExp(`${bd}(.*)${bd}`, 'g');
37
- let matches = search.exec(path);
38
- while (matches !== null) {
39
- const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
40
- path = path.replace(_search, this.sanitizePart(matches[1]));
41
- matches = search.exec(path);
42
- }
43
- }
44
- return this.createFromParts( path.split( DottedPath.DELIMITER ) );
45
- }
46
-
47
- /**
48
- * Creates a DottedPath from a string list.
49
- */
50
- public static createFromParts( parts: string[] ): DottedPath {
51
- const dottedPath = new DottedPath();
52
- parts.forEach( part => dottedPath.addPart( part ) );
53
- return dottedPath;
54
- }
55
-
56
- /**
57
- * Creates an empty DottedPath.
58
- */
59
- public static createEmpty(): DottedPath {
60
- return new DottedPath();
61
- }
62
-
63
- /**
64
- * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
65
- * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
66
- * (i) Does not trim whitespace.
67
- */
68
- public static sanitizePart(part: string): string {
69
- return part.split( DottedPath.DELIMITER ).join( DottedPath.SAFE_CHAR );
70
- }
71
-
72
- /**
73
- * Constructor
74
- */
75
- private constructor() {
76
- }
77
-
78
- /**
79
- * The path.
80
- * (i) Does not return an empty dot for no path.
81
- */
82
- get path(): string {
83
- return this.parts.length > 0
84
- ? this.parts.join(DottedPath.DELIMITER)
85
- : '';
86
- }
87
-
88
- /**
89
- * The first part.
90
- */
91
- get firstPart(): string | null {
92
- if( this.parts.length > 0 ) {
93
- return this.parts[0];
94
- }
95
- return null;
96
- }
97
-
98
- /**
99
- * The last part.
100
- */
101
- get lastPart(): string | null {
102
- if( this.parts.length > 0 ) {
103
- return this.parts[this.parts.length - 1];
104
- }
105
- return null;
106
- }
107
-
108
- /**
109
- * Gets the tokens to each leaf of the DottedPath tree.
110
- * E.g. "part1.part2.part_3" will return an array like
111
- * ["part1", "part1.part2", "part1.part2.part_3"]
112
- */
113
- get leafTokens(): string[] {
114
- let parents: string[] = [];
115
- return this.parts.map( part => {
116
- parents.push( part );
117
- return DottedPath.create( parents ).path;
118
- } );
119
- }
120
-
121
- /**
122
- * Removes the first part and returns it.
123
- */
124
- public shiftPart(): string | undefined {
125
- return this.parts.shift();
126
- }
127
-
128
- /**
129
- * Adds part to the beginning of parts list.
130
- */
131
- public unshiftPart( part: string, duplicateCheck: boolean = false ): DottedPath {
132
- part = DottedPath.sanitizePart( part );
133
- if( duplicateCheck && this.firstPart === part ) {
134
- return this;
135
- }
136
- this.parts.unshift( part );
137
- return this;
138
- }
139
-
140
- /**
141
- * Adds part to the end of parts list.
142
- * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
143
- */
144
- public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
145
- if (
146
- part.length < 1
147
- || this.lastPart === DottedPath.DELIMITER
148
- ) {
149
- return this
150
- }
151
- part = DottedPath.sanitizePart(part);
152
- if (duplicateCheck && this.lastPart === part) {
153
- return this;
154
- }
155
- this.parts.push( part );
156
- return this;
157
- }
158
-
159
- /**
160
- * Adds multiple parts to the end of parts list.
161
- */
162
- public addParts( parts: string[], duplicateCheck: boolean = false ): DottedPath {
163
- parts.forEach( part => this.addPart( part, duplicateCheck ) );
164
- return this;
165
- }
166
-
167
- /**
168
- * Removes the last part and returns it.
169
- */
170
- public popPart(): string | undefined {
171
- return this.parts.pop();
172
- }
173
-
174
- public toString(): string {
175
- return this.path;
176
- }
177
-
178
- public valueOf(): string {
179
- return this.path;
180
- }
181
-
182
- /**
183
- * Clones the DottedPath.
184
- */
185
- public clone(): DottedPath {
186
- return DottedPath.createFromParts( this.parts );
187
- }
188
-
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
+ let 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
+ }
189
181
  }