-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
MaterialAppearance.js
326 lines (306 loc) · 12.4 KB
/
MaterialAppearance.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
/*global define*/
define([
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/freezeObject',
'../Core/VertexFormat',
'../Shaders/Appearances/AllMaterialAppearanceFS',
'../Shaders/Appearances/AllMaterialAppearanceVS',
'../Shaders/Appearances/BasicMaterialAppearanceFS',
'../Shaders/Appearances/BasicMaterialAppearanceVS',
'../Shaders/Appearances/TexturedMaterialAppearanceFS',
'../Shaders/Appearances/TexturedMaterialAppearanceVS',
'./Appearance',
'./Material'
], function(
defaultValue,
defined,
defineProperties,
freezeObject,
VertexFormat,
AllMaterialAppearanceFS,
AllMaterialAppearanceVS,
BasicMaterialAppearanceFS,
BasicMaterialAppearanceVS,
TexturedMaterialAppearanceFS,
TexturedMaterialAppearanceVS,
Appearance,
Material) {
"use strict";
/**
* An appearance for arbitrary geometry (as opposed to {@link EllipsoidSurfaceAppearance}, for example)
* that supports shading with materials.
*
* @alias MaterialAppearance
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Boolean} [options.flat=false] When <code>true</code>, flat shading is used in the fragment shader, which means lighting is not taking into account.
* @param {Boolean} [options.faceForward=!options.closed] When <code>true</code>, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}.
* @param {Boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled.
* @param {Boolean} [options.closed=false] When <code>true</code>, the geometry is expected to be closed so {@link MaterialAppearance#renderState} has backface culling enabled.
* @param {MaterialAppearance.MaterialSupport} [options.materialSupport=MaterialAppearance.MaterialSupport.TEXTURED] The type of materials that will be supported.
* @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color.
* @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader.
* @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader.
* @param {RenderState} [options.renderState] Optional render state to override the default render state.
*
* @see {@link https://github.com/AnalyticalGraphicsInc/cesium/wiki/Fabric|Fabric}
* @demo {@link http://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Material.html|Cesium Sandcastle Material Appearance Demo}
*
* @example
* var primitive = new Cesium.Primitive({
* geometryInstances : new Cesium.GeometryInstance({
* geometry : new Cesium.WallGeometry({
materialSupport : Cesium.MaterialAppearance.MaterialSupport.BASIC.vertexFormat,
* // ...
* })
* }),
* appearance : new Cesium.MaterialAppearance({
* material : Cesium.Material.fromType('Color'),
* faceForward : true
* })
*
* });
*/
var MaterialAppearance = function(options) {
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
var translucent = defaultValue(options.translucent, true);
var closed = defaultValue(options.closed, false);
var materialSupport = defaultValue(options.materialSupport, MaterialAppearance.MaterialSupport.TEXTURED);
/**
* The material used to determine the fragment color. Unlike other {@link MaterialAppearance}
* properties, this is not read-only, so an appearance's material can change on the fly.
*
* @type Material
*
* @default {@link Material.ColorType}
*
* @see {@link https://github.com/AnalyticalGraphicsInc/cesium/wiki/Fabric|Fabric}
*/
this.material = (defined(options.material)) ? options.material : Material.fromType(Material.ColorType);
/**
* When <code>true</code>, the geometry is expected to appear translucent.
*
* @type {Boolean}
*
* @default true
*/
this.translucent = translucent;
this._vertexShaderSource = defaultValue(options.vertexShaderSource, materialSupport.vertexShaderSource);
this._fragmentShaderSource = defaultValue(options.fragmentShaderSource, materialSupport.fragmentShaderSource);
this._renderState = Appearance.getDefaultRenderState(translucent, closed, options.renderState);
this._closed = closed;
// Non-derived members
this._materialSupport = materialSupport;
this._vertexFormat = materialSupport.vertexFormat;
this._flat = defaultValue(options.flat, false);
this._faceForward = defaultValue(options.faceForward, !closed);
};
defineProperties(MaterialAppearance.prototype, {
/**
* The GLSL source code for the vertex shader.
*
* @memberof MaterialAppearance.prototype
*
* @type {String}
* @readonly
*/
vertexShaderSource : {
get : function() {
return this._vertexShaderSource;
}
},
/**
* The GLSL source code for the fragment shader. The full fragment shader
* source is built procedurally taking into account {@link MaterialAppearance#material},
* {@link MaterialAppearance#flat}, and {@link MaterialAppearance#faceForward}.
* Use {@link MaterialAppearance#getFragmentShaderSource} to get the full source.
*
* @memberof MaterialAppearance.prototype
*
* @type {String}
* @readonly
*/
fragmentShaderSource : {
get : function() {
return this._fragmentShaderSource;
}
},
/**
* The WebGL fixed-function state to use when rendering the geometry.
* <p>
* The render state can be explicitly defined when constructing a {@link MaterialAppearance}
* instance, or it is set implicitly via {@link MaterialAppearance#translucent}
* and {@link MaterialAppearance#closed}.
* </p>
*
* @memberof MaterialAppearance.prototype
*
* @type {Object}
* @readonly
*/
renderState : {
get : function() {
return this._renderState;
}
},
/**
* When <code>true</code>, the geometry is expected to be closed so
* {@link MaterialAppearance#renderState} has backface culling enabled.
* If the viewer enters the geometry, it will not be visible.
*
* @memberof MaterialAppearance.prototype
*
* @type {Boolean}
* @readonly
*
* @default false
*/
closed : {
get : function() {
return this._closed;
}
},
/**
* The type of materials supported by this instance. This impacts the required
* {@link VertexFormat} and the complexity of the vertex and fragment shaders.
*
* @memberof MaterialAppearance.prototype
*
* @type {MaterialAppearance.MaterialSupport}
* @readonly
*
* @default {@link MaterialAppearance.MaterialSupport.TEXTURED}
*/
materialSupport : {
get : function() {
return this._materialSupport;
}
},
/**
* The {@link VertexFormat} that this appearance instance is compatible with.
* A geometry can have more vertex attributes and still be compatible - at a
* potential performance cost - but it can't have less.
*
* @memberof MaterialAppearance.prototype
*
* @type VertexFormat
* @readonly
*
* @default {@link MaterialAppearance.MaterialSupport.TEXTURED.vertexFormat}
*/
vertexFormat : {
get : function() {
return this._vertexFormat;
}
},
/**
* When <code>true</code>, flat shading is used in the fragment shader,
* which means lighting is not taking into account.
*
* @memberof MaterialAppearance.prototype
*
* @type {Boolean}
* @readonly
*
* @default false
*/
flat : {
get : function() {
return this._flat;
}
},
/**
* When <code>true</code>, the fragment shader flips the surface normal
* as needed to ensure that the normal faces the viewer to avoid
* dark spots. This is useful when both sides of a geometry should be
* shaded like {@link WallGeometry}.
*
* @memberof MaterialAppearance.prototype
*
* @type {Boolean}
* @readonly
*
* @default true
*/
faceForward : {
get : function() {
return this._faceForward;
}
}
});
/**
* Procedurally creates the full GLSL fragment shader source. For {@link MaterialAppearance},
* this is derived from {@link MaterialAppearance#fragmentShaderSource}, {@link MaterialAppearance#material},
* {@link MaterialAppearance#flat}, and {@link MaterialAppearance#faceForward}.
*
* @function
*
* @returns String The full GLSL fragment shader source.
*/
MaterialAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource;
/**
* Determines if the geometry is translucent based on {@link MaterialAppearance#translucent} and {@link Material#isTranslucent}.
*
* @function
*
* @returns {Boolean} <code>true</code> if the appearance is translucent.
*/
MaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent;
/**
* Creates a render state. This is not the final render state instance; instead,
* it can contain a subset of render state properties identical to the render state
* created in the context.
*
* @function
*
* @returns {Object} The render state.
*/
MaterialAppearance.prototype.getRenderState = Appearance.prototype.getRenderState;
/**
* Determines the type of {@link Material} that is supported by a
* {@link MaterialAppearance} instance. This is a trade-off between
* flexibility (a wide array of materials) and memory/performance
* (required vertex format and GLSL shader complexity.
*/
MaterialAppearance.MaterialSupport = {
/**
* Only basic materials, which require just <code>position</code> and
* <code>normal</code> vertex attributes, are supported.
*
* @constant
*/
BASIC : freezeObject({
vertexFormat : VertexFormat.POSITION_AND_NORMAL,
vertexShaderSource : BasicMaterialAppearanceVS,
fragmentShaderSource : BasicMaterialAppearanceFS
}),
/**
* Materials with textures, which require <code>position</code>,
* <code>normal</code>, and <code>st</code> vertex attributes,
* are supported. The vast majority of materials fall into this category.
*
* @constant
*/
TEXTURED : freezeObject({
vertexFormat : VertexFormat.POSITION_NORMAL_AND_ST,
vertexShaderSource : TexturedMaterialAppearanceVS,
fragmentShaderSource : TexturedMaterialAppearanceFS
}),
/**
* All materials, including those that work in tangent space, are supported.
* This requires <code>position</code>, <code>normal</code>, <code>st</code>,
* <code>binormal</code>, and <code>tangent</code> vertex attributes.
*
* @constant
*/
ALL : freezeObject({
vertexFormat : VertexFormat.ALL,
vertexShaderSource : AllMaterialAppearanceVS,
fragmentShaderSource : AllMaterialAppearanceFS
})
};
return MaterialAppearance;
});