IN THIS ARTICLE
Sphere Shape Component
The Sphere Shape component creates a transparent sphere. The dimensions of the sphere can be edited with the Radius property. The Sphere Shape component is not a mesh, but rather a helper geometry that can be used to define volumes for area lights, 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
Sphere Shape properties
| Property | Description | Values | Default |
|---|---|---|---|
| Visible | Enable 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. | Boolean | Enabled |
| Game View | Enable to display the shape while in game mode. | Boolean | Disabled |
| Filled | Enable to display the shape as filled. Disable to display the shape as a wireframe. | Boolean | Enabled |
| Shape Color | The color of the shape. | Eight bits per channel color: 0-255 | 255,255,199 |
| Radius | The radius of the shape in meters. | 0.0 to Infinity | 0.5 |
SphereShapeComponentRequestsBus
Use the following request functions with the SphereShapeComponentRequestsBus EBus interface to communicate with Sphere Shape components in your game.
| Request Name | Description | Parameter | Return | Scriptable |
|---|---|---|---|---|
GetSphereConfiguration | Returns the configuration of the sphere shape. | None | SphereShapeConfig object that contains the property Radius. | Yes |
SetRadius | Sets the Radius of the sphere shape. | Radius: Float | None | Yes |
Refer to Shape component Ebus interface for a description of functions that are available to all Shape components.