agi.foundation.cesium

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

Class AzimuthElevationMaskGraphics

java.lang.Object

agi.foundation.cesium.AzimuthElevationMaskGraphics

public class AzimuthElevationMaskGraphics
extends Object

Defines the graphical properties of an AzimuthElevationMask. This will produce the agi_fan property in CZML.

See Also:

CZML specification for the fan property

Constructor Summary

Constructors

Constructor and Description
AzimuthElevationMaskGraphics() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
CesiumProperty<Boolean>	getFill() Gets whether or not the mask is filled.
CesiumProperty<IMaterialGraphics>	getMaterial() Gets the material used to fill the region.
CesiumProperty<Integer>	getNumberOfRings() Gets the number of rings to draw for the outline.
CesiumProperty<Boolean>	getOutline() Gets whether or not the mask is outlined.
CesiumProperty<Color>	getOutlineColor() Gets the color of the outline.
CesiumProperty<Double>	getOutlineWidth() Gets the width of the outline.
ConstantCesiumProperty<AzimuthElevationMaskGraphicsProjection>	getProjection() Gets how the mask is projected.
ConstantCesiumProperty<Double>	getProjectionAltitude() Gets the altitude to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_ALTITUDE.
CesiumProperty<Double>	getProjectionRange() Gets the range to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_RANGE.
CesiumProperty<Boolean>	getShow() Gets whether or not the mask is shown.
void	setFill(CesiumProperty<Boolean> value) Sets whether or not the mask is filled.
void	setMaterial(CesiumProperty<IMaterialGraphics> value) Sets the material used to fill the region.
void	setNumberOfRings(CesiumProperty<Integer> value) Sets the number of rings to draw for the outline.
void	setOutline(CesiumProperty<Boolean> value) Sets whether or not the mask is outlined.
void	setOutlineColor(CesiumProperty<Color> value) Sets the color of the outline.
void	setOutlineWidth(CesiumProperty<Double> value) Sets the width of the outline.
void	setProjection(ConstantCesiumProperty<AzimuthElevationMaskGraphicsProjection> value) Sets how the mask is projected.
void	setProjectionAltitude(ConstantCesiumProperty<Double> value) Sets the altitude to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_ALTITUDE.
void	setProjectionRange(CesiumProperty<Double> value) Sets the range to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_RANGE.
void	setShow(CesiumProperty<Boolean> value) Sets whether or not the mask is shown.

Methods inherited from class java.lang.Object

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

Constructor Detail

AzimuthElevationMaskGraphics

public AzimuthElevationMaskGraphics()

Initializes a new instance.

Method Detail

getShow

public final CesiumProperty<Boolean> getShow()

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

setShow

public final void setShow(CesiumProperty<Boolean> value)

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

getMaterial

public final CesiumProperty<IMaterialGraphics> getMaterial()

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

setMaterial

public final void setMaterial(CesiumProperty<IMaterialGraphics> value)

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

getProjection

public final ConstantCesiumProperty<AzimuthElevationMaskGraphicsProjection> getProjection()

Gets how the mask is projected. This property must be specified, or the mask will not be displayed.

setProjection

public final void setProjection(ConstantCesiumProperty<AzimuthElevationMaskGraphicsProjection> value)

Sets how the mask is projected. This property must be specified, or the mask will not be displayed.

getProjectionRange

public final CesiumProperty<Double> getProjectionRange()

Gets the range to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_RANGE.

setProjectionRange

public final void setProjectionRange(CesiumProperty<Double> value)

Sets the range to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_RANGE.

getProjectionAltitude

public final ConstantCesiumProperty<Double> getProjectionAltitude()

Gets the altitude to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_ALTITUDE.

setProjectionAltitude

public final void setProjectionAltitude(ConstantCesiumProperty<Double> value)

Sets the altitude to use when Projection (get / set) is AzimuthElevationMaskGraphicsProjection.PROJECT_TO_ALTITUDE.

getFill

public final CesiumProperty<Boolean> getFill()

Gets whether or not the mask is filled. If not specified, the default is true.

setFill

public final void setFill(CesiumProperty<Boolean> value)

Sets whether or not the mask is filled. If not specified, the default is true.

getOutline

public final CesiumProperty<Boolean> getOutline()

Gets whether or not the mask is outlined. If not specified, the default is false.

setOutline

public final void setOutline(CesiumProperty<Boolean> value)

Sets whether or not the mask is outlined. If not specified, the default is false.

getOutlineColor

public final CesiumProperty<Color> getOutlineColor()

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

setOutlineColor

public final void setOutlineColor(CesiumProperty<Color> value)

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

getOutlineWidth

public final CesiumProperty<Double> getOutlineWidth()

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

setOutlineWidth

public final void setOutlineWidth(CesiumProperty<Double> value)

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

getNumberOfRings

public final CesiumProperty<Integer> getNumberOfRings()

Gets the number of rings to draw for the outline. Rings start from the outer edge and are equidistantly spaced towards the center. If not specified, the default is 6.

setNumberOfRings

public final void setNumberOfRings(CesiumProperty<Integer> value)

Sets the number of rings to draw for the outline. Rings start from the outer edge and are equidistantly spaced towards the center. If not specified, the default is 6.