kotlin-cesium-engine/cesium.engine/ModelFeature

ModelFeature

A feature of a Model.

Provides access to a feature's properties stored in the model's feature table.

Modifications to a ModelFeature object have the lifetime of the model.

Do not construct this directly. Access it through 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 ModelFeature) {
        console.log(feature);
    }
}, ScreenSpaceEventType.MOUSE_MOVE);

Types

ConstructorOptions

sealed interface ConstructorOptions

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.

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.

Functions

getProperty

fun getProperty(name: String): Any

Returns a copy of the value of the feature's property with the given name.

getPropertyIds

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

Returns an array of property IDs for the feature.

getPropertyInherited

fun getPropertyInherited(name: String): Any

Returns a copy of the feature's property with the given name, examining all the metadata from the EXT_structural_metadata and legacy EXT_feature_metadata glTF extensions. Metadata is checked against name from most specific to most general and the first match is returned. Metadata is checked in this order:

hasProperty

fun hasProperty(name: String): Boolean

Returns whether the feature contains this property.

setProperty

fun setProperty(name: String, value: Any): Boolean

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

ModelFeature

See also

Types

Properties

Functions