Class: CylinderGraphics

CylinderGraphics

new CylinderGraphics(options)

Create the center position and orientation of cylinders, cones, or frustums in the Entity definition.

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 the Cylinder.

length Property optional

The number attribute specifies the length of the Cylinder.

topRadius Property optional

The number attribute specifies the radius length of the top of the Cylinder.

bottomRadius Property optional

The number attribute specifies the radius length of the bottom of the Cylinder.

heightReference Property HeightReference.NONE optional

The HeightReference property specifies the reference point for the height.

material MaterialProperty Color.WHITE optional

Material properties, specifying the material used to fill the Cylinder.

outline Property false optional

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

outlineColor Property Color.BLACK optional

The Color property specifies the contour color of the Cylinder.

outlineWidth Property 1.0 optional

The number attribute specifies the width of the Cylinder outline.

numberOfVerticalLines Property 16 optional

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

slices Property 128 optional

The number attribute specifies the number of edges around the Cylinder.

shadows Property ShadowMode.DISABLED optional

Enumeration properties used to specify whether Cylinder projects shadows from each light source or receives shadows.

distanceDisplayCondition Property optional

Attribute, specifying how far the Cylinder should be displayed from the camera.

Members

bottomRadiusProperty

Get or set the number property to specify the radius length at the bottom of the Cylinder.

readonly definitionChangedEvent

The event triggered when a property or sub property is changed or modified.

distanceDisplayConditionProperty

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

fillProperty

Get or set boolean property to specify whether to fill the Cylinder with the provided material.

Default Value:
true

heightReferenceProperty

Get or set the HeightReference property.

Default Value:
HeightReference.NONE

lengthProperty

Get or set the number property to specify the length of the Cylinder.

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

Default Value:
Color.WHITE

numberOfVerticalLinesProperty

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

Default Value:
16

outlineProperty

Gets or sets the boolean property to specify whether to display the Cylinder outline.

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

shadowsProperty

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

Default Value:
ShadowMode.DISABLED

showProperty

Get or set boolean property to specify the visibility of the cylinder.

Default Value:
true

slicesProperty

Get or set the number property to specify the number of edges around the Cylinder.

Default Value:
128

topRadiusProperty

Get or set the number property to specify the radius length at the top of the Cylinder.

Methods

clone(result){CylinderGraphics}

Copy this instance.

Name Type Description
result CylinderGraphics optional

The object that stores the results.

Returns:
Type Description
CylinderGraphics The modified result parameters, or a new instance (if not provided).

merge(source)

Assign each unspecified property on this object to the value of the same property on the provided source object.

Name Type Description
source CylinderGraphics

An object that provides attribute values.