/
Cesium3DTileFeature.js
269 lines (254 loc) · 9.66 KB
/
Cesium3DTileFeature.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
define([
'../Core/Color',
'../Core/defined',
'../Core/defineProperties'
], function(
Color,
defined,
defineProperties) {
'use strict';
/**
* A feature of a {@link Cesium3DTileset}.
* <p>
* Provides access to a feature's properties stored in the tile's batch table, as well
* as the ability to show/hide a feature and change its highlight color via
* {@link Cesium3DTileFeature#show} and {@link Cesium3DTileFeature#color}, respectively.
* </p>
* <p>
* Modifications to a <code>Cesium3DTileFeature</code> object have the lifetime of the tile's
* content. If the tile's content is unloaded, e.g., due to it going out of view and needing
* to free space in the cache for visible tiles, listen to the {@link Cesium3DTileset#tileUnload} event to save any
* modifications. Also listen to the {@link Cesium3DTileset#tileVisible} event to reapply any modifications.
* </p>
* <p>
* Do not construct this directly. Access it through {@link Cesium3DTileContent#getFeature}
* or picking using {@link Scene#pick} and {@link Scene#pickPosition}.
* </p>
*
* @alias Cesium3DTileFeature
* @constructor
*
* @example
* // On mouse over, display all the properties for a feature in the console log.
* handler.setInputAction(function(movement) {
* var feature = scene.pick(movement.endPosition);
* if (feature instanceof Cesium.Cesium3DTileFeature) {
* var propertyNames = feature.getPropertyNames();
* var length = propertyNames.length;
* for (var i = 0; i < length; ++i) {
* var propertyName = propertyNames[i];
* console.log(propertyName + ': ' + feature.getProperty(propertyName));
* }
* }
* }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
*/
function Cesium3DTileFeature(content, batchId) {
this._content = content;
this._batchId = batchId;
this._color = undefined; // for calling getColor
}
defineProperties(Cesium3DTileFeature.prototype, {
/**
* Gets or sets if the feature will be shown. This is set for all features
* when a style's show is evaluated.
*
* @memberof Cesium3DTileFeature.prototype
*
* @type {Boolean}
*
* @default true
*/
show : {
get : function() {
return this._content.batchTable.getShow(this._batchId);
},
set : function(value) {
this._content.batchTable.setShow(this._batchId, value);
}
},
/**
* Gets or sets the highlight color multiplied with the feature's color. When
* this is white, the feature's color is not changed. This is set for all features
* when a style's color is evaluated.
*
* @memberof Cesium3DTileFeature.prototype
*
* @type {Color}
*
* @default {@link Color.WHITE}
*/
color : {
get : function() {
if (!defined(this._color)) {
this._color = new Color();
}
return this._content.batchTable.getColor(this._batchId, this._color);
},
set : function(value) {
this._content.batchTable.setColor(this._batchId, value);
}
},
/**
* Gets the content of the tile containing the feature.
*
* @memberof Cesium3DTileFeature.prototype
*
* @type {Cesium3DTileContent}
*
* @readonly
* @private
*/
content : {
get : function() {
return this._content;
}
},
/**
* Gets the tileset containing the feature.
*
* @memberof Cesium3DTileFeature.prototype
*
* @type {Cesium3DTileset}
*
* @readonly
*/
tileset : {
get : function() {
return this._content.tileset;
}
},
/**
* All objects returned by {@link Scene#pick} have a <code>primitive</code> property. This returns
* the tileset containing the feature.
*
* @memberof Cesium3DTileFeature.prototype
*
* @type {Cesium3DTileset}
*
* @readonly
*/
primitive : {
get : function() {
return this._content.tileset;
}
}
});
/**
* Returns whether the feature contains this property. This includes properties from this feature's
* class and inherited classes when using a batch table hierarchy.
*
* @see {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/TileFormats/BatchTable#batch-table-hierarchy}
*
* @param {String} name The case-sensitive name of the property.
* @returns {Boolean} Whether the feature contains this property.
*/
Cesium3DTileFeature.prototype.hasProperty = function(name) {
return this._content.batchTable.hasProperty(this._batchId, name);
};
/**
* Returns an array of property names for the feature. This includes properties from this feature's
* class and inherited classes when using a batch table hierarchy.
*
* @see {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/TileFormats/BatchTable#batch-table-hierarchy}
*
* @param {String[]} results An array into which to store the results.
* @returns {String[]} The names of the feature's properties.
*/
Cesium3DTileFeature.prototype.getPropertyNames = function(results) {
return this._content.batchTable.getPropertyNames(this._batchId, results);
};
/**
* Returns a copy of the value of the feature's property with the given name. This includes properties from this feature's
* class and inherited classes when using a batch table hierarchy.
*
* @see {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/TileFormats/BatchTable#batch-table-hierarchy}
*
* @param {String} name The case-sensitive name of the property.
* @returns {*} The value of the property or <code>undefined</code> if the property does not exist.
*
* @example
* // Display all the properties for a feature in the console log.
* var propertyNames = feature.getPropertyNames();
* var length = propertyNames.length;
* for (var i = 0; i < length; ++i) {
* var propertyName = propertyNames[i];
* console.log(propertyName + ': ' + feature.getProperty(propertyName));
* }
*/
Cesium3DTileFeature.prototype.getProperty = function(name) {
return this._content.batchTable.getProperty(this._batchId, name);
};
/**
* Sets the value of the feature's property with the given name.
* <p>
* If a property with the given name doesn't exist, it is created.
* </p>
*
* @param {String} name The case-sensitive name of the property.
* @param {*} value The value of the property that will be copied.
*
* @exception {DeveloperError} Inherited batch table hierarchy property is read only.
*
* @example
* var height = feature.getProperty('Height'); // e.g., the height of a building
*
* @example
* var name = 'clicked';
* if (feature.getProperty(name)) {
* console.log('already clicked');
* } else {
* feature.setProperty(name, true);
* console.log('first click');
* }
*/
Cesium3DTileFeature.prototype.setProperty = function(name, value) {
this._content.batchTable.setProperty(this._batchId, name, value);
// PERFORMANCE_IDEA: Probably overkill, but maybe only mark the tile dirty if the
// property is in one of the style's expressions or - if it can be done quickly -
// if the new property value changed the result of an expression.
this._content.featurePropertiesDirty = true;
};
/**
* Returns whether the feature's class name equals <code>className</code>. Unlike {@link Cesium3DTileFeature#isClass}
* this function only checks the feature's exact class and not inherited classes.
* <p>
* This function returns <code>false</code> if no batch table hierarchy is present.
* </p>
*
* @param {String} className The name to check against.
* @returns {Boolean} Whether the feature's class name equals <code>className</code>
*
* @private
*/
Cesium3DTileFeature.prototype.isExactClass = function(className) {
return this._content.batchTable.isExactClass(this._batchId, className);
};
/**
* Returns whether the feature's class or any inherited classes are named <code>className</code>.
* <p>
* This function returns <code>false</code> if no batch table hierarchy is present.
* </p>
*
* @param {String} className The name to check against.
* @returns {Boolean} Whether the feature's class or inherited classes are named <code>className</code>
*
* @private
*/
Cesium3DTileFeature.prototype.isClass = function(className) {
return this._content.batchTable.isClass(this._batchId, className);
};
/**
* Returns the feature's class name.
* <p>
* This function returns <code>undefined</code> if no batch table hierarchy is present.
* </p>
*
* @returns {String} The feature's class name.
*
* @private
*/
Cesium3DTileFeature.prototype.getExactClassName = function() {
return this._content.batchTable.getExactClassName(this._batchId);
};
return Cesium3DTileFeature;
});