org.cesiumjs.cs.scene

Class Cesium3DTilePointFeature

java.lang.Object

org.cesiumjs.cs.scene.Cesium3DTilePointFeature

@JsType(isNative=true,
        namespace="Cesium",
        name="Cesium3DTilePointFeature")
public class Cesium3DTilePointFeature
extends Object

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(org.cesiumjs.cs.core.Cartesian2).

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Color	anchorLineColor Gets or sets the color for the anchor line.
boolean	anchorLineEnabled Gets or sets whether the anchor line is displayed.
Color	backgroundColor Gets or sets the background color of the text for this feature.
boolean	backgroundEnabled Gets or sets whether to display the background of the text for this feature.
Cartesian2	backgroundPadding Gets or sets the background padding of the text for this feature.
Color	color Gets or sets the color of the point of this feature.
Number	disableDepthTestDistance 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.
String	font Gets or sets the font of this feature.
double	heightOffset Gets or sets the height offset in meters of this feature.
Number	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.
String	image Gets or sets the image of this feature.
Color	labelColor Gets or sets the label color of this feature.
Number	labelHorizontalOrigin 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.
Color	labelOutlineColor Gets or sets the label outline color of this feature.
double	labelOutlineWidth Gets or sets the outline width in pixels of this feature.
LabelStyle	labelStyle Gets or sets the fill and outline style of this feature.
String	labelText Gets or sets the text for this feature.
Number	labelVerticalOrigin 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.
Color	pointOutlineColor Gets or sets the point outline color of this feature.
double	pointOutlineWidth Gets or sets the point outline width in pixels of this feature.
double	pointSize Gets or sets the point size of this feature.
Cesium3DTileset	readonlyprimitive All objects returned by Scene#pick have a primitive property.
NearFarScalar	scaleByDistance Gets or sets the near and far scaling properties for this feature.
NearFarScalar	translucencyByDistance Gets or sets the near and far translucency properties for this feature.
Number	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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cesium3DTilePointFeature() A point feature of a Cesium3DTileset.

Method Summary

Modifier and Type	Method and Description
JsObject	getProperty(String name) Returns a copy of the value of the feature's property with the given name.
String[]	getPropertyNames(String[] results) Returns an array of property names for the feature.
void	setProperty(String name, JsObject value) Sets the value of the feature's property with the given name.
Cesium3DTileset	tileset() Gets the tileset containing the feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

anchorLineColor

@JsProperty
public Color anchorLineColor

Gets or sets the color for the anchor line. Only applied when heightOffset is defined.

anchorLineEnabled

@JsProperty
public boolean anchorLineEnabled

Gets or sets whether the anchor line is displayed. Only applied when heightOffset is defined.

backgroundColor

@JsProperty
public Color backgroundColor

Gets or sets the background color of the text for this feature. Only applied when labelText is defined.

backgroundEnabled

@JsProperty
public boolean backgroundEnabled

Gets or sets whether to display the background of the text for this feature. Only applied when labelText is defined.

backgroundPadding

@JsProperty
public Cartesian2 backgroundPadding

Gets or sets the background padding of the text for this feature. Only applied when labelText is defined.

color

@JsProperty
public Color color

Gets or sets the color of the point of this feature. Only applied when image is undefined.

disableDepthTestDistance

@JsProperty
public Number disableDepthTestDistance

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

distanceDisplayCondition

@JsProperty
public DistanceDisplayCondition distanceDisplayCondition

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

font

@JsProperty
public String font

Gets or sets the font of this feature. Only applied when the labelText is defined.

heightOffset

@JsProperty
public double heightOffset

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

horizontalOrigin

@JsProperty
public Number 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

@JsProperty
public String image

Gets or sets the image of this feature.

labelColor

@JsProperty
public Color labelColor

Gets or sets the label color of this feature.

labelHorizontalOrigin

@JsProperty
public Number labelHorizontalOrigin

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.

See Also:

HorizontalOrigin

labelOutlineColor

@JsProperty
public Color labelOutlineColor

Gets or sets the label outline color of this feature. The outline color will be applied to the label if labelText is defined.

labelOutlineWidth

@JsProperty
public double labelOutlineWidth

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

@JsProperty
public LabelStyle labelStyle

Gets or sets the fill and outline style of this feature. Only applied when labelText is defined.

labelText

@JsProperty
public String labelText

Gets or sets the text for this feature.

labelVerticalOrigin

@JsProperty
public Number labelVerticalOrigin

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.

See Also:

VerticalOrigin

pointOutlineColor

@JsProperty
public Color pointOutlineColor

Gets or sets the point outline color of this feature. Only applied when image is undefined.

pointOutlineWidth

@JsProperty
public double pointOutlineWidth

Gets or sets the point outline width in pixels of this feature. Only applied when image is undefined.

pointSize

@JsProperty
public double pointSize

Gets or sets the point size of this feature. Only applied when image is undefined.

readonlyprimitive

@JsProperty
public Cesium3DTileset readonlyprimitive

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

scaleByDistance

@JsProperty
public NearFarScalar scaleByDistance

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

translucencyByDistance

@JsProperty
public NearFarScalar translucencyByDistance

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

verticalOrigin

@JsProperty
public Number 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.

See Also:

VerticalOrigin

Constructor Detail

Cesium3DTilePointFeature

@JsConstructor
protected 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(org.cesiumjs.cs.core.Cartesian2).

Method Detail

tileset

@JsProperty(name="tileset")
public Cesium3DTileset tileset()

Gets the tileset containing the feature.

getProperty

@JsMethod
public JsObject getProperty(String 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.

Parameters:

name - The case-sensitive name of the property.

Returns:

The value of the property or undefined if the property does not exist.

getPropertyNames

@JsMethod
public String[] getPropertyNames(String[] results)

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

Parameters:

results - The names of the feature's properties.

Returns:

The names of the feature's properties.

setProperty

@JsMethod
public void setProperty(String name,
                                  JsObject 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.

Parameters:

name - The case-sensitive name of the property.

value - The value of the property that will be copied.