Version:

# Cylinder Shape Component

The Cylinder Shape component creates a transparent cylinder that’s oriented on the local Z axis. The dimensions of the cylinder can be edited with the Height and Radius properties. The Cylinder Shape component is not a mesh, but rather a helper geometry that can be used to define volumes for spawners, shape gradients, audio, vegetation, PhysX, and any application that can utilize the Shape EBus. For more information on using Shape components, see Shape components.

## Provider

O3DE Core (LmbrCentral) Gem

## Cylinder Shape properties

PropertyDescriptionValuesDefault
VisibleEnable to always display the shape in the viewport, even when the entity is not selected. Disable to hide the shape when the entity is not selected.BooleanEnabled
Game ViewEnable to display the shape while in game mode.BooleanDisabled
FilledEnable to display the shape as filled. Disable to display the shape as a wireframe.BooleanEnabled
Shape ColorThe color of the shape.Eight bits per channel color: 0-255255,255,199
HeightThe height of the shape in meters.0.0 to Infinity1.0
RadiusThe radius of the shape in meters.0.0 to Infinity0.5

## CylinderShapeComponentRequestsBus

Use the following request functions with the CylinderShapeComponentRequestsBus EBus interface to communicate with Cylinder Shape components in your game.

Request NameDescriptionParameterReturnScriptable
GetCylinderConfigurationReturns the configuration of the cylinder shape.NoneCylinderShapeConfig object that contains the properties Height and Radius.Yes
SetHeightSets the Height of the cylinder shape.Height: FloatNoneYes
SetRadiusSets the Radius of the cylinder shape.Radius: FloatNoneYes

Refer to Shape component Ebus interface for a description of functions that are available to all Shape components.