Disk Shape Component

The Disk Shape component creates a transparent circular surface that’s oriented on the local Z axis. The dimensions of the disk can be edited with the Radius property. The Disk Shape component is not a mesh, but rather a helper geometry that can be used to define areas for area lights, 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

Disk Shape properties

Disk 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

DiskShapeComponentRequestsBus

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

Request NameDescriptionParameterReturnScriptable
GetDiskConfigurationReturns the configuration of the disk shape.NoneDiskShapeConfig object that contains the property Radius.Yes
GetRadiusReturns the Radius of the disk shape.NoneRadius: FloatYes
SetRadiusSets the Radius of the disk 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.