Axis Aligned Box Shape Component

The Axis Aligned Box Shape component creates a transparent box that is always axis aligned. The dimensions of the box can be edited with the Dimensions property or by entering edit mode. The Axis Aligned Box Shape component is not a mesh, but rather a helper geometry that can be used to define volumes for terrain, fog, 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

Axis Aligned Box Shape properties

Axis Aligned Box 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
DimensionsThe size of the shape in the X, Y and Z dimensions of local space.Vector3: -Infinity to InfinityX:1.0, Y:1.0, Z:1.0
EditChoose the Edit button to enter Edit mode. In Edit mode, you can modify the dimensions of the shape in the viewport using the methods outlined in Edit mode actions below. While in Edit mode, the Edit menu in the menu bar displays available actions and hotkeys. To exit Edit mode, choose Done in the component interface.

Edit mode actions

  • Left-click and drag the black handles on the sides of the Axis Aligned Box Shape to resize the box in its local X, Y, and Z dimensions.

BoxShapeComponentRequestsBus

Use the following request functions with the BoxShapeComponentRequestsBus EBus interface to communicate with Axis Aligned Box Shape components in your game.

Request NameDescriptionParameterReturnScriptable
GetBoxConfigurationReturns the configuration of the box shape.NoneBoxShapeConfiguration object that contains the property Dimensions.Yes
GetBoxDimensionsReturns the Dimensions of the box shape.NoneDimensions: Vector3Yes
SetBoxDimensionsSets the Dimensions of the box shape.Dimensions: Vector3NoneYes

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