-
Notifications
You must be signed in to change notification settings - Fork 263
/
loader.js
395 lines (312 loc) · 10.7 KB
/
loader.js
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
/*
*
* xxxxxxx xxxxxxx
* x:::::x x:::::x
* x:::::x x:::::x
* x:::::xx:::::x
* x::::::::::x
* x::::::::x
* x::::::::x
* x::::::::::x
* x:::::xx:::::x
* x:::::x x:::::x
* x:::::x x:::::x
* THE xxxxxxx xxxxxxx TOOLKIT
*
* http://www.goXTK.com
*
* Copyright (c) 2012 The X Toolkit Developers <dev@goXTK.com>
*
* The X Toolkit (XTK) is licensed under the MIT License:
* http://www.opensource.org/licenses/mit-license.php
*
*
*
*
*/
goog.provide('X.loader');
// requires
goog.require('X.base');
goog.require('X.event');
goog.require('X.object');
goog.require('X.parserCRV');
goog.require('X.parserDCM');
goog.require('X.parserFSM');
goog.require('X.parserIMAGE');
goog.require('X.parserLBL');
goog.require('X.parserLUT');
goog.require('X.parserMGZ');
goog.require('X.parserNII');
goog.require('X.parserMRC');
goog.require('X.parserNRRD');
goog.require('X.parserOBJ');
goog.require('X.parserOFF');
goog.require('X.parserRAW');
goog.require('X.parserSTL');
goog.require('X.parserTRK');
goog.require('X.parserVTK');
goog.require('goog.structs.Map');
/**
* This object loads external files in an asynchronous fashion. In addition, the
* loading process is monitored and summarized to a total progress value.
*
* @constructor
* @extends X.base
*/
X.loader = function() {
// call the standard constructor of X.base
goog.base(this);
//
// class attributes
/**
* @inheritDoc
* @const
*/
this._classname = 'loader';
/**
* The hash map holding all the jobs and their status.
*
* @type {!goog.structs.Map}
* @protected
*/
this._jobs = new goog.structs.Map();
/**
* The overall progress value in the range of 0 and 1.
*
* @type {!number}
* @protected
*/
this._progress = 0;
};
// inherit from X.base
goog.inherits(X.loader, X.base);
/**
* Check if all loading is completed.
*
* @return {boolean} TRUE if all loading is completed, FALSE else wise.
*/
X.loader.prototype.completed = function() {
// now we check if all of our jobs are completed
return !this._jobs.containsValue(false);
};
/**
* Add a value to the overall progress value. The given value is normalized
* according to the number of current jobs. After adding the value, a
* X.event.ProgressEvent is fired to inform the progress bar.
*
* @param {!number} value The value to add.
*/
X.loader.prototype.addProgress = function(value) {
// we have a three stage system during loading
//
// stage 1: loading in X.loader
// stage 2: parsing in X.parser (when loading textures, this does not happen
// so the loading adds a 2 in total)
// stage 3: setting up in X.renderer
//
// each stage adds progress from 0..1 with a total of 1 at the end
// add a fake job to prevent the user starring at a full progress bar
this._progress += value / (this._jobs.getCount()) / 3;
// clamp progress to 0..1
this._progress = Math.min(1, this._progress);
// fire a progress event so the progressbar can display something
var progressEvent = new X.event.ProgressEvent();
progressEvent._value = this._progress;
this.dispatchEvent(progressEvent);
};
/**
* Check if the given container is configured with a valid file format.
*
* @param {!X.base} container A container which has an X.file() attached.
* @return {!Array} An array holding the following information [filepath,
* extension in uppercase without the '.', the associated but
* uninstantiated parser for this file format, additional (optional)
* flags which are passed to the parser, the response type]
* @throws {Error} An error, if the configured file format is not supported.
*/
X.loader.prototype.checkFileFormat = function(container) {
// get the associated file of the object
var filepath = container._file._path;
// grab the file extension
var extension = filepath.split('.').pop().toUpperCase();
// support no extensions
if (extension == filepath.toUpperCase()) {
// this means no extension
extension = '';
}
// check if the file format is supported
if (!(extension in X.loader.extensions)) {
throw new Error('The ' + extension + ' file format is not supported.');
}
return [filepath, extension, X.loader.extensions[extension][0],
X.loader.extensions[extension][1], X.loader.extensions[extension][2]];
};
/**
* Download a file associated to a container via Ajax. Callbacks are executed
* depending on the success of the request.
*
* @param {!X.base} container The container which has a X.file() attached.
* @param {!X.object} object The X.object which is the parent of the container
* or equals it.
* @throws {Error} An error, if the given objects were invalid.
*/
X.loader.prototype.load = function(container, object) {
if (!container || !object) {
// should not happen
throw new Error('No container or object to load.');
}
// check if job is already monitored..
// then it is safe to exit
if (this._jobs.containsKey(container._id) && !this._jobs.get(container._id)) {
return;
}
// add this loading job to our jobs map
this._jobs.set(container._id, false);
// check the file format which returns the filepath, extension and the parser
var _checkresult = this.checkFileFormat(container);
var filepath = _checkresult[0];
if (container._filedata != null) {
// we have raw file data attached and therefor can skip the loading
this.parse(null, container, object);
// .. and jump out
return;
}
// we use a simple XHR to get the file contents
// this works for binary and for ascii files
var request = new XMLHttpRequest();
// listen to abort events
goog.events.listen(request, 'abort', this.failed.bind(this, request,
container, object));
// listen to error events
goog.events.listen(request, 'error', this.failed.bind(this, request,
container, object));
// listen to completed events which triggers parsing
goog.events.listen(request, 'load', this.parse.bind(this, request, container,
object));
// configure the URL
request.open('GET', filepath, true);
request.responseType = 'arraybuffer';
// .. and GO!
request.send(null);
};
/**
* Trigger parsing of a data stream. This is the callback for successful
* downloading. A single-shot listener is configured for a X.event.ModifiedEvent
* which then triggers the complete callback.
*
* @param {?XMLHttpRequest} request The original XHR.
* @param {!X.base} container The container which has a X.file() attached.
* @param {!X.object} object The X.object which is the parent of the container
* or equals it.
*/
X.loader.prototype.parse = function(request, container, object) {
// downloading completed, add progress
this.addProgress(1.0);
// we use a timeout here to let the progress bar be able to breath and show
// something
setTimeout(function() {
// check the file format which returns the filepath, extension and the
// parser
var _checkresult = this.checkFileFormat(container);
var parser = _checkresult[2]; // the (uninstantiated) parser
var flags = _checkresult[3]; // some (optional) custom flags
// instantiate the parser
var _parser = new parser;
// listen once to a modified event
goog.events.listenOnce(_parser, X.event.events.MODIFIED, this.complete
.bind(this));
// check if we have loaded data or attached raw data
var _data = container._filedata;
if (_data == null) {
// use the loaded data
_data = request.response;
// and also re-attach the arraybuffer
container._filedata = _data;
}
// call the parse function and pass in the container, the object and the
// data stream and some additional value
_parser.parse(container, object, _data, flags);
}.bind(this), 100);
};
/**
* The complete callback which gets executed after successful parsing of a data
* stream. A X.event.ModifiedEvent is fired to inform the X.renderer that the
* loading was completed.
*
* @param {!X.event.ModifiedEvent} event The modified event holding container
* and object.
*/
X.loader.prototype.complete = function(event) {
// parsing completed, add progress
this.addProgress(1.0);
// we use a timeout here to let the progress bar be able to breath and show
// something
setTimeout(function() {
var container = event._container;
var object = event._object;
// mark the container's file as clean
container._file._dirty = false;
// .. but mark the container as dirty since its content changed
container._dirty = true;
// fire the modified event on the object
object.modified();
// mark the loading job as completed
this._jobs.set(container._id, true);
}.bind(this), 100);
};
/**
* The failure callback which gets executed if anything goes wrong during
* downloading. It always throws an error.
*
* @param {!XMLHttpRequest} request The original XHR.
* @param {!X.base} container The container which has a X.file() attached.
* @param {!X.object} object The X.object which is the parent of the container
* or equals it.
* @throws {Error} An error, stating that something went wrong.
*/
X.loader.prototype.failed = function(request, container, object) {
throw new Error('Loading failed: ', container, object);
};
/**
* Supported data types by extension.
*
* @enum {Array}
*/
X.loader.extensions = {
// support for the following extensions and the mapping to X.parsers as well
// as some custom flags and the result type
'OBJ': [X.parserOBJ, null],
'OFF': [X.parserOFF, null],
'STL': [X.parserSTL, null],
'VTK': [X.parserVTK, null],
'TRK': [X.parserTRK, null],
'MRC': [X.parserMRC, null],
'ST': [X.parserMRC, null],
// FSM, INFLATED, SMOOTHWM, SPHERE, PIAL and ORIG are all freesurfer meshes
'FSM': [X.parserFSM, null],
'INFLATED': [X.parserFSM, null],
'SMOOTHWM': [X.parserFSM, null],
'SPHERE': [X.parserFSM, null],
'PIAL': [X.parserFSM, null],
'ORIG': [X.parserFSM, null],
'NRRD': [X.parserNRRD, null],
'NII': [X.parserNII, null],
'GZ': [X.parserNII, null], // right now nii.gz is the only
// format ending .gz
'DCM': [X.parserDCM, null],
'DICOM': [X.parserDCM, null],
'': [X.parserDCM, null],
'CRV': [X.parserCRV, null],
'LABEL': [X.parserLBL, null],
'MGH': [X.parserMGZ, false],
'MGZ': [X.parserMGZ, true],
'RAW': [X.parserRAW, false],
'RZ': [X.parserRAW, true],
'TXT': [X.parserLUT, null],
'LUT': [X.parserLUT, null],
'PNG': [X.parserIMAGE, 'png'], // here we use the arraybuffer
// response type
'JPG': [X.parserIMAGE, 'jpeg'],
'JPEG': [X.parserIMAGE, 'jpeg'],
'GIF': [X.parserIMAGE, 'gif']
};