kotlin-cesium-engine/cesium.engine/Cesium3DTilePointFeature

Cesium3DTilePointFeature

external class Cesium3DTilePointFeature(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 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.

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

Properties

anchorLineColor

var anchorLineColor: Color

Gets or sets the color for the anchor line.

anchorLineEnabled

var anchorLineEnabled: Boolean

Gets or sets whether the anchor line is displayed.

backgroundColor

var backgroundColor: Color

Gets or sets the background color of the text for this feature.

backgroundEnabled

var backgroundEnabled: Boolean

Gets or sets whether to display the background of the text for this feature.

backgroundPadding

var backgroundPadding: Cartesian2

Gets or sets the background padding of the text for this feature.

color

var color: Color

Gets or sets the color of the point of this feature.

disableDepthTestDistance

var disableDepthTestDistance: Double

Gets or sets the distance where depth testing will be disabled.

distanceDisplayCondition

var distanceDisplayCondition: DistanceDisplayCondition

Gets or sets the condition specifying at what distance from the camera that this feature will be displayed.

font

var font: String

Gets or sets the font of this feature.

heightOffset

var heightOffset: Double

Gets or sets the height offset in meters of this feature.

horizontalOrigin

var horizontalOrigin: HorizontalOrigin

Gets or sets the horizontal origin of this point, which determines if the point is to the left, center, or right of its anchor position.

image

var image: String

Gets or sets the image of this feature.

labelColor

var labelColor: Color

Gets or sets the label color of this feature.

labelHorizontalOrigin

var labelHorizontalOrigin: HorizontalOrigin

Gets or sets the horizontal origin of this point's text, which determines if the point's text is to the left, center, or right of its anchor position.

labelOutlineColor

var labelOutlineColor: Color

Gets or sets the label outline color of this feature.

labelOutlineWidth

var labelOutlineWidth: Double

Gets or sets the outline width in pixels of this feature.

labelStyle

var labelStyle: LabelStyle

Gets or sets the fill and outline style of this feature.

labelText

var labelText: String

Gets or sets the text for this feature.

labelVerticalOrigin

var labelVerticalOrigin: VerticalOrigin

Get or sets the vertical origin of this point's text, which determines if the point's text is to the bottom, center, top, or baseline of it's anchor point.

pointOutlineColor

var pointOutlineColor: Color

Gets or sets the point outline color of this feature.

pointOutlineWidth

var pointOutlineWidth: Double

Gets or sets the point outline width in pixels of this feature.

pointSize

var pointSize: Double

Gets or sets the point size of this feature.

primitive

val primitive: Cesium3DTileset

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

scaleByDistance

var scaleByDistance: NearFarScalar

Gets or sets the near and far scaling properties for this 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.

translucencyByDistance

var translucencyByDistance: NearFarScalar

Gets or sets the near and far translucency properties for this feature.

verticalOrigin

var verticalOrigin: VerticalOrigin

Gets or sets the vertical origin of this point, which determines if the point is to the bottom, center, or top of its anchor position.

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.

Cesium3DTilePointFeature

See also

Properties

Functions