-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
Cesium3DTileStyle.js
492 lines (463 loc) · 18.4 KB
/
Cesium3DTileStyle.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
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
define([
'../Core/clone',
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/DeveloperError',
'../Core/loadJson',
'../Core/RequestScheduler',
'../ThirdParty/when',
'./ConditionsExpression',
'./Expression'
], function(
clone,
defaultValue,
defined,
defineProperties,
DeveloperError,
loadJson,
RequestScheduler,
when,
ConditionsExpression,
Expression) {
'use strict';
/**
* A style that is applied to a {@link Cesium3DTileset}.
* <p>
* Evaluates an expression defined using the
* {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling|3D Tiles Styling language}.
* </p>
*
* @alias Cesium3DTileStyle
* @constructor
*
* @param {String|Object} [style] The url of a style or an object defining a style.
*
* @example
* tileset.style = new Cesium.Cesium3DTileStyle({
* color : {
* conditions : [
* ['${Height} >= 100', 'color("purple", 0.5)'],
* ['${Height} >= 50', 'color("red")'],
* ['true', 'color("blue")']
* ]
* },
* show : '${Height} > 0',
* meta : {
* description : '"Building id ${id} has height ${Height}."'
* }
* });
*
* @example
* tileset.style = new Cesium.Cesium3DTileStyle({
* color : 'vec4(${Temperature})',
* pointSize : '${Temperature} * 2.0'
* });
*
* @see {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling|3D Tiles Styling language}
*/
function Cesium3DTileStyle(style) {
this._style = undefined;
this._ready = false;
this._color = undefined;
this._show = undefined;
this._pointSize = undefined;
this._meta = undefined;
this._colorShaderFunction = undefined;
this._showShaderFunction = undefined;
this._pointSizeShaderFunction = undefined;
this._colorShaderFunctionReady = false;
this._showShaderFunctionReady = false;
this._pointSizeShaderFunctionReady = false;
var promise;
if (typeof style === 'string') {
promise = loadJson(style);
} else {
promise = when.resolve(style);
}
var that = this;
this._readyPromise = promise.then(function(styleJson) {
setup(that, styleJson);
return that;
});
}
function setup(that, styleJson) {
that._style = clone(styleJson, true);
styleJson = defaultValue(styleJson, defaultValue.EMPTY_OBJECT);
that.color = styleJson.color;
that.show = styleJson.show;
that.pointSize = styleJson.pointSize;
var meta = {};
if (defined(styleJson.meta)) {
var defines = styleJson.defines;
var metaJson = defaultValue(styleJson.meta, defaultValue.EMPTY_OBJECT);
for (var property in metaJson) {
if (metaJson.hasOwnProperty(property)) {
meta[property] = new Expression(metaJson[property], defines);
}
}
}
that._meta = meta;
that._ready = true;
}
defineProperties(Cesium3DTileStyle.prototype, {
/**
* Gets the object defining the style using the
* {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling|3D Tiles Styling language}.
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {Object}
* @readonly
*
* @default undefined
*
* @exception {DeveloperError} The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.
*/
style : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.');
}
//>>includeEnd('debug');
return this._style;
}
},
/**
* When <code>true</code>, the style is ready and its expressions can be evaluated. When
* a style is constructed with an object, as opposed to a url, this is <code>true</code> immediately.
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {Boolean}
* @readonly
*
* @default false
*/
ready : {
get : function() {
return this._ready;
}
},
/**
* Gets the promise that will be resolved when the the style is ready and its expressions can be evaluated.
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {Promise.<Cesium3DTileStyle>}
* @readonly
*/
readyPromise : {
get : function() {
return this._readyPromise;
}
},
/**
* Gets or sets the {@link StyleExpression} object used to evaluate the style's <code>show</code> property. Alternatively a boolean, string, or object defining a show style can be used.
* The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
* <p>
* The expression must return or convert to a <code>Boolean</code>.
* </p>
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {StyleExpression}
*
* @exception {DeveloperError} The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.
*
* @example
* var style = new Cesium3DTileStyle({
* show : '(regExp("^Chest").test(${County})) && (${YearBuilt} >= 1970)'
* });
* style.show.evaluate(frameState, feature); // returns true or false depending on the feature's properties
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override show expression with a custom function
* style.show = {
* evaluate : function(frameState, feature) {
* return true;
* }
* };
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override show expression with a boolean
* style.show = true;
* };
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override show expression with a string
* style.show = '${Height} > 0';
* };
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override show expression with a condition
* style.show = {
* conditions: [
* ['${height} > 2', 'false'],
* ['true', 'true']
* ];
* };
*/
show : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.');
}
//>>includeEnd('debug');
return this._show;
},
set : function(value) {
var defines = defaultValue(this._style, defaultValue.EMPTY_OBJECT).defines;
if (!defined(value)) {
this._show = undefined;
} else if (typeof value === 'boolean') {
this._show = new Expression(String(value));
} else if (typeof value === 'string') {
this._show = new Expression(value, defines);
} else if (defined(value.conditions)) {
this._show = new ConditionsExpression(value, defines);
} else {
this._show = value;
}
this._showShaderFunctionReady = false;
}
},
/**
* Gets or sets the {@link StyleExpression} object used to evaluate the style's <code>color</code> property. Alternatively a string or object defining a color style can be used.
* The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
* <p>
* The expression must return a <code>Color</code>.
* </p>
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {StyleExpression}
*
* @exception {DeveloperError} The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.
*
* @example
* var style = new Cesium3DTileStyle({
* color : '(${Temperature} > 90) ? color("red") : color("white")'
* });
* style.color.evaluateColor(frameState, feature, result); // returns a Cesium.Color object
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override color expression with a custom function
* style.color = {
* evaluateColor : function(frameState, feature, result) {
* return Cesium.Color.clone(Cesium.Color.WHITE, result);
* }
* };
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override color expression with a string
* style.color = 'color("blue")';
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override color expression with a condition
* style.color = {
* conditions : [
* ['${height} > 2', 'color("cyan")'],
* ['true', 'color("blue")']
* ]
* };
*/
color : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.');
}
//>>includeEnd('debug');
return this._color;
},
set : function(value) {
var defines = defaultValue(this._style, defaultValue.EMPTY_OBJECT).defines;
if (!defined(value)) {
this._color = undefined;
} else if (typeof value === 'string') {
this._color = new Expression(value, defines);
} else if (defined(value.conditions)) {
this._color = new ConditionsExpression(value, defines);
} else {
this._color = value;
}
this._colorShaderFunctionReady = false;
}
},
/**
* Gets or sets the {@link StyleExpression} object used to evaluate the style's <code>pointSize</code> property. Alternatively a number, string, or object defining a pointSize style can be used.
* The getter will return the internal {@link Expression} or {@link ConditionsExpression}, which may differ from the value provided to the setter.
* <p>
* The expression must return or convert to a <code>Number</code>.
* </p>
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {StyleExpression}
*
* @exception {DeveloperError} The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.
*
* @example
* var style = new Cesium3DTileStyle({
* pointSize : '(${Temperature} > 90) ? 2.0 : 1.0'
* });
* style.pointSize.evaluate(frameState, feature); // returns a Number
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override pointSize expression with a custom function
* style.pointSize = {
* evaluate : function(frameState, feature) {
* return 1.0;
* }
* };
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override pointSize expression with a number
* style.pointSize = 1.0;
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override pointSize expression with a string
* style.pointSize = '${height} / 10';
*
* @example
* var style = new Cesium.Cesium3DTileStyle();
* // Override pointSize expression with a condition
* style.pointSize = {
* conditions : [
* ['${height} > 2', '1.0'],
* ['true', '2.0']
* ]
* };
*/
pointSize : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.');
}
//>>includeEnd('debug');
return this._pointSize;
},
set : function(value) {
var defines = defaultValue(this._style, defaultValue.EMPTY_OBJECT).defines;
if (!defined(value)) {
this._pointSize = undefined;
} else if (typeof value === 'number') {
this._pointSize = new Expression(String(value));
} else if (typeof value === 'string') {
this._pointSize = new Expression(value, defines);
} else if (defined(value.conditions)) {
this._pointSize = new ConditionsExpression(value, defines);
} else {
this._pointSize = value;
}
this._pointSizeShaderFunctionReady = false;
}
},
/**
* Gets or sets the object containing application-specific expression that can be explicitly
* evaluated, e.g., for display in a UI.
*
* @memberof Cesium3DTileStyle.prototype
*
* @type {StyleExpression}
*
* @exception {DeveloperError} The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.
*
* @example
* var style = new Cesium3DTileStyle({
* meta : {
* description : '"Building id ${id} has height ${Height}."'
* }
* });
* style.meta.description.evaluate(frameState, feature); // returns a String with the substituted variables
*/
meta : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('The style is not loaded. Use Cesium3DTileStyle.readyPromise or wait for Cesium3DTileStyle.ready to be true.');
}
//>>includeEnd('debug');
return this._meta;
},
set : function(value) {
this._meta = value;
}
}
});
/**
* Gets the color shader function for this style.
*
* @param {String} functionName Name to give to the generated function.
* @param {String} attributePrefix Prefix that is added to any variable names to access vertex attributes.
* @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent.
*
* @returns {String} The shader function.
*
* @private
*/
Cesium3DTileStyle.prototype.getColorShaderFunction = function(functionName, attributePrefix, shaderState) {
if (this._colorShaderFunctionReady) {
// Return the cached result, may be undefined
return this._colorShaderFunction;
}
this._colorShaderFunctionReady = true;
this._colorShaderFunction = defined(this.color) ? this.color.getShaderFunction(functionName, attributePrefix, shaderState, 'vec4') : undefined;
return this._colorShaderFunction;
};
/**
* Gets the show shader function for this style.
*
* @param {String} functionName Name to give to the generated function.
* @param {String} attributePrefix Prefix that is added to any variable names to access vertex attributes.
* @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent.
*
* @returns {String} The shader function.
*
* @private
*/
Cesium3DTileStyle.prototype.getShowShaderFunction = function(functionName, attributePrefix, shaderState) {
if (this._showShaderFunctionReady) {
// Return the cached result, may be undefined
return this._showShaderFunction;
}
this._showShaderFunctionReady = true;
this._showShaderFunction = defined(this.show) ? this.show.getShaderFunction(functionName, attributePrefix, shaderState, 'bool') : undefined;
return this._showShaderFunction;
};
/**
* Gets the pointSize shader function for this style.
*
* @param {String} functionName Name to give to the generated function.
* @param {String} attributePrefix Prefix that is added to any variable names to access vertex attributes.
* @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent.
*
* @returns {String} The shader function.
*
* @private
*/
Cesium3DTileStyle.prototype.getPointSizeShaderFunction = function(functionName, attributePrefix, shaderState) {
if (this._pointSizeShaderFunctionReady) {
// Return the cached result, may be undefined
return this._pointSizeShaderFunction;
}
this._pointSizeShaderFunctionReady = true;
this._pointSizeShaderFunction = defined(this.pointSize) ? this.pointSize.getShaderFunction(functionName, attributePrefix, shaderState, 'float') : undefined;
return this._pointSizeShaderFunction;
};
return Cesium3DTileStyle;
});