Class: EllipsoidGraphics

EllipsoidGraphics

new EllipsoidGraphics(options)

Creates an ellipsoid or sphere class.

The position and orientation are defined by the 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 ellipsoids.
radii Property optional

Cartesian3 attribute, specifying the radius of the ellipsoid.
innerRadii Property optional

Cartesian3 attribute, specifying the inner radius of the ellipsoid.
minimumClock Property 0.0 optional

The number attribute specifies the minimum clock angle of the ellipsoid.
maximumClock Property 2*PI optional

The number attribute specifies the minimum clock angle of the ellipsoid.
minimumCone Property 0.0 optional

The number attribute specifies the minimum cone angle of the ellipsoid.
maximumCone Property PI optional

The number attribute specifies the maximum cone angle of the ellipsoid.
heightReference Property HeightReference.NONE optional

The HeightReference property specifies the reference point for the height of the Entity.
fill Property true optional

Boolean property, specifying whether to fill the ellipsoid with the provided material.
material MaterialProperty Color.WHITE optional

The MaterialProperty property specifies the material used to fill the ellipsoid.
outline Property false optional

Boolean property, used to specify whether to display the outline of an ellipsoid.
outlineColor Property Color.BLACK optional

The Color property specifies the color of the ellipsoidal contour line.
outlineWidth Property 1.0 optional

The number attribute specifies the width of the ellipsoidal contour line.
stackPartitions Property 64 optional

The number attribute specifies the number of stacks.
slicePartitions Property 64 optional

The number attribute specifies the number of radial slices.
subdivisions Property 128 optional

The number attribute specifies the number of samples for each contour ring and determines the granularity of curvature.
shadows Property ShadowMode.DISABLED optional

Enumeration properties used to specify whether the ellipsoid casts or receives shadows from each light source.
distanceDisplayCondition Property optional

Attribute, specifying how far the ellipsoid is displayed from the camera.

Members

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 ellipsoid is displayed from the camera.

fillProperty

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

Default Value:
true

heightReferenceProperty

Get or set the HeightReference property.

Default Value:
HeightReference.NONE

innerRadiiProperty

Get or set the Cartesian3 property to specify the inner radius of the ellipsoid.

Default Value:
radii

materialMaterialProperty

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

Default Value:
Color.WHITE

maximumClockProperty

Get or set the number property to specify the maximum clock angle of the ellipsoid.

Default Value:
2*PI

maximumConeProperty

Get or set the number property to specify the maximum cone angle of the ellipsoid.

Default Value:
PI

minimumClockProperty

Get or set the number property to specify the minimum clock angle of the ellipsoid.

Default Value:
0.0

minimumConeProperty

Get or set the number property to specify the minimum cone angle of the ellipsoid.

Default Value:
0.0

outlineProperty

Gets or sets the boolean property to specify whether to display the outline of an ellipsoid.

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

radiiProperty

Get or set the Cartesian3 property to specify the radius of the ellipsoid.

shadowsProperty

Gets or sets enumeration properties to specify whether the ellipsoid 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

slicePartitionsProperty

Get or set the number property to specify the number of radial slices.

Default Value:
64

stackPartitionsProperty

Get or set the number property to specify the number of stacks.

Default Value:
64

subdivisionsProperty

Get or set the number property, specify the number of samples for each contour ring, and determine the granularity of curvature.

Default Value:
128

Methods

clone(result){CorridorGraphics}

Copy instance

Name Type Description
result CorridorGraphics optional

The object that stores the copied results
Returns:
Type Description
CorridorGraphics 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 CorridorGraphics

An object that provides attribute values.