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:
|
Members
-
bottomRadius : Property
-
Gets or sets the numeric Property specifying the radius of the bottom of the cylinder.
-
readonlydefinitionChanged : Event
-
Gets the event that is raised whenever a property or sub-property is changed or modified.
-
distanceDisplayCondition : Property
-
Gets or sets the
DistanceDisplayCondition
Property specifying at what distance from the camera that this cylinder will be displayed. -
fill : Property
-
Gets or sets the boolean Property specifying whether the cylinder is filled with the provided material.
-
Default Value:
true
-
length : Property
-
Gets or sets the numeric Property specifying the length of the cylinder.
-
material : MaterialProperty
-
Gets or sets the Property specifying the material used to fill the cylinder.
-
Default Value:
Color.WHITE
-
numberOfVerticalLines : Property
-
Gets or sets the Property specifying the number of vertical lines to draw along the perimeter for the outline.
-
Default Value:
16
-
outline : Property
-
Gets or sets the boolean Property specifying whether the cylinder is outlined.
-
Default Value:
false
-
outlineColor : Property
-
Gets or sets the Property specifying the
Color
of the outline.-
Default Value:
Color.BLACK
-
outlineWidth : Property
-
Gets or sets the numeric Property specifying the width of the outline.
-
Default Value:
1.0
-
shadows : Property
-
Get or sets the enum Property specifying whether the cylinder casts or receives shadows from each light source.
-
Default Value:
ShadowMode.DISABLED
-
show : Property
-
Gets or sets the boolean Property specifying the visibility of the cylinder.
-
Default Value:
true
-
slices : Property
-
Gets or sets the Property specifying the number of edges around the perimeter of the cylinder.
-
Default Value:
128
-
topRadius : Property
-
Gets or sets the numeric Property specifying the radius of the top of the cylinder.
Methods
-
clone(result) → CylinderGraphics
-
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. -
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.