CentralBodySurfaceRegionGraphics

java.lang.Object
- agi.foundation.cesium.CentralBodySurfaceRegionGraphics

```
public class CentralBodySurfaceRegionGraphics
extends Object
```
Defines the graphical properties of a CentralBodySurfaceRegion. This will produce the polygon property in CZML.

See Also:

CZML specification for the polygon property

Constructor Summary

Constructors
Constructor and Description

CentralBodySurfaceRegionGraphics()
Initializes a new instance.

Constructors
Constructor and Description
`CentralBodySurfaceRegionGraphics()` Initializes a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CesiumProperty<CesiumArcType>`	`getArcType()` Gets the type of arc that should connect the positions of the polygon.
`CesiumProperty<CesiumClassificationType>`	`getClassificationType()` Gets whether a classification affects terrain, 3D Tiles or both.
`CesiumProperty<Boolean>`	`getCloseBottom()` Gets whether to close the bottom of the extruded region.
`CesiumProperty<Boolean>`	`getCloseTop()` Gets whether to close the top of the extruded region.
`CesiumProperty<Bounds>`	`getDistanceDisplayCondition()` Gets the distances from the camera at which this region will be displayed.
`CesiumProperty<Double>`	`getExtrudedHeight()` Gets the height at which to extrude the region, creating a volume.
`CesiumProperty<CesiumHeightReference>`	`getExtrudedHeightReference()` Gets the extruded height reference of the region, which indicates if `ExtrudedHeight` (`get` / `set`) is relative to terrain or not.
`CesiumProperty<Boolean>`	`getFill()` Gets whether or not the region is filled.
`CesiumProperty<Double>`	`getGranularity()` Gets the granularity, in radians, used to compute the surface geometry.
`CesiumProperty<Double>`	`getHeight()` Gets the height above the surface of the `CentralBody` that the region is drawn.
`CesiumProperty<CesiumHeightReference>`	`getHeightReference()` Gets the height reference of the region, which indicates if `Height` (`get` / `set`) is relative to terrain or not.
`CesiumProperty<IMaterialGraphics>`	`getMaterial()` Gets the material used to fill the region.
`CesiumProperty<Boolean>`	`getOutline()` Gets whether or not the region is outlined.
`CesiumProperty<Color>`	`getOutlineColor()` Gets the color of the region's outline.
`CesiumProperty<Double>`	`getOutlineWidth()` Gets the width of the region's outline.
`CesiumProperty<CesiumShadowMode>`	`getShadows()` Gets whether or not the region casts or receives shadows.
`CesiumProperty<Boolean>`	`getShow()` Gets whether or not the region is shown.
`CesiumProperty<Double>`	`getSTRotation()` Gets the rotation, in radians, to apply to the surface's texture.
`CesiumProperty<Integer>`	`getZIndex()` Gets the z-index of the region, used for ordering ground geometry.
`void`	`setArcType(CesiumProperty<CesiumArcType> value)` Sets the type of arc that should connect the positions of the polygon.
`void`	`setClassificationType(CesiumProperty<CesiumClassificationType> value)` Sets whether a classification affects terrain, 3D Tiles or both.
`void`	`setCloseBottom(CesiumProperty<Boolean> value)` Sets whether to close the bottom of the extruded region.
`void`	`setCloseTop(CesiumProperty<Boolean> value)` Sets whether to close the top of the extruded region.
`void`	`setDistanceDisplayCondition(CesiumProperty<Bounds> value)` Sets the distances from the camera at which this region will be displayed.
`void`	`setExtrudedHeight(CesiumProperty<Double> value)` Sets the height at which to extrude the region, creating a volume.
`void`	`setExtrudedHeightReference(CesiumProperty<CesiumHeightReference> value)` Sets the extruded height reference of the region, which indicates if `ExtrudedHeight` (`get` / `set`) is relative to terrain or not.
`void`	`setFill(CesiumProperty<Boolean> value)` Sets whether or not the region is filled.
`void`	`setGranularity(CesiumProperty<Double> value)` Sets the granularity, in radians, used to compute the surface geometry.
`void`	`setHeight(CesiumProperty<Double> value)` Sets the height above the surface of the `CentralBody` that the region is drawn.
`void`	`setHeightReference(CesiumProperty<CesiumHeightReference> value)` Sets the height reference of the region, which indicates if `Height` (`get` / `set`) is relative to terrain or not.
`void`	`setMaterial(CesiumProperty<IMaterialGraphics> value)` Sets the material used to fill the region.
`void`	`setOutline(CesiumProperty<Boolean> value)` Sets whether or not the region is outlined.
`void`	`setOutlineColor(CesiumProperty<Color> value)` Sets the color of the region's outline.
`void`	`setOutlineWidth(CesiumProperty<Double> value)` Sets the width of the region's outline.
`void`	`setShadows(CesiumProperty<CesiumShadowMode> value)` Sets whether or not the region casts or receives shadows.
`void`	`setShow(CesiumProperty<Boolean> value)` Sets whether or not the region is shown.
`void`	`setSTRotation(CesiumProperty<Double> value)` Sets the rotation, in radians, to apply to the surface's texture.
`void`	`setZIndex(CesiumProperty<Integer> value)` Sets the z-index of the region, used for ordering ground geometry.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CentralBodySurfaceRegionGraphics
```
public CentralBodySurfaceRegionGraphics()
```
    Initializes a new instance.
- Method Detail
  - getShow
```
public final CesiumProperty<Boolean> getShow()
```
    Gets whether or not the region is shown. If not specified, the default is true.
  - setShow
```
public final void setShow(CesiumProperty<Boolean> value)
```
    Sets whether or not the region is shown. If not specified, the default is true.
  - getArcType
```
public final CesiumProperty<CesiumArcType> getArcType()
```
    Gets the type of arc that should connect the positions of the polygon. If not specified, the default value will be determined by the type of EllipsoidSurfaceCurve returned by the region's BoundaryCurve (get).
    If the boundary curve is an EllipsoidRhumbLine or an EllipsoidComplexSurfaceCurve entirely made up of EllipsoidRhumbLine curves, then the value will be CesiumArcType.RHUMB. Otherwise, the value will be CesiumArcType.GEODESIC.
  - setArcType
```
public final void setArcType(CesiumProperty<CesiumArcType> value)
```
    Sets the type of arc that should connect the positions of the polygon. If not specified, the default value will be determined by the type of EllipsoidSurfaceCurve returned by the region's BoundaryCurve (get).
    If the boundary curve is an EllipsoidRhumbLine or an EllipsoidComplexSurfaceCurve entirely made up of EllipsoidRhumbLine curves, then the value will be CesiumArcType.RHUMB. Otherwise, the value will be CesiumArcType.GEODESIC.
  - getHeight
```
public final CesiumProperty<Double> getHeight()
```
    Gets the height above the surface of the CentralBody that the region is drawn. If not specified, the default is 0.0.
  - setHeight
```
public final void setHeight(CesiumProperty<Double> value)
```
    Sets the height above the surface of the CentralBody that the region is drawn. If not specified, the default is 0.0.
  - getHeightReference
```
public final CesiumProperty<CesiumHeightReference> getHeightReference()
```
    Gets the height reference of the region, which indicates if Height (get / set) is relative to terrain or not. If not specified, the default value is CesiumHeightReference.NONE.
  - setHeightReference
```
public final void setHeightReference(CesiumProperty<CesiumHeightReference> value)
```
    Sets the height reference of the region, which indicates if Height (get / set) is relative to terrain or not. If not specified, the default value is CesiumHeightReference.NONE.
  - getExtrudedHeight
```
public final CesiumProperty<Double> getExtrudedHeight()
```
    Gets the height at which to extrude the region, creating a volume. If not specified, the region is not extruded.
  - setExtrudedHeight
```
public final void setExtrudedHeight(CesiumProperty<Double> value)
```
    Sets the height at which to extrude the region, creating a volume. If not specified, the region is not extruded.
  - getExtrudedHeightReference
```
public final CesiumProperty<CesiumHeightReference> getExtrudedHeightReference()
```
    Gets the extruded height reference of the region, which indicates if ExtrudedHeight (get / set) is relative to terrain or not. If not specified, the default value is CesiumHeightReference.NONE.
  - setExtrudedHeightReference
```
public final void setExtrudedHeightReference(CesiumProperty<CesiumHeightReference> value)
```
    Sets the extruded height reference of the region, which indicates if ExtrudedHeight (get / set) is relative to terrain or not. If not specified, the default value is CesiumHeightReference.NONE.
  - getSTRotation
```
public final CesiumProperty<Double> getSTRotation()
```
    Gets the rotation, in radians, to apply to the surface's texture. A positive rotation is counter-clockwise from north. If not specified, the default is 0.0.
  - setSTRotation
```
public final void setSTRotation(CesiumProperty<Double> value)
```
    Sets the rotation, in radians, to apply to the surface's texture. A positive rotation is counter-clockwise from north. If not specified, the default is 0.0.
  - getGranularity
```
public final CesiumProperty<Double> getGranularity()
```
    Gets the granularity, in radians, used to compute the surface geometry. If not specified, the default is Constants.RadiansPerDegree.
  - setGranularity
```
public final void setGranularity(CesiumProperty<Double> value)
```
    Sets the granularity, in radians, used to compute the surface geometry. If not specified, the default is Constants.RadiansPerDegree.
  - getFill
```
public final CesiumProperty<Boolean> getFill()
```
    Gets whether or not the region is filled. If not specified, the default is true.
  - setFill
```
public final void setFill(CesiumProperty<Boolean> value)
```
    Sets whether or not the region is filled. 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).
  - getOutline
```
public final CesiumProperty<Boolean> getOutline()
```
    Gets whether or not the region is outlined. If not specified, the default is false.
  - setOutline
```
public final void setOutline(CesiumProperty<Boolean> value)
```
    Sets whether or not the region is outlined. If not specified, the default is false.
  - getOutlineColor
```
public final CesiumProperty<Color> getOutlineColor()
```
    Gets the color of the region's outline. If not specified, the default is Black (get).
  - setOutlineColor
```
public final void setOutlineColor(CesiumProperty<Color> value)
```
    Sets the color of the region's outline. If not specified, the default is Black (get).
  - getOutlineWidth
```
public final CesiumProperty<Double> getOutlineWidth()
```
    Gets the width of the region's outline. If not specified, the default is 1.0.
  - setOutlineWidth
```
public final void setOutlineWidth(CesiumProperty<Double> value)
```
    Sets the width of the region's outline. If not specified, the default is 1.0.
  - getCloseTop
```
public final CesiumProperty<Boolean> getCloseTop()
```
    Gets whether to close the top of the extruded region. If not specified, the default is true.
  - setCloseTop
```
public final void setCloseTop(CesiumProperty<Boolean> value)
```
    Sets whether to close the top of the extruded region. If not specified, the default is true.
  - getCloseBottom
```
public final CesiumProperty<Boolean> getCloseBottom()
```
    Gets whether to close the bottom of the extruded region. If not specified, the default is true.
  - setCloseBottom
```
public final void setCloseBottom(CesiumProperty<Boolean> value)
```
    Sets whether to close the bottom of the extruded region. If not specified, the default is true.
  - getShadows
```
public final CesiumProperty<CesiumShadowMode> getShadows()
```
    Gets whether or not the region casts or receives shadows. If not specified, the default is CesiumShadowMode.DISABLED.
  - setShadows
```
public final void setShadows(CesiumProperty<CesiumShadowMode> value)
```
    Sets whether or not the region casts or receives shadows. If not specified, the default is CesiumShadowMode.DISABLED.
  - getDistanceDisplayCondition
```
public final CesiumProperty<Bounds> getDistanceDisplayCondition()
```
    Gets the distances from the camera at which this region will be displayed. If not specified, the region is displayed regardless of camera distance.
  - setDistanceDisplayCondition
```
public final void setDistanceDisplayCondition(CesiumProperty<Bounds> value)
```
    Sets the distances from the camera at which this region will be displayed. If not specified, the region is displayed regardless of camera distance.
  - getClassificationType
```
public final CesiumProperty<CesiumClassificationType> getClassificationType()
```
    Gets whether a classification affects terrain, 3D Tiles or both. If not specified, the default value is both.
  - setClassificationType
```
public final void setClassificationType(CesiumProperty<CesiumClassificationType> value)
```
    Sets whether a classification affects terrain, 3D Tiles or both. If not specified, the default value is both.
  - getZIndex
```
public final CesiumProperty<Integer> getZIndex()
```
    Gets the z-index of the region, used for ordering ground geometry. Only has an effect if the polygon is constant, and Height (get / set) and ExtrudedHeight (get / set) are not set. If not specified, the default value is 0.
  - setZIndex
```
public final void setZIndex(CesiumProperty<Integer> value)
```
    Sets the z-index of the region, used for ordering ground geometry. Only has an effect if the polygon is constant, and Height (get / set) and ExtrudedHeight (get / set) are not set. If not specified, the default value is 0.

Class CentralBodySurfaceRegionGraphics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getShow

setShow

getArcType

setArcType

getHeight

setHeight

getHeightReference

setHeightReference

getExtrudedHeight

setExtrudedHeight

getExtrudedHeightReference

setExtrudedHeightReference

getSTRotation

setSTRotation

getGranularity

setGranularity

getFill

setFill

getMaterial

setMaterial

getOutline

setOutline

getOutlineColor

setOutlineColor

getOutlineWidth

setOutlineWidth

getCloseTop

setCloseTop

getCloseBottom

setCloseBottom

getShadows

setShadows

getDistanceDisplayCondition

setDistanceDisplayCondition

getClassificationType

setClassificationType

getZIndex

setZIndex