Cesium3DTileset
.
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 point properties
Modifications to a Cesium3DTilePointFeature
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 Cesium3DTileset#tileUnload
event to save any
modifications. Also listen to the Cesium3DTileset#tileVisible
event to reapply any modifications.
Do not construct this directly. Access it through Cesium3DTileContent#getFeature
or picking using Scene#pick
and Scene#pickPosition
.
Example:
// On mouse over, display all the properties for a feature in the console log.
handler.setInputAction(function(movement) {
const feature = scene.pick(movement.endPosition);
if (feature instanceof Cesium.Cesium3DTilePointFeature) {
const propertyIds = feature.getPropertyIds();
const length = propertyIds.length;
for (let i = 0; i < length; ++i) {
const propertyId = propertyIds[i];
console.log(`{propertyId}: ${feature.getProperty(propertyId)}`);
}
}
}, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
Experimental
This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
Members
anchorLineColor : Color
Only applied when heightOffset
is defined.
Only applied when heightOffset
is defined.
backgroundColor : Color
Only applied when labelText
is defined.
Only applied when labelText
is defined.
backgroundPadding : Cartesian2
Only applied when labelText
is defined.
Only applied when image
is undefined
.
distanceDisplayCondition : DistanceDisplayCondition
Only applied when the labelText
is defined.
horizontalOrigin : HorizontalOrigin
labelColor : Color
The color will be applied to the label if labelText
is defined.
labelHorizontalOrigin : HorizontalOrigin
labelOutlineColor : Color
The outline color will be applied to the label if labelText
is defined.
The outline width will be applied to the point if labelText
is defined.
labelStyle : LabelStyle
Only applied when labelText
is defined.
labelVerticalOrigin : VerticalOrigin
pointOutlineColor : Color
Only applied when image
is undefined
.
Only applied when image
is undefined
.
Only applied when image
is undefined
.
readonly primitive : Cesium3DTileset
Scene#pick
have a primitive
property. This returns
the tileset containing the feature.
scaleByDistance : NearFarScalar
-
Default Value:
true
readonly tileset : Cesium3DTileset
translucencyByDistance : NearFarScalar
verticalOrigin : VerticalOrigin
Methods
Name | Type | Description |
---|---|---|
name |
String | The case-sensitive name of the property. |
Returns:
undefined
if the feature does not have this property.
Example:
// Display all the properties for a feature in the console log.
const propertyIds = feature.getPropertyIds();
const length = propertyIds.length;
for (let i = 0; i < length; ++i) {
const propertyId = propertyIds[i];
console.log(`{propertyId} : ${feature.getProperty(propertyId)}`);
}
See:
Name | Type | Description |
---|---|---|
results |
Array.<String> | optional An array into which to store the results. |
Returns:
Name | Type | Description |
---|---|---|
results |
Array.<String> | optional An array into which to store the results. |
Returns:
Deprecated: true
See:
Name | Type | Description |
---|---|---|
name |
String | The case-sensitive name of the property. |
Returns:
If a property with the given name doesn't exist, it is created.
Name | Type | Description |
---|---|---|
name |
String | The case-sensitive name of the property. |
value |
* | The value of the property that will be copied. |
Throws:
-
DeveloperError : Inherited batch table hierarchy property is read only.
Examples:
const height = feature.getProperty('Height'); // e.g., the height of a building
const name = 'clicked';
if (feature.getProperty(name)) {
console.log('already clicked');
} else {
feature.setProperty(name, true);
console.log('first click');
}