kotlin-cesium-engine/cesium.engine/Cesium3DTileFeature

Cesium3DTileFeature

external class Cesium3DTileFeature(source)

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 Cesium3DTileFeature.show and Cesium3DTileFeature.color, respectively.

Modifications to a Cesium3DTileFeature 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.

// 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 Cesium3DTileFeature) {
        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)}`);
        }
    }
}, ScreenSpaceEventType.MOUSE_MOVE);

Types

Companion

object Companion

Properties

color

var color: Color

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.

featureId

val featureId: Int

Get the feature ID associated with this feature. For 3D Tiles 1.0, the batch ID is returned. For EXT_mesh_features, this is the feature ID from the selected feature ID set.

polylinePositions

var polylinePositions: Float64Array<*>

Gets a typed array containing the ECEF positions of the polyline. Returns undefined if Cesium3DTileset.vectorKeepDecodedPositions is false or the feature is not a polyline in a vector tile.

primitive

val primitive: Cesium3DTileset

All objects returned by Scene.pick have a primitive property. This returns the tileset containing the feature.

show

var show: Boolean

Gets or sets if the feature will be shown. This is set for all features when a style's show is evaluated.

tileset

val tileset: Cesium3DTileset

Gets the tileset containing the feature.

Functions

getProperty

fun getProperty(name: String): Any

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.

getPropertyIds

fun getPropertyIds(results: ReadonlyArray<String>? = definedExternally): ReadonlyArray<String>

Returns an array of property IDs for the feature. This includes properties from this feature's class and inherited classes when using a batch table hierarchy.

hasProperty

fun hasProperty(name: String): Boolean

Returns whether the feature contains this property. This includes properties from this feature's class and inherited classes when using a batch table hierarchy.

setProperty

fun setProperty(name: String, value: Any)

Sets the value of the feature's property with the given name.

Cesium3DTileFeature

See also

Types

Properties

Functions