agi.foundation.cesium

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

Class BillboardGraphics

java.lang.Object

agi.foundation.cesium.BillboardGraphics

public class BillboardGraphics
extends Object

Defines the graphical properties of a billboard, also sometimes called a marker. A billboard is a viewport-aligned image positioned in the 3D scene. This will produce the billboard property in CZML.

See Also:

CZML specification for the billboard property

Constructor Summary

Constructors

Constructor and Description
BillboardGraphics() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
CesiumProperty<UnitCartesian>	getAlignedAxis() Gets the aligned axis, which is the unit vector, in world coordinates, that the billboard up vector points towards.
CesiumProperty<Color>	getColor() Gets the color of the billboard.
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 billboard will be displayed.
CesiumProperty<Cartesian>	getEyeOffset() Gets the billboard's offset from the origin in eye coordinates.
CesiumProperty<Double>	getHeight() Gets the height of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true).
CesiumProperty<CesiumHeightReference>	getHeightReference() Gets the height reference of the billboard.
CesiumProperty<CesiumHorizontalOrigin>	getHorizontalOrigin() Gets whether the billboard is left, center, or right-aligned with the origin.
CesiumProperty<CesiumResource>	getImage() Gets the billboard image.
CesiumProperty<BoundingRectangle>	getImageSubRegion() Gets a sub-region of the image which will be used for the billboard, rather than the entire image, measured in pixels from the bottom-left.
CesiumProperty<Rectangular>	getPixelOffset() Gets the billboard's offset from the origin in pixel coordinates.
CesiumProperty<NearFarScalar>	getPixelOffsetScaleByDistance() Gets how the billboard's pixel offset should change based on the billboard's distance from the camera.
CesiumProperty<Double>	getRotation() Gets the rotation of the billboard, in radians, offset from the AlignedAxis (get / set).
CesiumProperty<Double>	getScale() Gets the scale of the billboard image.
CesiumProperty<NearFarScalar>	getScaleByDistance() Gets how the billboard's scale should change based on the billboard's distance from the camera.
CesiumProperty<Boolean>	getShow() Gets whether or not the billboard is shown.
CesiumProperty<Boolean>	getSizeInMeters() Gets whether this billboard's size (Width (get / set) and Height (get / set)) should be measured in meters, otherwise size is measured in pixels.
CesiumProperty<NearFarScalar>	getTranslucencyByDistance() Gets how the billboard's translucency should change based on the billboard's distance from the camera.
CesiumProperty<CesiumVerticalOrigin>	getVerticalOrigin() Gets whether the billboard is bottom, center, or top-aligned with the origin.
CesiumProperty<Double>	getWidth() Gets the width of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true).
void	setAlignedAxis(CesiumProperty<UnitCartesian> value) Sets the aligned axis, which is the unit vector, in world coordinates, that the billboard up vector points towards.
void	setColor(CesiumProperty<Color> value) Sets the color of the billboard.
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 billboard will be displayed.
void	setEyeOffset(CesiumProperty<Cartesian> value) Sets the billboard's offset from the origin in eye coordinates.
void	setHeight(CesiumProperty<Double> value) Sets the height of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true).
void	setHeightReference(CesiumProperty<CesiumHeightReference> value) Sets the height reference of the billboard.
void	setHorizontalOrigin(CesiumProperty<CesiumHorizontalOrigin> value) Sets whether the billboard is left, center, or right-aligned with the origin.
void	setImage(CesiumProperty<CesiumResource> value) Sets the billboard image.
void	setImageSubRegion(CesiumProperty<BoundingRectangle> value) Sets a sub-region of the image which will be used for the billboard, rather than the entire image, measured in pixels from the bottom-left.
void	setPixelOffset(CesiumProperty<Rectangular> value) Sets the billboard's offset from the origin in pixel coordinates.
void	setPixelOffsetScaleByDistance(CesiumProperty<NearFarScalar> value) Sets how the billboard's pixel offset should change based on the billboard's distance from the camera.
void	setRotation(CesiumProperty<Double> value) Sets the rotation of the billboard, in radians, offset from the AlignedAxis (get / set).
void	setScale(CesiumProperty<Double> value) Sets the scale of the billboard image.
void	setScaleByDistance(CesiumProperty<NearFarScalar> value) Sets how the billboard's scale should change based on the billboard's distance from the camera.
void	setShow(CesiumProperty<Boolean> value) Sets whether or not the billboard is shown.
void	setSizeInMeters(CesiumProperty<Boolean> value) Sets whether this billboard's size (Width (get / set) and Height (get / set)) should be measured in meters, otherwise size is measured in pixels.
void	setTranslucencyByDistance(CesiumProperty<NearFarScalar> value) Sets how the billboard's translucency should change based on the billboard's distance from the camera.
void	setVerticalOrigin(CesiumProperty<CesiumVerticalOrigin> value) Sets whether the billboard is bottom, center, or top-aligned with the origin.
void	setWidth(CesiumProperty<Double> value) Sets the width of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true).

Methods inherited from class java.lang.Object

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

Constructor Detail

BillboardGraphics

public BillboardGraphics()

Initializes a new instance.

Method Detail

getShow

public final CesiumProperty<Boolean> getShow()

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

setShow

public final void setShow(CesiumProperty<Boolean> value)

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

getImage

public final CesiumProperty<CesiumResource> getImage()

Gets the billboard image. This property must be specified, or the billboard will not be displayed.

setImage

public final void setImage(CesiumProperty<CesiumResource> value)

Sets the billboard image. This property must be specified, or the billboard will not be displayed.

getScale

public final CesiumProperty<Double> getScale()

Gets the scale of the billboard image. If not specified, the default is 1.0.

setScale

public final void setScale(CesiumProperty<Double> value)

Sets the scale of the billboard image. If not specified, the default is 1.0.

getPixelOffset

public final CesiumProperty<Rectangular> getPixelOffset()

Gets the billboard's offset from the origin in pixel coordinates. The Y (get) coordinate moves the billboard upwards, and the X (get) coordinate moves the billboard to the right. If not specified, the default is Zero (get).

setPixelOffset

public final void setPixelOffset(CesiumProperty<Rectangular> value)

Sets the billboard's offset from the origin in pixel coordinates. The Y (get) coordinate moves the billboard upwards, and the X (get) coordinate moves the billboard to the right. If not specified, the default is Zero (get).

getEyeOffset

public final CesiumProperty<Cartesian> getEyeOffset()

Gets the billboard's offset from the origin in eye coordinates. Eye coordinates are specified in a left-handed coordinate system where X (get) points toward the viewer's right, Y (get) points up, and Z (get) points into the screen. If not specified, the default is Zero (get).

setEyeOffset

public final void setEyeOffset(CesiumProperty<Cartesian> value)

Sets the billboard's offset from the origin in eye coordinates. Eye coordinates are specified in a left-handed coordinate system where X (get) points toward the viewer's right, Y (get) points up, and Z (get) points into the screen. If not specified, the default is Zero (get).

getHorizontalOrigin

public final CesiumProperty<CesiumHorizontalOrigin> getHorizontalOrigin()

Gets whether the billboard is left, center, or right-aligned with the origin. If not specified, the default is CesiumHorizontalOrigin.CENTER.

setHorizontalOrigin

public final void setHorizontalOrigin(CesiumProperty<CesiumHorizontalOrigin> value)

Sets whether the billboard is left, center, or right-aligned with the origin. If not specified, the default is CesiumHorizontalOrigin.CENTER.

getVerticalOrigin

public final CesiumProperty<CesiumVerticalOrigin> getVerticalOrigin()

Gets whether the billboard is bottom, center, or top-aligned with the origin. If not specified, the default is CesiumVerticalOrigin.CENTER.

setVerticalOrigin

public final void setVerticalOrigin(CesiumProperty<CesiumVerticalOrigin> value)

Sets whether the billboard is bottom, center, or top-aligned with the origin. If not specified, the default is CesiumVerticalOrigin.CENTER.

getHeightReference

public final CesiumProperty<CesiumHeightReference> getHeightReference()

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

setHeightReference

public final void setHeightReference(CesiumProperty<CesiumHeightReference> value)

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

getColor

public final CesiumProperty<Color> getColor()

Gets the color of the billboard. This color value is multiplied with the values of the billboard image to produce the final color. If not specified, the default is White (get).

setColor

public final void setColor(CesiumProperty<Color> value)

Sets the color of the billboard. This color value is multiplied with the values of the billboard image to produce the final color. If not specified, the default is White (get).

getRotation

public final CesiumProperty<Double> getRotation()

Gets the rotation of the billboard, in radians, offset from the AlignedAxis (get / set). If not specified, the default is 0.0.

setRotation

public final void setRotation(CesiumProperty<Double> value)

Sets the rotation of the billboard, in radians, offset from the AlignedAxis (get / set). If not specified, the default is 0.0.

getAlignedAxis

public final CesiumProperty<UnitCartesian> getAlignedAxis()

Gets the aligned axis, which is the unit vector, in world coordinates, that the billboard up vector points towards. If not specified, the default is the zero vector, which means the billboard is aligned to the screen up vector.

setAlignedAxis

public final void setAlignedAxis(CesiumProperty<UnitCartesian> value)

Sets the aligned axis, which is the unit vector, in world coordinates, that the billboard up vector points towards. If not specified, the default is the zero vector, which means the billboard is aligned to the screen up vector.

getSizeInMeters

public final CesiumProperty<Boolean> getSizeInMeters()

Gets whether this billboard's size (Width (get / set) and Height (get / set)) should be measured in meters, otherwise size is measured in pixels. If not specified, the default is false.

setSizeInMeters

public final void setSizeInMeters(CesiumProperty<Boolean> value)

Sets whether this billboard's size (Width (get / set) and Height (get / set)) should be measured in meters, otherwise size is measured in pixels. If not specified, the default is false.

getWidth

public final CesiumProperty<Double> getWidth()

Gets the width of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true). By default, the native width of the image is used.

setWidth

public final void setWidth(CesiumProperty<Double> value)

Sets the width of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true). By default, the native width of the image is used.

getHeight

public final CesiumProperty<Double> getHeight()

Gets the height of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true). By default, the native height of the image is used.

setHeight

public final void setHeight(CesiumProperty<Double> value)

Sets the height of the billboard, in pixels (or meters, if SizeInMeters (get / set) is true). By default, the native height of the image is used.

getScaleByDistance

public final CesiumProperty<NearFarScalar> getScaleByDistance()

Gets how the billboard's scale should change based on the billboard's distance from the camera. This scalar value will be multiplied by Scale (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 billboard's scale should change based on the billboard's distance from the camera. This scalar value will be multiplied by Scale (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 billboard's translucency should change based on the billboard'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 billboard's translucency should change based on the billboard'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.

getPixelOffsetScaleByDistance

public final CesiumProperty<NearFarScalar> getPixelOffsetScaleByDistance()

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

setPixelOffsetScaleByDistance

public final void setPixelOffsetScaleByDistance(CesiumProperty<NearFarScalar> value)

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

getImageSubRegion

public final CesiumProperty<BoundingRectangle> getImageSubRegion()

Gets a sub-region of the image which will be used for the billboard, rather than the entire image, measured in pixels from the bottom-left.

setImageSubRegion

public final void setImageSubRegion(CesiumProperty<BoundingRectangle> value)

Sets a sub-region of the image which will be used for the billboard, rather than the entire image, measured in pixels from the bottom-left.

getDistanceDisplayCondition

public final CesiumProperty<Bounds> getDistanceDisplayCondition()

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

setDistanceDisplayCondition

public final void setDistanceDisplayCondition(CesiumProperty<Bounds> value)

Sets the distances from the camera at which this billboard will be displayed. If not specified, the billboard 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.