CylinderGraphics

new Cesium.CylinderGraphics(options)
DataSources/CylinderGraphics.js 41

Describes a cylinder, truncated cone, or cone defined by a length, top radius, and bottom radius. The center position and orientation are determined by the containing Entity.

Name Type Description

options

Object

optional Object with the following properties:

Name	Type	Default	Description
`length`	Property		optional A numeric Property specifying the length of the cylinder.
`topRadius`	Property		optional A numeric Property specifying the radius of the top of the cylinder.
`bottomRadius`	Property		optional A numeric Property specifying the radius of the bottom of the cylinder.
`show`	Property	`true`	optional A boolean Property specifying the visibility of the cylinder.
`fill`	Property	`true`	optional A boolean Property specifying whether the cylinder is filled with the provided material.
`material`	MaterialProperty	`Color.WHITE`	optional A Property specifying the material used to fill the cylinder.
`outline`	Property	`false`	optional A boolean Property specifying whether the cylinder is outlined.
`outlineColor`	Property	`Color.BLACK`	optional A Property specifying the `Color` of the outline.
`outlineWidth`	Property	`1.0`	optional A numeric Property specifying the width of the outline.
`numberOfVerticalLines`	Property	`16`	optional A numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
`slices`	Property	`128`	optional The number of edges around the perimeter of the cylinder.
`shadows`	Property	`ShadowMode.DISABLED`	optional An enum Property specifying whether the cylinder casts or receives shadows from each light source.
`distanceDisplayCondition`	Property		optional A Property specifying at what distance from the camera that this cylinder will be displayed.

Members

bottomRadius : Property DataSources/CylinderGraphics.js 106

Gets or sets the numeric Property specifying the radius of the bottom of the cylinder.

readonlydefinitionChanged : Event DataSources/CylinderGraphics.js 81

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

distanceDisplayCondition : Property DataSources/CylinderGraphics.js 186

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this cylinder will be displayed.

fill : Property DataSources/CylinderGraphics.js 146

Gets or sets the boolean Property specifying whether the cylinder is filled with the provided material.

Default Value: true

length : Property DataSources/CylinderGraphics.js 92

Gets or sets the numeric Property specifying the length of the cylinder.

material : MaterialProperty DataSources/CylinderGraphics.js 138

Gets or sets the Property specifying the material used to fill the cylinder.

Default Value: Color.WHITE

numberOfVerticalLines : Property DataSources/CylinderGraphics.js 114

Gets or sets the Property specifying the number of vertical lines to draw along the perimeter for the outline.

Default Value: 16

outline : Property DataSources/CylinderGraphics.js 154

Gets or sets the boolean Property specifying whether the cylinder is outlined.

Default Value: false

outlineColor : Property DataSources/CylinderGraphics.js 162

Gets or sets the Property specifying the Color of the outline.

Default Value: Color.BLACK

outlineWidth : Property DataSources/CylinderGraphics.js 170

Gets or sets the numeric Property specifying the width of the outline.

Default Value: 1.0

shadows : Property DataSources/CylinderGraphics.js 179

Get or sets the enum Property specifying whether the cylinder casts or receives shadows from each light source.

Default Value: ShadowMode.DISABLED

show : Property DataSources/CylinderGraphics.js 130

Gets or sets the boolean Property specifying the visibility of the cylinder.

Default Value: true

slices : Property DataSources/CylinderGraphics.js 122

Gets or sets the Property specifying the number of edges around the perimeter of the cylinder.

Default Value: 128

topRadius : Property DataSources/CylinderGraphics.js 99

Gets or sets the numeric Property specifying the radius of the top of the cylinder.

Methods

clone(result) → CylinderGraphics DataSources/CylinderGraphics.js 195

Duplicates this instance.

Name	Type	Description
`result`	CylinderGraphics	optional The object onto which to store the result.

Returns:

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

merge(source) DataSources/CylinderGraphics.js 221

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

Name	Type	Description
`source`	CylinderGraphics	The object to be merged into this object.