GroundElevationVolumeGraphics

new IonSdkSensors.GroundElevationVolumeGraphics(options)

An optionally time-dynamic ground elevation volume, whose origin is the entity's position. The volume's inner (near-nadir) and outer (near-limb) boundaries are defined by maximum and minimum ground elevation angles, respectively, rather than by static cone half-angles. The projected footprint therefore changes dynamically with the origin's altitude. Because its orientation is defined by the motion of the entity rather than set freely, it is referred to as a volume rather than a sensor; see GroundElevationVolume.

When the entity has no orientation, the zero clock angle follows the entity's inertial velocity, which suits satellites. For aircraft, ships and other slow vehicles near the Earth, set Entity#orientation to a VelocityOrientationProperty so it follows the Earth-relative velocity instead. See GroundElevationVolumeVisualizer for details.

Name Type Description
options GroundElevationVolumeGraphics.ConstructorOptions optional Object describing initialization options
Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

Members

classificationType : Property|undefined

Gets or sets the ClassificationType Property specifying whether this volume will classify terrain, 3D Tiles, or both.

readonly definitionChanged : Event

Gets the event that is raised whenever a new property is assigned.

domeSurfaceMaterial : MaterialProperty

Gets or sets the MaterialProperty specifying the the surface appearance of the volume's dome.

ellipsoidSurfaceMaterial : MaterialProperty

Gets or sets the MaterialProperty specifying the the volume's ellipsoid surface appearance.

environmentConstraint : Property|undefined

Gets or sets the boolean Property determining if a volume will intersect the environment, e.g. terrain or models, and discard the portion of the volume that is occluded.

environmentIntersectionColor : Property|undefined

Gets or sets the Color Property of the line intersecting the environment.

environmentIntersectionWidth : Property|undefined

Gets or sets the Property that approximate width in meters of the line intersecting the environment.

environmentOcclusionMaterial : MaterialProperty

Gets or sets the MaterialProperty specifying the surface appearance of the portion of the volume occluded by the environment.

intersectionColor : Property|undefined

Gets or sets the Color Property specifying the color of the line formed by the intersection of the volume and other central bodies.

intersectionWidth : Property|undefined

Gets or sets the numeric Property specifying the width of the line formed by the intersection of the volume and other central bodies.

lateralSurfaceMaterial : MaterialProperty

Gets or sets the MaterialProperty specifying the the volume's appearance.

maximumClockAngle : Property|undefined

Gets or sets the numeric Property specifying the the volume's maximum clock angle.

maximumGroundElevationAngle : Property|undefined

Gets or sets the numeric Property specifying the volume's maximum ground elevation angle, which defines the inner (near-nadir) boundary of the volume.

maximumRadius : Property|undefined

Gets or sets the numeric Property specifying the maximum radius of the volume's projection. This is equivalent to GroundElevationVolumeGraphics#radius and takes precedence over it when both are provided.

minimumClockAngle : Property|undefined

Gets or sets the numeric Property specifying the the volume's minimum clock angle.

minimumGroundElevationAngle : Property|undefined

Gets or sets the numeric Property specifying the volume's minimum ground elevation angle, which defines the outer (near-limb) boundary of the volume.

minimumRadius : Property|undefined

Gets or sets the numeric Property specifying the minimum radius of the volume's projection.

radius : Property|undefined

Gets or sets the numeric Property specifying the radius of the volume's projection. This is equivalent to GroundElevationVolumeGraphics#maximumRadius, which takes precedence over this property when both are provided.

show : Property|undefined

Gets or sets the boolean Property specifying the visibility of the volume.

showDomeSurfaces : Property|undefined

Gets or sets the boolean Property specifying the visibility of the dome surfaces defining the volume.

showEllipsoidSurfaces : Property|undefined

Gets or sets the boolean Property specifying the visibility of the ellipsoid surfaces defining the volume.

showEnvironmentIntersection : Property|undefined

Gets or sets the boolean Property that determines if a line is shown where the volume intersects the environment, e.g. terrain or models.

showEnvironmentOcclusion : Property|undefined

Gets or sets the boolean Property determining if the portion of the volume occluded by the environment will be drawn with GroundElevationVolumeGraphics#environmentOcclusionMaterial.

showIntersection : Property|undefined

Gets or sets the boolean Property specifying the visibility of the line formed by the intersection of the volume and other central bodies.

showLateralSurfaces : Property|undefined

Gets or sets the boolean Property specifying the visibility of the lateral surfaces defining the volume.

showThroughEllipsoid : Property|undefined

Gets or sets the boolean Property specifying whether a volume intersecting the ellipsoid is drawn through the ellipsoid and potentially out to the other side.

showViewshed : Property|undefined

Gets or sets the boolean Property specifying the visibility of the viewshed.

viewshedOccludedColor : Property|undefined

Gets or sets the Color Property of the scene geometry that is not visible from the origin.

viewshedResolution : Property|undefined

Gets or sets the Property that controls the resolution in pixels of the viewshed.

viewshedVisibleColor : Property|undefined

Gets or sets the Color Property of the scene geometry that is visible from the origin.

Methods

clone(result) → GroundElevationVolumeGraphics

Duplicates a GroundElevationVolumeGraphics instance.
Name Type Description
result GroundElevationVolumeGraphics optional The object onto which to store the result.
Returns:
The modified result parameter or a new instance if one was not provided.

merge(source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description
source GroundElevationVolumeGraphics The object to be merged into this object.

Type Definitions

IonSdkSensors.GroundElevationVolumeGraphics.ConstructorOptions

Initialization options for the GroundElevationVolumeGraphics constructor
Properties:
Name Type Attributes Default Description
show Property | Boolean <optional>
true Determines if the volume will be shown.
radius Property | Number <optional>
Number.POSITIVE_INFINITY The distance from the origin to any point on the dome. Equivalent to maximumRadius, which takes precedence over this property when both are provided.
minimumRadius Property | Number <optional>
0.0 The distance from the origin to any point on the inner dome.
maximumRadius Property | Number <optional>
Number.POSITIVE_INFINITY The distance from the origin to any point on the outer dome. Equivalent to radius and takes precedence over it when both are provided.
minimumGroundElevationAngle Property | Number <optional>
0.0 The minimum ground elevation angle, measured from the local horizontal at a point on the ground to the direction to the origin, that defines the outer (near-limb) boundary of the volume.
maximumGroundElevationAngle Property | Number <optional>
CesiumMath.PI_OVER_TWO The maximum ground elevation angle, measured from the local horizontal at a point on the ground to the direction to the origin, that defines the inner (near-nadir) boundary of the volume.
minimumClockAngle Property | Number <optional>
0.0 The minimum clock angle of the wedge.
maximumClockAngle Property | Number <optional>
CesiumMath.TWO_PI The maximum clock angle of the wedge.
lateralSurfaceMaterial MaterialProperty | Color <optional>
Color.WHITE The surface appearance of the volume lateral surface, i.e., the outer sides of the volume.
showLateralSurfaces Property | Boolean <optional>
true Determines if the lateral surfaces, i.e., the outer sides of the volume, are shown.
ellipsoidSurfaceMaterial MaterialProperty | Color <optional>
Color.WHITE The appearance of the ellipsoid surface where the volume intersects.
showEllipsoidSurfaces Property | Boolean <optional>
true Determines if the ellipsoid/volume intersection surfaces are shown.
domeSurfaceMaterial MaterialProperty | Color <optional>
Color.WHITE The appearance of the dome surfaces.
showDomeSurfaces Property | Boolean <optional>
true Determines if the dome surfaces are shown.
showIntersection Property | Boolean <optional>
true Determines if a polyline is shown where the volume intersects the ellipsoid.
intersectionColor Property | Color <optional>
Color.WHITE The color of the polyline where the volume intersects the ellipsoid.
intersectionWidth Property | Number <optional>
5.0 The approximate pixel width of the polyline where the volume intersects the ellipsoid.
showThroughEllipsoid Property | Boolean <optional>
false Determines if a volume intersecting the ellipsoid is drawn through the ellipsoid and potentially out to the other side.
environmentConstraint Property | Boolean <optional>
false Determines if the volume will be occluded by the environment, e.g. terrain or models.
showEnvironmentOcclusion Property | Boolean <optional>
false Determines if the portion of the volume occluded by the environment is shown.
environmentOcclusionMaterial MaterialProperty | Color <optional>
Color.WHITE The appearance of the surface that is occluded by the environment.
showEnvironmentIntersection Property | Boolean <optional>
false Determines if the line intersecting the volume and the environment is shown.
environmentIntersectionColor Property | Color <optional>
Color.WHITE The color of the line intersecting the volume and the environment.
environmentIntersectionWidth Property | Number <optional>
5.0 The width of the line intersecting the volume and the environment in meters.
showViewshed Property | Boolean <optional>
false The visibility of the viewshed.
viewshedVisibleColor Property | Color <optional>
Color.LIME The color of the scene geometry that is visible from the origin.
viewshedOccludedColor Property | Color <optional>
Color.RED The color of the scene geometry that is not visible from the origin.
viewshedResolution Property | Number <optional>
2048 The resolution in pixels of the viewshed.
classificationType Property | ClassificationType <optional>
ClassificationType.BOTH Whether this volume will classify terrain, 3D Tiles, or both.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.