Cesium3DTilePointFeature

A point feature of a 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.

new Ditap.Cesium3DTilePointFeature(content, batchId, billboard, label, polyline)

Name Type Description
content Cesium3DTileContent
batchId number
billboard Billboard
label Label
polyline Polyline
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 Ditap.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)}`);
        }
    }
}, Ditap.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

Gets or sets the color for the anchor line.

Only applied when heightOffset is defined.

anchorLineEnabled : boolean

Gets or sets whether the anchor line is displayed.

Only applied when heightOffset is defined.

backgroundColor : Color

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

Only applied when labelText is defined.

backgroundEnabled : boolean

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

Only applied when labelText is defined.

backgroundPadding : Cartesian2

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

Only applied when labelText is defined.

color : Color

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

Only applied when image is undefined.

disableDepthTestDistance : number

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

distanceDisplayCondition : DistanceDisplayCondition

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

font : string

Gets or sets the font of this feature.

Only applied when the labelText is defined.

heightOffset : number

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

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 : string

Gets or sets the image of this feature.

labelColor : Color

Gets or sets the label color of this feature.

The color will be applied to the label if labelText is defined.

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 : Color

Gets or sets the label outline color of this feature.

The outline color will be applied to the label if labelText is defined.

labelOutlineWidth : number

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

The outline width will be applied to the point if labelText is defined.

labelStyle : LabelStyle

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

Only applied when labelText is defined.

labelText : string

Gets or sets the text for this feature.

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 : Color

Gets or sets the point outline color of this feature.

Only applied when image is undefined.

pointOutlineWidth : number

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

Only applied when image is undefined.

pointSize : number

Gets or sets the point size of this feature.

Only applied when image is undefined.

readonly primitive : Cesium3DTileset

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

scaleByDistance : NearFarScalar

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

show : boolean

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

readonly tileset : Cesium3DTileset

Gets the tileset containing the feature.

translucencyByDistance : NearFarScalar

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

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.

Methods

getProperty(name) → *

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.
Name Type Description
name string The case-sensitive name of the property.
Returns:
The value of the property or 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:

getPropertyIds(results) → Array.<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.
Name Type Description
results Array.<string> optional An array into which to store the results.
Returns:
The IDs of the feature's properties.
See:

hasProperty(name) → 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.
Name Type Description
name string The case-sensitive name of the property.
Returns:
Whether the feature contains this property.
See:

setProperty(name, value)

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

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');
}
CtrlK
core
engine
widgets
ditap