Class: EllipseGraphics

EllipseGraphics

new EllipseGraphics(optionsopt)

Describes an ellipse defined by a center point and semi-major and semi-minor axes. The ellipse 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. The center point is determined by the containing Entity.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
semiMajorAxis Property <optional>
 The numeric Property specifying the semi-major axis.
semiMinorAxis Property <optional>
 The numeric Property specifying the semi-minor axis.
height Property <optional>
 0 A numeric Property specifying the altitude of the ellipse relative to the ellipsoid surface.
extrudedHeight Property <optional>
 A numeric Property specifying the altitude of the ellipse's extruded face relative to the ellipsoid surface.
show Property <optional>
 true A boolean Property specifying the visibility of the ellipse.
fill Property <optional>
 true A boolean Property specifying whether the ellipse is filled with the provided material.
material MaterialProperty <optional>
 Color.WHITE A Property specifying the material used to fill the ellipse.
outline Property <optional>
 false A boolean Property specifying whether the ellipse is outlined.
outlineColor Property <optional>
 Color.BLACK A Property specifying the Color of the outline.
outlineWidth Property <optional>
 1.0 A numeric Property specifying the width of the outline.
numberOfVerticalLines Property <optional>
 16 A numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
rotation Property <optional>
 0.0 A numeric property specifying the rotation of the ellipse counter-clockwise from north.
stRotation Property <optional>
 0.0 A numeric property specifying the rotation of the ellipse texture counter-clockwise from north.
granularity Property <optional>
 Cesium.Math.RADIANS_PER_DEGREE A numeric Property specifying the angular distance between points on the ellipse.
shadows Property <optional>
 ShadowMode.DISABLED An enum Property specifying whether the ellipse casts or receives shadows from each light source.
distanceDisplayCondition Property <optional>
 A Property specifying at what distance from the camera that this ellipse will be displayed.
Source:

Members

(readonly) definitionChanged :Event

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

distanceDisplayCondition :Property

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this ellipse will be displayed.
Type:
Source:

extrudedHeight :Property

Gets or sets the numeric Property specifying the altitude of the ellipse extrusion. Setting this property creates volume starting at height and ending at this altitude.
Type:
Source:

fill :Property

Gets or sets the boolean Property specifying whether the ellipse is filled with the provided material.
Type:
Default Value:
  • true
Source:

granularity :Property

Gets or sets the numeric Property specifying the angular distance between points on the ellipse.
Type:
Default Value:
  • {CesiumMath.RADIANS_PER_DEGREE}
Source:

height :Property

Gets or sets the numeric Property specifying the altitude of the ellipse.
Type:
Default Value:
  • 0.0
Source:

material :MaterialProperty

Gets or sets the Property specifying the material used to fill the ellipse.
Type:
Default Value:
  • Color.WHITE
Source:

numberOfVerticalLines :Property

Gets or sets the numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
Type:
Default Value:
  • 16
Source:

outline :Property

Gets or sets the Property specifying whether the ellipse is outlined.
Type:
Default Value:
  • false
Source:

outlineColor :Property

Gets or sets the Property specifying the Color of the outline.
Type:
Default Value:
  • Color.BLACK
Source:

outlineWidth :Property

Gets or sets the numeric Property specifying the width of the outline.
Type:
Default Value:
  • 1.0
Source:

rotation :Property

Gets or sets the numeric property specifying the rotation of the ellipse clockwise from north.
Type:
Default Value:
  • 0
Source:

semiMajorAxis :Property

Gets or sets the numeric Property specifying the semi-major axis.
Type:
Source:

semiMinorAxis :Property

Gets or sets the numeric Property specifying the semi-minor axis.
Type:
Source:

shadows :Property

Get or sets the enum Property specifying whether the ellipse casts or receives shadows from each light source.
Type:
Default Value:
  • ShadowMode.DISABLED
Source:

show :Property

Gets or sets the boolean Property specifying the visibility of the ellipse.
Type:
Default Value:
  • true
Source:

stRotation :Property

Gets or sets the numeric property specifying the rotation of the ellipse texture counter-clockwise from north.
Type:
Default Value:
  • 0
Source:

Methods

clone(resultopt) → {EllipseGraphics}

Duplicates this instance.
Parameters:
Name Type Attributes Description
result EllipseGraphics <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new instance if one was not provided.
Type
EllipseGraphics

merge(source)

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