org.cesiumjs.cs.datasources.graphics

Class PolygonGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.PolygonGraphics

@JsType(isNative=true,
        namespace="Cesium",
        name="PolygonGraphics")
public class PolygonGraphics
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	classificationType Gets or sets the ClassificationType Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground.
boolean	closeTop When false, leaves off the top of an extruded polygon open.
Property	distanceDisplayCondition A Property specifying at what distance from the camera that this polygon will be displayed.
Property	extrudedHeight A numeric Property specifying the altitude of the polygon's extruded face relative to the ellipsoid surface.
Property	extrudedHeightReference Gets or sets the Property specifying the extruded HeightReference.
Property	fill A boolean Property specifying whether the polygon is filled with the provided material.
Property	granularity A numeric Property specifying the angular distance between each latitude and longitude point.
Property	height A numeric Property specifying the altitude of the polygon relative to the ellipsoid surface.
Property	heightReference Gets or sets the Property specifying the HeightReference.
Property	hierarchy A Property specifying the PolygonHierarchy.
MaterialProperty	material A Property specifying the material used to fill the polygon.
Property	outline A boolean Property specifying whether the polygon is outlined.
Property	outlineColor A Property specifying the Color of the outline.
Property	outlineWidth A numeric Property specifying the width of the outline.
Property	perPositionHeight A boolean specifying whether or not the the height of each position is used.
Property	shadows An enum Property specifying whether the polygon casts or receives shadows from each light source.
Property	show A boolean Property specifying the visibility of the polygon.
Property	stRotation A numeric property specifying the rotation of the polygon texture counter-clockwise from north.
ConstantProperty<Integer>	zIndex A property specifying the zIndex used for ordering ground geometry.

Constructor Summary

Constructors

Constructor and Description
PolygonGraphics(PolygonGraphicsOptions options) Describes a polygon defined by an hierarchy of linear rings which make up the outer shape and any nested holes.

Method Summary

Modifier and Type	Method and Description
PolygonGraphics	clone(PolygonGraphics result) Duplicates this instance.
Event	definitionChanged() Gets the event that is raised whenever a property or sub-property is changed or modified.
void	merge(PolygonGraphics source) Assigns each unassigned property on this object to the value of the same property on the provided source object.

Methods inherited from class java.lang.Object

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

Field Detail

classificationType

@JsProperty
public Number classificationType

Gets or sets the ClassificationType Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground. Default: ClassificationType.TERRAIN().

hierarchy

@JsProperty
public Property hierarchy

A Property specifying the PolygonHierarchy.

height

@JsProperty
public Property height

A numeric Property specifying the altitude of the polygon relative to the ellipsoid surface. Default: 0

heightReference

@JsProperty
public Property heightReference

Gets or sets the Property specifying the HeightReference. Default: HeightReference.NONE()

extrudedHeight

@JsProperty
public Property extrudedHeight

A numeric Property specifying the altitude of the polygon's extruded face relative to the ellipsoid surface.

extrudedHeightReference

@JsProperty
public Property extrudedHeightReference

Gets or sets the Property specifying the extruded HeightReference. Default: HeightReference.NONE()

show

@JsProperty
public Property show

A boolean Property specifying the visibility of the polygon. Default: true

fill

@JsProperty
public Property fill

A boolean Property specifying whether the polygon is filled with the provided material. Default: true

material

@JsProperty
public MaterialProperty material

A Property specifying the material used to fill the polygon. Default: Color.WHITE()

outline

@JsProperty
public Property outline

A boolean Property specifying whether the polygon is outlined. Default: false

outlineColor

@JsProperty
public Property outlineColor

A Property specifying the Color of the outline. Default: Color.BLACK()

outlineWidth

@JsProperty
public Property outlineWidth

A numeric Property specifying the width of the outline. Default: 1.0

stRotation

@JsProperty
public Property stRotation

A numeric property specifying the rotation of the polygon texture counter-clockwise from north. Default: 0.0

granularity

@JsProperty
public Property granularity

A numeric Property specifying the angular distance between each latitude and longitude point. Default: Math.RADIANS_PER_DEGREE()

perPositionHeight

@JsProperty
public Property perPositionHeight

A boolean specifying whether or not the the height of each position is used. Default: false

closeTop

@JsProperty
public boolean closeTop

When false, leaves off the top of an extruded polygon open. Default: true

shadows

@JsProperty
public Property shadows

An enum Property specifying whether the polygon casts or receives shadows from each light source. Default: ShadowMode.DISABLED()

distanceDisplayCondition

@JsProperty
public Property distanceDisplayCondition

A Property specifying at what distance from the camera that this polygon will be displayed.

zIndex

@JsProperty
public ConstantProperty<Integer> zIndex

A property specifying the zIndex used for ordering ground geometry. Only has an effect if the polygon is constant and neither height or extrudedHeight are specified. Default: 0

Constructor Detail

PolygonGraphics

@JsConstructor
public PolygonGraphics(PolygonGraphicsOptions options)

Describes a polygon defined by an hierarchy of linear rings which make up the outer shape and any nested holes. The polygon conforms to the curvature of the globe and can be placed on the surface or at altitude and can optionally be extruded into a volume.

Parameters:

options - Options

Method Detail

definitionChanged

@JsProperty(name="definitionChanged")
public Event definitionChanged()

Gets the event that is raised whenever a property or sub-property is changed or modified.

clone

@JsMethod
public PolygonGraphics clone(@JsOptional
                                       PolygonGraphics result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new instance if one was not provided.

merge

@JsMethod
public void merge(PolygonGraphics source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Parameters:

source - The object to be merged into this object.