Class: EllipseGraphics

EllipseGraphics

new EllipseGraphics(options)

Create ellipses or circles on the three-dimensional surface of the Earth or in the air

An ellipse is defined by a center point, a semi major axis length, and a semi minor axis length. Ellipses can conform to the curvature of the Earth, be placed on the surface, at a certain height, or be squeezed out of a certain volume. The center point is defined by Entity.

Name Type Description
options Object optional

Object is an object that contains the following properties:

Name Type Default Description
show Property true optional

Boolean attribute, used to specify the visibility of an ellipse.

semiMajorAxis Property optional

The number attribute specifies the semi major axis length of the ellipse.

semiMinorAxis Property optional

The number attribute specifies the semi minor axis length of the ellipse.

height Property 0 optional

The number attribute specifies the height of the ellipse relative to the surface of the ellipsoid.

heightReference Property HeightReference.NONE optional

The HeightReference property specifies the reference point for the height.

extrudedHeight Property optional

The number attribute specifies the height of the extruded surface of the ellipse relative to the surface of the ellipsoid.

extrudedHeightReference Property HeightReference.NONE optional

The HeightReference property specifies the reference point for extradedHeight.

rotation Property 0.0 optional

The number attribute specifies the angle at which the ellipse rotates counterclockwise from north.

stRotation Property 0.0 optional

The number attribute specifies the angle at which the elliptical texture rotates counterclockwise from north.

granularity Property SuperMap3D.Math.RADIANS_PER_DEGREE optional

The number attribute specifies the angular distance of each point on the ellipse.

fill Property true optional

Boolean property, specifying whether to fill the ellipse with the provided material.

material MaterialProperty Color.WHITE optional

The MaterialProperty property specifies the material used to fill the ellipse.

outline Property false optional

Boolean property, used to specify whether to display the outline of an ellipse.

outlineColor Property Color.BLACK optional

The Color property specifies the color of the elliptical contour line.

outlineWidth Property 1.0 optional

The number attribute specifies the width of the elliptical outline.

numberOfVerticalLines Property 16 optional

The number attribute specifies the number of vertical lines drawn along the circumference of the ellipse.

shadows Property ShadowMode.DISABLED optional

Enumeration properties used to specify whether an ellipse casts or receives shadows from each light source. *The @ param {Property} [options. distanceDisplay Condition] property specifies how far the ellipse should be displayed from the camera.

classificationType Property ClassificationType.BOTH optional

The ClassityType property specifies whether the ellipse classifies terrain, 3DTile, or both.

zIndex ConstantProperty 0 optional

Attribute, used to specify the zIndex of the ellipse, which is used to sort the grounded geometry. This value only takes effect if EllipseGraphics # height and EllipseGraphics # extradedHeight are not specified and the rectangle is static.

Members

classificationTypeProperty

Get or set the ClassityType property, specifying whether the ellipse classifies terrain, 3DTile, or both.

Default Value:
ClassificationType.BOTH

readonly definitionChangedEvent

Get events. This event is thrown when the value of a property or sub property is modified, or when the definition is modified.

distanceDisplayConditionProperty

Get or set the DistanceDisplayCondition property to specify how far the ellipse should be displayed from the camera.

extrudedHeightProperty

Get or set the number property to specify the height of the ellipse extrusion. After setting this attribute, an individual will be created. The body starts from EllipseGraphics # height and ends at EllipseGraphics # extradedHeight.

extrudedHeightReferenceProperty

Gets or sets the HeightReference property, which specifies the reference point for the extrusion height.

Default Value:
HeightReference.NONE

fillProperty

Gets or sets the boolean property, specifying whether to fill the ellipse with the provided material.

Default Value:
true

granularityProperty

Get or set the number property to specify the angular distance of each point on the ellipse.

Default Value:
{CesiumMath.RADIANS_PER_DEGREE}

heightProperty

Get or set the number property to specify the height of the ellipse.

Default Value:
0.0

heightReferenceProperty

Get or set the HeightReference property

Default Value:
HeightReference.NONE

Get or set the MaterialProperty property to specify the material used to fill the ellipse.

Default Value:
Color.WHITE

numberOfVerticalLinesProperty

Get or set the number property to specify the number of vertical lines drawn along the circumference of the ellipse.

Default Value:
16

outlineProperty

Gets or sets Boolean properties to specify whether to display elliptical contours.

Default Value:
false

outlineColorProperty

Get or set the Color property to specify the color of the contour.

Default Value:
Color.BLACK

outlineWidthProperty

Get or set the number property to specify the contour width.

Default Value:
1.0

rotationProperty

Get or set the number property to specify the angle at which the ellipse rotates clockwise from north.

Default Value:
0

semiMajorAxisProperty

Get or set the numerical property of the specified semi major axis.

semiMinorAxisProperty

Get or set the numerical properties of the specified half axis.

shadowsProperty

Gets or sets enumeration properties to specify whether the ellipse casts or receives shadows from each light source.

Default Value:
ShadowMode.DISABLED

showProperty

Gets or sets the boolean property to specify the visibility of the ellipsoid.

Default Value:
true

stRotationProperty

Get or set the number property to specify the angle at which the elliptical texture rotates counterclockwise from north.

Default Value:
0

Get or set the number property to specify the zIndex of the ellipse, which is used to sort the grounded geometry. This value only takes effect if EllipseGraphics # height and EllipseGraphics # extradedHeight are not specified and the rectangle is static.

Default Value:
0

Methods

clone(result){EllipseGraphics}

Copy instance

Name Type Description
result EllipseGraphics optional

The object that stores the copied results

Returns:
Type Description
EllipseGraphics If input parameters are provided, return the modified input parameter object. If no input parameters are provided, return a new instance.

merge(source)

Assign the attribute values corresponding to the source object to all unspecified attributes of this instance.

Name Type Description
source EllipseGraphics

An object that provides attribute values.