agi.foundation.cesium

(agi.foundation.cesium-2025r1.jar)

Class PathGraphics

java.lang.Object

agi.foundation.cesium.PathGraphics

public class PathGraphics
extends Object

Defines the graphical properties of the path of a moving object over time. This will produce the path property in CZML.

Note that because clients cannot render a truly infinite path, the path must be limited in some manner. The path is limited by the LeadTime (get / set) and TrailTime (get / set) values, and also by the availability of the object. Availability is determined using the AvailabilityIntervals (get) of the Point of the object, but can be overridden using CesiumAvailabilityExtension.

See Also:

CZML specification for the path property

Constructor Summary

Constructors

Constructor and Description
PathGraphics() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
CesiumProperty<Bounds>	getDistanceDisplayCondition() Gets the distances from the camera at which this path will be displayed.
CesiumProperty<Double>	getLeadTime() Gets the lead time of the path, in seconds.
CesiumProperty<IPolylineMaterialGraphics>	getMaterial() Gets the material used to draw the path.
CesiumProperty<Double>	getResolution() Gets the resolution of the path, in seconds.
CesiumProperty<Boolean>	getShow() Gets whether or not the path is shown.
CesiumProperty<Double>	getTrailTime() Gets the trail time of the path, in seconds.
CesiumProperty<Double>	getWidth() Gets the width of the path.
void	setDistanceDisplayCondition(CesiumProperty<Bounds> value) Sets the distances from the camera at which this path will be displayed.
void	setLeadTime(CesiumProperty<Double> value) Sets the lead time of the path, in seconds.
void	setMaterial(CesiumProperty<IPolylineMaterialGraphics> value) Sets the material used to draw the path.
void	setResolution(CesiumProperty<Double> value) Sets the resolution of the path, in seconds.
void	setShow(CesiumProperty<Boolean> value) Sets whether or not the path is shown.
void	setTrailTime(CesiumProperty<Double> value) Sets the trail time of the path, in seconds.
void	setWidth(CesiumProperty<Double> value) Sets the width of the path.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathGraphics

public PathGraphics()

Initializes a new instance.

Method Detail

getShow

public final CesiumProperty<Boolean> getShow()

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

setShow

public final void setShow(CesiumProperty<Boolean> value)

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

getWidth

public final CesiumProperty<Double> getWidth()

Gets the width of the path. If not specified, the default is 1.0.

setWidth

public final void setWidth(CesiumProperty<Double> value)

Sets the width of the path. If not specified, the default is 1.0.

getResolution

public final CesiumProperty<Double> getResolution()

Gets the resolution of the path, in seconds. This value is the minimum step size the client will take when sampling the position of the object to create the path. Lower numbers provide improved visual fidelity at the cost of rendering performance. If not specified, the default is 60.0.

setResolution

public final void setResolution(CesiumProperty<Double> value)

Sets the resolution of the path, in seconds. This value is the minimum step size the client will take when sampling the position of the object to create the path. Lower numbers provide improved visual fidelity at the cost of rendering performance. If not specified, the default is 60.0.

getLeadTime

public final CesiumProperty<Double> getLeadTime()

Gets the lead time of the path, in seconds. The lead time is the amount of time ahead of the current position that the path extends in front of the object. By default, the value is unlimited, which effectively results in drawing the entire available path of the object.

setLeadTime

public final void setLeadTime(CesiumProperty<Double> value)

Sets the lead time of the path, in seconds. The lead time is the amount of time ahead of the current position that the path extends in front of the object. By default, the value is unlimited, which effectively results in drawing the entire available path of the object.

getTrailTime

public final CesiumProperty<Double> getTrailTime()

Gets the trail time of the path, in seconds. The trail time is the amount of time behind of the current position that the path extends behind the object. By default, the value is unlimited, which effectively results in drawing the entire available path of the object.

setTrailTime

public final void setTrailTime(CesiumProperty<Double> value)

Sets the trail time of the path, in seconds. The trail time is the amount of time behind of the current position that the path extends behind the object. By default, the value is unlimited, which effectively results in drawing the entire available path of the object.

getMaterial

public final CesiumProperty<IPolylineMaterialGraphics> getMaterial()

Gets the material used to draw the path. If not specified, the default is a SolidColorMaterialGraphics with Color (get / set) set to White (get).

setMaterial

public final void setMaterial(CesiumProperty<IPolylineMaterialGraphics> value)

Sets the material used to draw the path. If not specified, the default is a SolidColorMaterialGraphics with Color (get / set) set to White (get).

getDistanceDisplayCondition

public final CesiumProperty<Bounds> getDistanceDisplayCondition()

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

setDistanceDisplayCondition

public final void setDistanceDisplayCondition(CesiumProperty<Bounds> value)

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