| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278 |
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
1×
|
/**
* Helpers for creating a common 3d application.
* @namespace clay.application
*/
// TODO createCompositor
// TODO Dispose test. geoCache test.
// TODO Tonemapping exposure
// TODO fitModel.
// TODO Particle ?
import Renderer from './Renderer';
import Scene from './Scene';
import Timeline from './Timeline';
import CubeGeo from './geometry/Cube';
import SphereGeo from './geometry/Sphere';
import PlaneGeo from './geometry/Plane';
import ParametricSurfaceGeo from './geometry/ParametricSurface';
import Texture2D from './Texture2D';
import TextureCube from './TextureCube';
import Texture from './Texture';
import shaderLibrary from './shader/library';
import Mesh from './Mesh';
import Material from './Material';
import PerspectiveCamera from './camera/Perspective';
import OrthographicCamera from './camera/Orthographic';
import Vector3 from './math/Vector3';
import GLTFLoader from './loader/GLTF';
import Node from './Node';
import DirectionalLight from './light/Directional';
import PointLight from './light/Point';
import SpotLight from './light/Spot';
import AmbientLight from './light/Ambient';
import AmbientCubemapLight from './light/AmbientCubemap';
import AmbientSHLight from './light/AmbientSH';
import ShadowMapPass from './prePass/ShadowMap';
import RayPicking from './picking/RayPicking';
import LRUCache from './core/LRU';
import util from './core/util';
import shUtil from './util/sh';
import textureUtil from './util/texture';
import colorUtil from './core/color';
var parseColor = colorUtil.parseToFloat;
import './shader/builtin';
import Shader from './Shader';
var EVE_NAMES = ['click', 'dblclick', 'mouseover', 'mouseout', 'mousemove',
'touchstart', 'touchend', 'touchmove',
'mousewheel', 'DOMMouseScroll'
];
/**
* @typedef {string|HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} ImageLike
*/
/**
* @typedef {string|Array.<number>} Color
*/
/**
* @typedef {HTMLElement|string} DomQuery
*/
/**
* @typedef {Object} App3DNamespace
* @property {Function} init Initialization callback that will be called when initing app.
* You can return a promise in init to start the loop asynchronously when the promise is resolved.
* @property {Function} loop Loop callback that will be called each frame.
* @property {Function} beforeRender
* @property {Function} afterRender
* @property {number} [width] Container width.
* @property {number} [height] Container height.
* @property {number} [devicePixelRatio]
* @property {Object} [graphic] Graphic configuration including shadow, color space.
* @property {boolean} [graphic.shadow=false] If enable shadow
* @property {boolean} [graphic.linear=false] If use linear color space
* @property {boolean} [graphic.tonemapping=false] If enable ACES tone mapping.
* @property {boolean} [event=false] If enable mouse/touch event. It will slow down the system if geometries are complex.
*/
/**
* Using App3D is a much more convenient way to create and manage your 3D application.
*
* It provides the abilities to:
*
* + Manage application loop and rendering.
* + Collect GPU resource automatically without memory leak concern.
* + Mouse event management.
* + Create scene objects, materials, textures with simpler code.
* + Load models with one line of code.
* + Promised interfaces.
*
* Here is a basic example to create a rotating cube.
*
```js
var app = clay.application.create('#viewport', {
init: function (app) {
// Create a perspective camera.
// First parameter is the camera position. Which is in front of the cube.
// Second parameter is the camera lookAt target. Which is the origin of the world, and where the cube puts.
this._camera = app.createCamera([0, 2, 5], [0, 0, 0]);
// Create a sample cube
this._cube = app.createCube();
// Create a directional light. The direction is from top right to left bottom, away from camera.
this._mainLight = app.createDirectionalLight([-1, -1, -1]);
},
loop: function (app) {
// Simply rotating the cube every frame.
this._cube.rotation.rotateY(app.frameTime / 1000);
}
});
```
* @constructor
* @alias clay.application.App3D
* @param {DomQuery} dom Container dom element or a selector string that can be used in `querySelector`
* @param {App3DNamespace} appNS Options and namespace used in creating app3D
*/
function App3D(dom, appNS) {
appNS = appNS || {};
appNS.graphic = appNS.graphic || {};
if (typeof dom === 'string') {
dom = document.querySelector(dom);
}
if (!dom) { throw new Error('Invalid dom'); }
var isDomCanvas = dom.nodeName.toUpperCase() === 'CANVAS';
var rendererOpts = {};
isDomCanvas && (rendererOpts.canvas = dom);
appNS.devicePixelRatio && (rendererOpts.devicePixelRatio = appNS.devicePixelRatio);
var gRenderer = new Renderer(rendererOpts);
var gWidth = appNS.width || dom.clientWidth;
var gHeight = appNS.height || dom.clientHeight;
var gScene = new Scene();
var gTimeline = new Timeline();
var gShadowPass = appNS.graphic.shadow && new ShadowMapPass();
var gRayPicking = appNS.event && new RayPicking({
scene: gScene,
renderer: gRenderer
});
!isDomCanvas && dom.appendChild(gRenderer.canvas);
gRenderer.resize(gWidth, gHeight);
var gFrameTime = 0;
var gElapsedTime = 0;
gTimeline.start();
Object.defineProperties(this, {
/**
* Container dom element
* @name clay.application.App3D#container
* @type {HTMLElement}
*/
container: { get: function () { return dom; } },
/**
* @name clay.application.App3D#renderer
* @type {clay.Renderer}
*/
renderer: { get: function () { return gRenderer; }},
/**
* @name clay.application.App3D#scene
* @type {clay.Renderer}
*/
scene: { get: function () { return gScene; }},
/**
* @name clay.application.App3D#timeline
* @type {clay.Renderer}
*/
timeline: { get: function () { return gTimeline; }},
/**
* Time elapsed since last frame. Can be used in loop to calculate the movement.
* @name clay.application.App3D#frameTime
* @type {number}
*/
frameTime: { get: function () { return gFrameTime; }},
/**
* Time elapsed since application created.
* @name clay.application.App3D#elapsedTime
* @type {number}
*/
elapsedTime: { get: function () { return gElapsedTime; }}
});
/**
* Resize the application. Will use the container clientWidth/clientHeight if width/height in parameters are not given.
* @function
* @memberOf {clay.application.App3D}
* @param {number} [width]
* @param {number} [height]
*/
this.resize = function (width, height) {
gWidth = width || appNS.width || dom.clientWidth;
gHeight = height || dom.height || dom.clientHeight;
gRenderer.resize(gWidth, gHeight);
};
/**
* Dispose the application
* @function
*/
this.dispose = function () {
this._disposed = true;
if (appNS.dispose) {
appNS.dispose(this);
}
gTimeline.stop();
gRenderer.disposeScene(gScene);
gShadowPass && gShadowPass.dispose(gRenderer);
dom.innerHTML = '';
EVE_NAMES.forEach(function (eveType) {
this[makeHandlerName(eveType)] && dom.removeEventListener(makeHandlerName(eveType));
});
};
gRayPicking && this._initMouseEvents(gRayPicking);
this._geoCache = new LRUCache(20);
this._texCache = new LRUCache(20);
// Do init the application.
var initPromise = Promise.resolve(appNS.init && appNS.init(this));
// Use the inited camera.
gRayPicking && (gRayPicking.camera = gScene.getMainCamera());
var gTexturesList = {};
var gGeometriesList = {};
if (!appNS.loop) {
console.warn('Miss loop method.');
}
var self = this;
initPromise.then(function () {
appNS.loop && gTimeline.on('frame', function (frameTime) {
gFrameTime = frameTime;
gElapsedTime += frameTime;
appNS.loop(self);
gScene.update();
var skyboxList = [];
gScene.skybox && skyboxList.push(gScene.skybox);
gScene.skydome && skyboxList.push(gScene.skydome);
self._updateGraphicOptions(appNS.graphic, skyboxList, true);
gRayPicking && (gRayPicking.camera = gScene.getMainCamera());
// Render shadow pass
gShadowPass && gShadowPass.render(gRenderer, gScene, null, true);
appNS.beforeRender && appNS.beforeRender(self);
self._doRender(gRenderer, gScene, true);
appNS.afterRender && appNS.afterRender(self);
// Mark all resources unused;
markUnused(gTexturesList);
markUnused(gGeometriesList);
// Collect resources used in this frame.
var newTexturesList = [];
var newGeometriesList = [];
collectResources(gScene, newTexturesList, newGeometriesList);
// Dispose those unsed resources.
checkAndDispose(gRenderer, gTexturesList);
checkAndDispose(gRenderer, gGeometriesList);
gTexturesList = newTexturesList;
gGeometriesList = newGeometriesList;
});
});
gScene.on('beforerender', function (renderer, scene, camera, renderList) {
this._updateGraphicOptions(appNS.graphic, renderList.opaque, false);
this._updateGraphicOptions(appNS.graphic, renderList.transparent, false);
}, this);
}
function isImageLikeElement(val) {
return val instanceof Image
|| val instanceof HTMLCanvasElement
|| val instanceof HTMLVideoElement;
}
function getKeyFromImageLike(val) {
typeof val === 'string'
? val : (val.__key__ || (val.__key__ = util.genGUID()));
}
function makeHandlerName(eveType) {
return '_' + eveType + 'Handler';
}
function packageEvent(eventType, pickResult, offsetX, offsetY, wheelDelta) {
var event = util.clone(pickResult);
event.type = eventType;
event.offsetX = offsetX;
event.offsetY = offsetY;
if (wheelDelta !== null) {
event.wheelDelta = wheelDelta;
}
return event;
}
function bubblingEvent(target, event) {
while (target && !event.cancelBubble) {
target.trigger(event.type, event);
target = target.getParent();
}
}
App3D.prototype._initMouseEvents = function (rayPicking) {
var dom = this.container;
var oldTarget = null;
EVE_NAMES.forEach(function (_eveType) {
dom.addEventListener(_eveType, this[makeHandlerName(_eveType)] = function (e) {
if (!rayPicking.camera) { // Not have camera yet.
return;
}
e.preventDefault();
var box = dom.getBoundingClientRect();
var offsetX, offsetY;
var eveType = _eveType;
if (eveType.indexOf('touch') >= 0) {
var touch = eveType !== 'touchend'
? e.targetTouches[0]
: e.changedTouches[0];
if (eveType === 'touchstart') {
eveType = 'mousedown';
}
else if (eveType === 'touchend') {
eveType = 'mouseup';
}
else if (eveType === 'touchmove') {
eveType = 'mousemove';
}
offsetX = touch.clientX - box.left;
offsetY = touch.clientY - box.top;
}
else {
offsetX = e.clientX - box.left;
offsetY = e.clientY - box.top;
}
var pickResult = rayPicking.pick(offsetX, offsetY);
var delta;
if (eveType === 'DOMMouseScroll' || eveType === 'mousewheel') {
delta = (e.wheelDelta) ? e.wheelDelta / 120 : -(e.detail || 0) / 3;
}
if (pickResult) {
// Just ignore silent element.
if (pickResult.target.silent) {
return;
}
if (eveType === 'mousemove') {
// PENDING touchdown should trigger mouseover event ?
var targetChanged = pickResult.target !== oldTarget;
if (targetChanged) {
oldTarget && bubblingEvent(oldTarget, packageEvent('mouseout', {
target: oldTarget
}, offsetX, offsetY));
}
bubblingEvent(pickResult.target, packageEvent('mousemove', pickResult, offsetX, offsetY));
if (targetChanged) {
bubblingEvent(pickResult.target, packageEvent('mouseover', pickResult, offsetX, offsetY));
}
}
else {
bubblingEvent(pickResult.target, packageEvent(eveType, pickResult, offsetX, offsetY, delta));
}
oldTarget = pickResult.target;
}
else if (oldTarget) {
bubblingEvent(oldTarget, packageEvent('mouseout', {
target: oldTarget
}, offsetX, offsetY));
oldTarget = null;
}
});
}, this);
};
App3D.prototype._updateGraphicOptions = function (graphicOpts, list, isSkybox) {
var enableTonemapping = !!graphicOpts.tonemapping;
var isLinearSpace = !!graphicOpts.linear;
var prevMaterial;
for (var i = 0; i < list.length; i++) {
var mat = list[i].material;
if (mat === prevMaterial) {
continue;
}
enableTonemapping ? mat.define('fragment', 'TONEMAPPING') : mat.undefine('fragment', 'TONEMAPPING');
if (isLinearSpace) {
var decodeSRGB = true;
if (isSkybox && mat.get('environmentMap') && !mat.get('environmentMap').sRGB) {
decodeSRGB = false;
}
decodeSRGB && mat.define('fragment', 'SRGB_DECODE');
mat.define('fragment', 'SRGB_ENCODE');
}
else {
mat.undefine('fragment', 'SRGB_DECODE');
mat.undefine('fragment', 'SRGB_ENCODE');
}
prevMaterial = mat;
}
};
App3D.prototype._doRender = function (renderer, scene) {
var camera = scene.getMainCamera();
camera.aspect = renderer.getViewportAspect();
renderer.render(scene, camera, true);
};
function markUnused(resourceList) {
for (var i = 0; i < resourceList.length; i++) {
resourceList[i].__used = 0;
}
}
function checkAndDispose(renderer, resourceList) {
for (var i = 0; i < resourceList.length; i++) {
if (!resourceList[i].__used) {
resourceList[i].dispose(renderer);
}
}
}
function updateUsed(resource, list) {
resource.__used = resource.__used || 0;
resource.__used++;
if (resource.__used === 1) {
// Don't push to the list twice.
list.push(resource);
}
}
function collectResources(scene, textureResourceList, geometryResourceList) {
var prevMaterial;
var prevGeometry;
scene.traverse(function (renderable) {
if (renderable.isRenderable()) {
var geometry = renderable.geometry;
var material = renderable.material;
// TODO optimize!!
if (material !== prevMaterial) {
var textureUniforms = material.getTextureUniforms();
for (var u = 0; u < textureUniforms.length; u++) {
var uniformName = textureUniforms[u];
var val = material.uniforms[uniformName].value;
var uniformType = material.uniforms[uniformName].type;
if (!val) {
continue;
}
if (uniformType === 't') {
updateUsed(val, textureResourceList);
}
else if (uniformType === 'tv') {
for (var k = 0; k < val.length; k++) {
if (val[k]) {
updateUsed(val[k], textureResourceList);
}
}
}
}
}
if (geometry !== prevGeometry) {
updateUsed(geometry, geometryResourceList);
}
prevMaterial = material;
prevGeometry = geometry;
}
});
for (var k = 0; k < scene.lights.length; k++) {
// Track AmbientCubemap
if (scene.lights[k].cubemap) {
updateUsed(scene.lights[k].cubemap, textureResourceList);
}
}
}
/**
* Load a texture from image or string.
* @param {ImageLike} img
* @param {Object} [opts] Texture options.
* @param {boolean} [opts.flipY=true] If flipY. See {@link clay.Texture.flipY}
* @param {boolean} [opts.convertToPOT=false] Force convert None Power of Two texture to Power of two so it can be tiled.
* @param {number} [opts.anisotropic] Anisotropic filtering. See {@link clay.Texture.anisotropic}
* @param {number} [opts.wrapS=clay.Texture.REPEAT] See {@link clay.Texture.wrapS}
* @param {number} [opts.wrapT=clay.Texture.REPEAT] See {@link clay.Texture.wrapT}
* @param {number} [opts.minFilter=clay.Texture.LINEAR_MIPMAP_LINEAR] See {@link clay.Texture.minFilter}
* @param {number} [opts.magFilter=clay.Texture.LINEAR] See {@link clay.Texture.magFilter}
* @param {number} [opts.exposure] Only be used when source is a HDR image.
* @param {boolean} [useCache] If use cache.
* @return {Promise}
* @example
* app.loadTexture('diffuseMap.jpg')
* .then(function (texture) {
* material.set('diffuseMap', texture);
* });
*/
App3D.prototype.loadTexture = function (urlOrImg, opts, useCache) {
var self = this;
var key = getKeyFromImageLike(urlOrImg);
if (useCache) {
if (this._texCache.get(key)) {
return this._texCache.get(key);
}
}
// TODO Promise ?
var promise = new Promise(function (resolve, reject) {
var texture = self.loadTextureSync(urlOrImg, opts);
if (!texture.isRenderable()) {
texture.success(function () {
if (self._disposed) {
return;
}
resolve(texture);
});
texture.error(function () {
if (self._disposed) {
return;
}
reject();
});
}
else {
resolve(texture);
}
});
if (useCache) {
this._texCache.put(key, promise);
}
return promise;
};
function nearestPowerOfTwo(val) {
return Math.pow(2, Math.round(Math.log(val) / Math.LN2));
}
function convertTextureToPowerOfTwo(texture) {
if ((texture.wrapS === Texture.REPEAT || texture.wrapT === Texture.REPEAT)
&& texture.image) {
// var canvas = document.createElement('canvas');
var width = nearestPowerOfTwo(texture.width);
var height = nearestPowerOfTwo(texture.height);
if (width !== texture.width || height !== texture.height) {
var canvas = document.createElement('canvas');
canvas.width = width;
canvas.height = height;
var ctx = canvas.getContext('2d');
ctx.drawImage(texture.image, 0, 0, width, height);
canvas.srcImage = texture.image;
texture.image = canvas;
texture.dirty();
}
}
}
/**
* Create a texture from image or string synchronously. Texture can be use directly and don't have to wait for it's loaded.
* @param {ImageLike} img
* @param {Object} [opts] Texture options.
* @param {boolean} [opts.flipY=true] If flipY. See {@link clay.Texture.flipY}
* @param {boolean} [opts.convertToPOT=false] Force convert None Power of Two texture to Power of two so it can be tiled.
* @param {number} [opts.anisotropic] Anisotropic filtering. See {@link clay.Texture.anisotropic}
* @param {number} [opts.wrapS=clay.Texture.REPEAT] See {@link clay.Texture.wrapS}
* @param {number} [opts.wrapT=clay.Texture.REPEAT] See {@link clay.Texture.wrapT}
* @param {number} [opts.minFilter=clay.Texture.LINEAR_MIPMAP_LINEAR] See {@link clay.Texture.minFilter}
* @param {number} [opts.magFilter=clay.Texture.LINEAR] See {@link clay.Texture.magFilter}
* @param {number} [opts.exposure] Only be used when source is a HDR image.
* @return {clay.Texture2D}
* @example
* var texture = app.loadTexture('diffuseMap.jpg', {
* anisotropic: 8,
* flipY: false
* });
* material.set('diffuseMap', texture);
*/
App3D.prototype.loadTextureSync = function (urlOrImg, opts) {
var texture = new Texture2D(opts);
if (typeof urlOrImg === 'string') {
if (urlOrImg.match(/.hdr$|^data:application\/octet-stream/)) {
texture = textureUtil.loadTexture(urlOrImg, {
exposure: opts && opts.exposure,
fileType: 'hdr'
}, function () {
texture.dirty();
texture.trigger('success');
});
for (var key in opts) {
texture[key] = opts[key];
}
}
else {
texture.load(urlOrImg);
if (opts && opts.convertToPOT) {
texture.success(function () {
convertTextureToPowerOfTwo(texture);
});
}
}
}
else if (isImageLikeElement(urlOrImg)) {
texture.image = urlOrImg;
texture.dynamic = urlOrImg instanceof HTMLVideoElement;
}
return texture;
};
/**
* Create a texture from image or string synchronously. Texture can be use directly and don't have to wait for it's loaded.
* @param {ImageLike} img
* @param {Object} [opts] Texture options.
* @param {boolean} [opts.flipY=false] If flipY. See {@link clay.Texture.flipY}
* @return {Promise}
* @example
* app.loadTextureCube({
* px: 'skybox/px.jpg', py: 'skybox/py.jpg', pz: 'skybox/pz.jpg',
* nx: 'skybox/nx.jpg', ny: 'skybox/ny.jpg', nz: 'skybox/nz.jpg'
* }).then(function (texture) {
* skybox.setEnvironmentMap(texture);
* })
*/
App3D.prototype.loadTextureCube = function (imgList, opts) {
var textureCube = this.loadTextureCubeSync(imgList, opts);
return new Promise(function (resolve, reject) {
if (textureCube.isRenderable()) {
resolve(textureCube);
}
else {
textureCube.success(function () {
resolve(textureCube);
}).error(function () {
reject();
});
}
});
};
/**
* Create a texture from image or string synchronously. Texture can be use directly and don't have to wait for it's loaded.
* @param {ImageLike} img
* @param {Object} [opts] Texture options.
* @param {boolean} [opts.flipY=false] If flipY. See {@link clay.Texture.flipY}
* @return {clay.TextureCube}
* @example
* var texture = app.loadTextureCubeSync({
* px: 'skybox/px.jpg', py: 'skybox/py.jpg', pz: 'skybox/pz.jpg',
* nx: 'skybox/nx.jpg', ny: 'skybox/ny.jpg', nz: 'skybox/nz.jpg'
* });
* skybox.setEnvironmentMap(texture);
*/
App3D.prototype.loadTextureCubeSync = function (imgList, opts) {
opts = opts || {};
opts.flipY = opts.flipY || false;
var textureCube = new TextureCube(opts);
if (!imgList || !imgList.px || !imgList.nx || !imgList.py || !imgList.ny || !imgList.pz || !imgList.nz) {
throw new Error('Invalid cubemap format. Should be an object including px,nx,py,ny,pz,nz');
}
if (typeof imgList.px === 'string') {
textureCube.load(imgList);
}
else {
textureCube.image = util.clone(imgList);
}
return textureCube;
};
/**
* Create a material.
* @param {Object} materialConfig. materialConfig contains `shader`, `transparent` and uniforms that used in corresponding uniforms.
* Uniforms can be `color`, `alpha` `diffuseMap` etc.
* @param {string|clay.Shader} [shader='clay.standardMR'] Default to be standard shader with metalness and roughness workflow.
* @param {boolean} [transparent=false] If material is transparent.
* @param {boolean} [convertTextureToPOT=false] Force convert None Power of Two texture to Power of two so it can be tiled.
* @return {clay.Material}
*/
App3D.prototype.createMaterial = function (matConfig) {
matConfig = matConfig || {};
matConfig.shader = matConfig.shader || 'clay.standardMR';
var shader = matConfig.shader instanceof Shader ? matConfig.shader : shaderLibrary.get(matConfig.shader);
var material = new Material({
shader: shader
});
function makeTextureSetter(key) {
return function (texture) {
material.setUniform(key, texture);
};
}
for (var key in matConfig) {
if (material.uniforms[key]) {
var val = matConfig[key];
if ((material.uniforms[key].type === 't' || isImageLikeElement(val))
&& !(val instanceof Texture)
) {
// Try to load a texture.
this.loadTexture(val, {
convertToPOT: matConfig.convertTextureToPOT
}).then(makeTextureSetter(key));
}
else {
material.setUniform(key, val);
}
}
}
if (matConfig.transparent) {
matConfig.depthMask = false;
matConfig.transparent = true;
}
return material;
};
/**
* Create a cube mesh and add it to the scene or the given parent node.
* @function
* @param {Object|clay.Material} [material]
* @param {clay.Node} [parentNode] Parent node to append. Default to be scene.
* @param {Array.<number>|number} [subdivision=1] Subdivision of cube.
* Can be a number to represent both width, height and depth dimensions. Or an array to represent them respectively.
* @return {clay.Mesh}
* @example
* // Create a white cube.
* app.createCube()
*/
App3D.prototype.createCube = function (material, parentNode, subdiv) {
if (subdiv == null) {
subdiv = 1;
}
if (typeof subdiv === 'number') {
subdiv = [subdiv, subdiv, subdiv];
}
var geoKey = 'cube-' + subdiv.join('-');
var cube = this._geoCache.get(geoKey);
if (!cube) {
cube = new CubeGeo({
widthSegments: subdiv[0],
heightSegments: subdiv[1],
depthSegments: subdiv[2]
});
cube.generateTangents();
this._geoCache.put(geoKey, cube);
}
return this.createMesh(cube, material, parentNode);
};
/**
* Create a cube mesh that camera is inside the cube.
* @function
* @param {Object|clay.Material} [material]
* @param {clay.Node} [parentNode] Parent node to append. Default to be scene.
* @param {Array.<number>|number} [subdivision=1] Subdivision of cube.
* Can be a number to represent both width, height and depth dimensions. Or an array to represent them respectively.
* @return {clay.Mesh}
* @example
* // Create a white cube inside.
* app.createCubeInside()
*/
App3D.prototype.createCubeInside = function (material, parentNode, subdiv) {
if (subdiv == null) {
subdiv = 1;
}
if (typeof subdiv === 'number') {
subdiv = [subdiv, subdiv, subdiv];
}
var geoKey = 'cubeInside-' + subdiv.join('-');
var cube = this._geoCache.get(geoKey);
if (!cube) {
cube = new CubeGeo({
inside: true,
widthSegments: subdiv[0],
heightSegments: subdiv[1],
depthSegments: subdiv[2]
});
cube.generateTangents();
this._geoCache.put(geoKey, cube);
}
return this.createMesh(cube, material, parentNode);
};
/**
* Create a sphere mesh and add it to the scene or the given parent node.
* @function
* @param {Object|clay.Material} [material]
* @param {clay.Node} [parentNode] Parent node to append. Default to be scene.
* @param {number} [subdivision=20] Subdivision of sphere.
* @return {clay.Mesh}
* @example
* // Create a semi-transparent sphere.
* app.createSphere({
* color: [0, 0, 1],
* transparent: true,
* alpha: 0.5
* })
*/
App3D.prototype.createSphere = function (material, parentNode, subdivision) {
if (subdivision == null) {
subdivision = 20;
}
var geoKey = 'sphere-' + subdivision;
var sphere = this._geoCache.get(geoKey);
if (!sphere) {
sphere = new SphereGeo({
widthSegments: subdivision * 2,
heightSegments: subdivision
});
sphere.generateTangents();
this._geoCache.put(geoKey, sphere);
}
return this.createMesh(sphere, material, parentNode);
};
/**
* Create a plane mesh and add it to the scene or the given parent node.
* @function
* @param {Object|clay.Material} [material]
* @param {clay.Node} [parentNode] Parent node to append. Default to be scene.
* @param {Array.<number>|number} [subdivision=1] Subdivision of plane.
* Can be a number to represent both width and height dimensions. Or an array to represent them respectively.
* @return {clay.Mesh}
* @example
* // Create a red color plane.
* app.createPlane({
* color: [1, 0, 0]
* })
*/
App3D.prototype.createPlane = function (material, parentNode, subdiv) {
if (subdiv == null) {
subdiv = 1;
}
if (typeof subdiv === 'number') {
subdiv = [subdiv, subdiv];
}
var geoKey = 'plane-' + subdiv.join('-');
var planeGeo = this._geoCache.get(geoKey);
if (!planeGeo) {
planeGeo = new PlaneGeo({
widthSegments: subdiv[0],
heightSegments: subdiv[1]
});
planeGeo.generateTangents();
this._geoCache.put(geoKey, planeGeo);
}
return this.createMesh(planeGeo, material, parentNode);
};
/**
* Create mesh with parametric surface function
* @param {Object|clay.Material} [material]
* @param {clay.Node} [parentNode] Parent node to append. Default to be scene.
* @param {Object} generator
* @param {Function} generator.x
* @param {Function} generator.y
* @param {Function} generator.z
* @param {Array} [generator.u=[0, 1, 0.05]]
* @param {Array} [generator.v=[0, 1, 0.05]]
* @return {clay.Mesh}
*/
App3D.prototype.createParametricSurface = function (material, parentNode, generator) {
var geo = new ParametricSurfaceGeo({
generator: generator
});
geo.generateTangents();
return this.createMesh(geo, material, parentNode);
};
/**
* Create a general mesh with given geometry instance and material config.
* @param {clay.Geometry} geometry
* @return {clay.Mesh}
*/
App3D.prototype.createMesh = function (geometry, mat, parentNode) {
var mesh = new Mesh({
geometry: geometry,
material: mat instanceof Material ? mat : this.createMaterial(mat)
});
parentNode = parentNode || this.scene;
parentNode.add(mesh);
return mesh;
};
/**
* Create an empty node
* @param {clay.Node} parentNode
* @return {clay.Node}
*/
App3D.prototype.createNode = function (parentNode) {
var node = new Node();
parentNode = parentNode || this.scene;
parentNode.add(node);
return node;
};
/**
* Create a perspective or orthographic camera and add it to the scene.
* @param {Array.<number>|clay.Vector3} position
* @param {Array.<number>|clay.Vector3} target
* @param {string} [type="perspective"] Can be 'perspective' or 'orthographic'(in short 'ortho')
* @param {Array.<number>|clay.Vector3} [extent] Extent is available only if type is orthographic.
* @return {clay.camera.Perspective|clay.camera.Orthographic}
*/
App3D.prototype.createCamera = function (position, target, type, extent) {
var CameraCtor;
var isOrtho = false;
if (type === 'ortho' || type === 'orthographic') {
isOrtho = true;
CameraCtor = OrthographicCamera;
}
else {
if (type && type !== 'perspective') {
console.error('Unkown camera type ' + type + '. Use default perspective camera');
}
CameraCtor = PerspectiveCamera;
}
var camera = new CameraCtor();
if (position instanceof Vector3) {
camera.position.copy(position);
}
else if (position instanceof Array) {
camera.position.setArray(position);
}
if (target instanceof Array) {
target = new Vector3(target[0], target[1], target[2]);
}
if (target instanceof Vector3) {
camera.lookAt(target);
}
if (extent && isOrtho) {
extent = extent.array || extent;
camera.left = -extent[0] / 2;
camera.right = extent[0] / 2;
camera.top = extent[1] / 2;
camera.bottom = -extent[1] / 2;
camera.near = 0;
camera.far = extent[2];
}
this.scene.add(camera);
return camera;
};
/**
* Create a directional light and add it to the scene.
* @param {Array.<number>|clay.Vector3} dir A Vector3 or array to represent the direction.
* @param {Color} [color='#fff'] Color of directional light, default to be white.
* @param {number} [intensity] Intensity of directional light, default to be 1.
*
* @example
* app.createDirectionalLight([-1, -1, -1], '#fff', 2);
*/
App3D.prototype.createDirectionalLight = function (dir, color, intensity) {
var light = new DirectionalLight();
if (dir instanceof Vector3) {
dir = dir.array;
}
light.position.setArray(dir).negate();
light.lookAt(Vector3.ZERO);
if (typeof color === 'string') {
color = parseColor(color);
}
color != null && (light.color = color);
intensity != null && (light.intensity = intensity);
this.scene.add(light);
return light;
};
/**
* Create a spot light and add it to the scene.
* @param {Array.<number>|clay.Vector3} position Position of the spot light.
* @param {Array.<number>|clay.Vector3} [target] Target position where spot light points to.
* @param {number} [range=20] Falloff range of spot light. Default to be 20.
* @param {Color} [color='#fff'] Color of spot light, default to be white.
* @param {number} [intensity=1] Intensity of spot light, default to be 1.
* @param {number} [umbraAngle=30] Umbra angle of spot light. Default to be 30 degree from the middle line.
* @param {number} [penumbraAngle=45] Penumbra angle of spot light. Default to be 45 degree from the middle line.
*
* @example
* app.createSpotLight([5, 5, 5], [0, 0, 0], 20, #900);
*/
App3D.prototype.createSpotLight = function (position, target, range, color, intensity, umbraAngle, penumbraAngle) {
var light = new SpotLight();
light.position.setArray(position instanceof Vector3 ? position.array : position);
if (target instanceof Array) {
target = new Vector3(target[0], target[1], target[2]);
}
if (target instanceof Vector3) {
light.lookAt(target);
}
if (typeof color === 'string') {
color = parseColor(color);
}
range != null && (light.range = range);
color != null && (light.color = color);
intensity != null && (light.intensity = intensity);
umbraAngle != null && (light.umbraAngle = umbraAngle);
penumbraAngle != null && (light.penumbraAngle = penumbraAngle);
this.scene.add(light);
return light;
};
/**
* Create a point light.
* @param {Array.<number>|clay.Vector3} position Position of point light..
* @param {number} [range=100] Falloff range of point light.
* @param {Color} [color='#fff'] Color of point light.
* @param {number} [intensity=1] Intensity of point light.
*/
App3D.prototype.createPointLight = function (position, range, color, intensity) {
var light = new PointLight();
light.position.setArray(position instanceof Vector3 ? position.array : position);
if (typeof color === 'string') {
color = parseColor(color);
}
range != null && (light.range = range);
color != null && (light.color = color);
intensity != null && (light.intensity = intensity);
this.scene.add(light);
return light;
};
/**
* Create a ambient light.
* @param {Color} [color='#fff'] Color of ambient light.
* @param {number} [intensity=1] Intensity of ambient light.
*/
App3D.prototype.createAmbientLight = function (color, intensity) {
var light = new AmbientLight();
if (typeof color === 'string') {
color = parseColor(color);
}
color != null && (light.color = color);
intensity != null && (light.intensity = intensity);
this.scene.add(light);
return light;
};
/**
* Create an cubemap ambient light and an spherical harmonic ambient light
* for specular and diffuse lighting in PBR rendering
* @param {ImageLike|TextureCube} [envImage] Panorama environment image, HDR format is better. Or a pre loaded texture cube
* @param {number} [specularIntenstity=0.7] Intensity of specular light.
* @param {number} [diffuseIntenstity=0.7] Intensity of diffuse light.
* @param {number} [exposure=1] Exposure of HDR image. Only if image in first paramter is HDR.
* @param {number} [prefilteredCubemapSize=32] The size of prefilerted cubemap. Larger value will take more time to do expensive prefiltering.
*/
App3D.prototype.createAmbientCubemapLight = function (envImage, specIntensity, diffIntensity, exposure, prefilteredCubemapSize) {
var self = this;
if (exposure == null) {
exposure = 1;
}
if (prefilteredCubemapSize == null) {
prefilteredCubemapSize = 32;
}
var scene = this.scene;
var loadPromise;
if (envImage.textureType === 'textureCube') {
loadPromise = envImage.isRenderable()
? Promise.resolve(envImage)
: new Promise(function (resolve, reject) {
envImage.success(function () {
resolve(envImage);
});
});
}
else {
loadPromise = this.loadTexture(envImage, {
exposure: exposure
});
}
return loadPromise.then(function (envTexture) {
var specLight = new AmbientCubemapLight({
intensity: specIntensity != null ? specIntensity : 0.7
});
specLight.cubemap = envTexture;
envTexture.flipY = false;
// TODO Cache prefilter ?
specLight.prefilter(self.renderer, 32);
var diffLight = new AmbientSHLight({
intensity: diffIntensity != null ? diffIntensity : 0.7,
coefficients: shUtil.projectEnvironmentMap(
self.renderer, specLight.cubemap, {
lod: 1
}
)
});
scene.add(specLight);
scene.add(diffLight);
return {
specular: specLight,
diffuse: diffLight,
// Original environment map
environmentMap: envTexture
};
});
};
/**
* Load a [glTF](https://github.com/KhronosGroup/glTF) format model.
* You can convert FBX/DAE/OBJ format models to [glTF](https://github.com/KhronosGroup/glTF) with [fbx2gltf](https://github.com/pissang/claygl#fbx-to-gltf20-converter) python script,
* or simply using the [Clay Viewer](https://github.com/pissang/clay-viewer) client application.
* @param {string} url
* @param {Object} opts
* @param {string|clay.Shader} [opts.shader='clay.standard'] 'basic'|'lambert'|'standard'.
* @param {boolean} [opts.waitTextureLoaded=false] If add to scene util textures are all loaded.
* @param {boolean} [opts.autoPlayAnimation=true] If autoplay the animation of model.
* @param {boolean} [opts.upAxis='y'] Change model to y up if upAxis is 'z'
* @param {boolean} [opts.textureFlipY=false]
* @param {string} [opts.textureRootPath] Root path of texture. Default to be relative with glTF file.
* @param {clay.Node} [parentNode] Parent node that model will be mounted. Default to be scene
* @return {Promise}
*/
App3D.prototype.loadModel = function (url, opts, parentNode) {
if (typeof url !== 'string') {
throw new Error('Invalid URL.');
}
opts = opts || {};
if (opts.autoPlayAnimation == null) {
opts.autoPlayAnimation = true;
}
var shader = opts.shader || 'clay.standard';
var loaderOpts = {
rootNode: new Node(),
shader: shader,
textureRootPath: opts.textureRootPath,
crossOrigin: 'Anonymous',
textureFlipY: opts.textureFlipY
};
if (opts.upAxis && opts.upAxis.toLowerCase() === 'z') {
loaderOpts.rootNode.rotation.identity().rotateX(-Math.PI / 2);
}
var loader = new GLTFLoader(loaderOpts);
parentNode = parentNode || this.scene;
var timeline = this.timeline;
var self = this;
return new Promise(function (resolve, reject) {
function afterLoad(result) {
if (self._disposed) {
return;
}
parentNode.add(result.rootNode);
if (opts.autoPlayAnimation) {
result.clips.forEach(function (clip) {
timeline.addClip(clip);
});
}
resolve(result);
}
loader.success(function (result) {
if (self._disposed) {
return;
}
if (!opts.waitTextureLoaded) {
afterLoad(result);
}
else {
Promise.all(result.textures.map(function (texture) {
if (texture.isRenderable()) {
return Promise.resolve(texture);
}
return new Promise(function (resolve) {
texture.success(resolve);
texture.error(resolve);
});
})).then(function () {
afterLoad(result);
}).catch(function () {
afterLoad(result);
});
}
});
loader.error(function () {
reject();
});
loader.load(url);
});
};
// TODO cloneModel
/**
* Similar to `app.scene.cloneNode`, except it will mount the cloned node to the scene automatically.
* See more in {@link clay.Scene#cloneNode}
*
* @param {clay.Node} node
* @param {clay.Node} [parentNode] Parent node that new cloned node will be mounted.
* Default to have same parent with source node.
* @return {clay.Node}
*/
App3D.prototype.cloneNode = function (node, parentNode) {
parentNode = parentNode || node.getParent();
var newNode = this.scene.cloneNode(node, parentNode);
if (parentNode) {
parentNode.add(newNode);
}
return newNode;
};
export default {
App3D: App3D,
/**
* Create a 3D application that will manage the app initialization and loop.
*
* See more details at {@link clay.application.App3D}
*
* @name clay.application.create
* @method
* @param {HTMLElement|string} dom Container dom element or a selector string that can be used in `querySelector`
* @param {App3DNamespace} appNS Options and namespace used in creating app3D
*
* @return {clay.application.App3D}
*
* @example
* clay.application.create('#app', {
* init: function (app) {
* app.createCube();
* var camera = app.createCamera();
* camera.position.set(0, 0, 2);
* },
* loop: function () { // noop }
* })
*/
create: function (dom, appNS) {
return new App3D(dom, appNS);
}
}; |