agi.foundation.cesium

(agi.foundation.cesium-2024r2.jar)

Class PointGraphics

java.lang.Object

agi.foundation.cesium.PointGraphics

public class PointGraphics
extends Object

Defines the graphical properties of a point over time. This will produce the point property in CZML.

See Also:

CZML specification for the point property

Constructor Summary

Constructors

Constructor and Description
PointGraphics() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
CesiumProperty<Color>	getColor() Gets the color of the point.
CesiumProperty<Double>	getDisableDepthTestDistance() Gets the distance from the camera at which to disable the depth test.
CesiumProperty<Bounds>	getDistanceDisplayCondition() Gets the distances from the camera at which this point will be displayed.
CesiumProperty<CesiumHeightReference>	getHeightReference() Gets the height reference of the point.
CesiumProperty<Color>	getOutlineColor() Gets the outline color of the point.
CesiumProperty<Double>	getOutlineWidth() Gets the outline width of the point, in pixels.
CesiumProperty<Double>	getPixelSize() Gets the size of the point.
CesiumProperty<NearFarScalar>	getScaleByDistance() Gets how the point's scale should change based on the point's distance from the camera.
CesiumProperty<Boolean>	getShow() Gets whether or not the point is shown.
CesiumProperty<NearFarScalar>	getTranslucencyByDistance() Gets how the point's translucency should change based on the point's distance from the camera.
void	setColor(CesiumProperty<Color> value) Sets the color of the point.
void	setDisableDepthTestDistance(CesiumProperty<Double> value) Sets the distance from the camera at which to disable the depth test.
void	setDistanceDisplayCondition(CesiumProperty<Bounds> value) Sets the distances from the camera at which this point will be displayed.
void	setHeightReference(CesiumProperty<CesiumHeightReference> value) Sets the height reference of the point.
void	setOutlineColor(CesiumProperty<Color> value) Sets the outline color of the point.
void	setOutlineWidth(CesiumProperty<Double> value) Sets the outline width of the point, in pixels.
void	setPixelSize(CesiumProperty<Double> value) Sets the size of the point.
void	setScaleByDistance(CesiumProperty<NearFarScalar> value) Sets how the point's scale should change based on the point's distance from the camera.
void	setShow(CesiumProperty<Boolean> value) Sets whether or not the point is shown.
void	setTranslucencyByDistance(CesiumProperty<NearFarScalar> value) Sets how the point's translucency should change based on the point's distance from the camera.

Methods inherited from class java.lang.Object

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

Constructor Detail

PointGraphics

public PointGraphics()

Initializes a new instance.

Method Detail

getShow

public final CesiumProperty<Boolean> getShow()

Gets whether or not the point is shown. If not specified, the default is true.

setShow

public final void setShow(CesiumProperty<Boolean> value)

Sets whether or not the point is shown. If not specified, the default is true.

getPixelSize

public final CesiumProperty<Double> getPixelSize()

Gets the size of the point. If not specified, the default is 1.0.

setPixelSize

public final void setPixelSize(CesiumProperty<Double> value)

Sets the size of the point. If not specified, the default is 1.0.

getHeightReference

public final CesiumProperty<CesiumHeightReference> getHeightReference()

Gets the height reference of the point. If not specified, the default is CesiumHeightReference.NONE.

setHeightReference

public final void setHeightReference(CesiumProperty<CesiumHeightReference> value)

Sets the height reference of the point. If not specified, the default is CesiumHeightReference.NONE.

getColor

public final CesiumProperty<Color> getColor()

Gets the color of the point. If not specified, the default is White (get).

setColor

public final void setColor(CesiumProperty<Color> value)

Sets the color of the point. If not specified, the default is White (get).

getOutlineColor

public final CesiumProperty<Color> getOutlineColor()

Gets the outline color of the point. If not specified, the default is Black (get).

setOutlineColor

public final void setOutlineColor(CesiumProperty<Color> value)

Sets the outline color of the point. If not specified, the default is Black (get).

getOutlineWidth

public final CesiumProperty<Double> getOutlineWidth()

Gets the outline width of the point, in pixels. If not specified, the default is 0.0.

setOutlineWidth

public final void setOutlineWidth(CesiumProperty<Double> value)

Sets the outline width of the point, in pixels. If not specified, the default is 0.0.

getScaleByDistance

public final CesiumProperty<NearFarScalar> getScaleByDistance()

Gets how the point's scale should change based on the point's distance from the camera. This scalar value will be multiplied by PixelSize (get / set). If not specified, then the scale does not change based on the camera distance.

setScaleByDistance

public final void setScaleByDistance(CesiumProperty<NearFarScalar> value)

Sets how the point's scale should change based on the point's distance from the camera. This scalar value will be multiplied by PixelSize (get / set). If not specified, then the scale does not change based on the camera distance.

getTranslucencyByDistance

public final CesiumProperty<NearFarScalar> getTranslucencyByDistance()

Gets how the point's translucency should change based on the point's distance from the camera. This scalar value should range from 0 to 1. If not specified, then the translucency does not change based on the camera distance.

setTranslucencyByDistance

public final void setTranslucencyByDistance(CesiumProperty<NearFarScalar> value)

Sets how the point's translucency should change based on the point's distance from the camera. This scalar value should range from 0 to 1. If not specified, then the translucency does not change based on the camera distance.

getDistanceDisplayCondition

public final CesiumProperty<Bounds> getDistanceDisplayCondition()

Gets the distances from the camera at which this point will be displayed. If not specified, the point is displayed regardless of camera distance.

setDistanceDisplayCondition

public final void setDistanceDisplayCondition(CesiumProperty<Bounds> value)

Sets the distances from the camera at which this point will be displayed. If not specified, the point is displayed regardless of camera distance.

getDisableDepthTestDistance

public final CesiumProperty<Double> getDisableDepthTestDistance()

Gets the distance from the camera at which to disable the depth test. This can be used to prevent clipping against terrain, for example. When set to zero, the depth test is always applied. When set to Double.POSITIVE_INFINITY, the depth test is never applied. If not specified, the default is 0.0.

setDisableDepthTestDistance

public final void setDisableDepthTestDistance(CesiumProperty<Double> value)

Sets the distance from the camera at which to disable the depth test. This can be used to prevent clipping against terrain, for example. When set to zero, the depth test is always applied. When set to Double.POSITIVE_INFINITY, the depth test is never applied. If not specified, the default is 0.0.