org.cesiumjs.cs.scene

Class Cesium3DTileFeature

java.lang.Object

org.cesiumjs.cs.core.PickedObject

org.cesiumjs.cs.scene.Cesium3DTileFeature

@JsType(isNative=true,
        namespace="Cesium",
        name="Cesium3DTileFeature")
public class Cesium3DTileFeature
extends PickedObject

A 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 highlight color via Cesium3DTileset.show and color, respectively. Modifications to a Cesium3DTileFeature object have the lifetime of the tile's content. If the tile's c ontent 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(int) 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	color Gets or sets the highlight color multiplied with the feature's color.
boolean	show Gets or sets if the feature will be shown.

Fields inherited from class org.cesiumjs.cs.core.PickedObject

id, primitive

Constructor Summary

Constructors

Constructor and Description
Cesium3DTileFeature()

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() Returns an array of property names for the feature.
String[]	getPropertyNames(String[] results) Returns an array of property names for the feature.
boolean	hasProperty(String name) Returns whether the feature contains this property.
Cesium3DTileset	primitive() All objects returned by Scene#pick have a primitive property.
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

color

@JsProperty
public 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. Default: Color.WHITE()

show

@JsProperty
public boolean show

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

Constructor Detail

Cesium3DTileFeature

public Cesium3DTileFeature()

Method Detail

primitive

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

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

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.

See Also:

link

getPropertyNames

@JsMethod
public String[] getPropertyNames()

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.

Returns:

The names of the feature's properties.

See Also:

link

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 - An array into which to store the results.

Returns:

The names of the feature's properties.

See Also:

link

hasProperty

@JsMethod
public boolean hasProperty(String name)

Returns whether the feature contains this property. 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:

Whether the feature contains this property.

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.