Quad Shape Component

The Quad Shape component creates a transparent square plane that’s oriented on the local Z axis. The dimensions of the quad can be edited with the Width and Height properties. The Quad 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

Quad Shape properties

Quad 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
Shape ColorThe color of the shape.Eight bits per channel color: 0-255255,255,199
WidthThe width of the shape in meters on the local X axis.0.0 to Infinity1.0
HeightThe height of the shape in meters on the local Y axis.0.0 to Infinity1.0

QuadShapeComponentRequestsBus

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

Request NameDescriptionParameterReturnScriptable
GetQuadConfigurationReturns the configuration of the quad shape.NoneLmbrCentral_QuadShapeConfig object that contains the properties Height and Width.Yes
GetQuadHeightReturns the Height of the quad shape.NoneHeight: FloatYes
GetQuadOrientationReturns the orientation of the quad shape.NoneOrientation: QuaternionYes
GetQuadWidthReturns the Width of the quad shape.NoneWidth: FloatYes
SetQuadHeightSets the Height of the quad shape.Height: FloatNoneYes
SetQuadWidthSets the Width of the quad shape.Width: FloatNoneYes

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