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

O3DE Core (LmbrCentral) Gem

Sphere Shape properties

Sphere Shape component 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
RadiusThe radius of the shape in meters.0.0 to Infinity0.5

SphereShapeComponentRequestsBus

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

Request NameDescriptionParameterReturnScriptable
GetSphereConfigurationReturns the configuration of the sphere shape.NoneSphereShapeConfig object that contains the property Radius.Yes
SetRadiusSets the Radius of the sphere shape.Radius: FloatNoneYes

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


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.