Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 3.91 KB

box-shape.md

File metadata and controls

50 lines (35 loc) · 3.91 KB
Raw
title linktitle description weight
Box Shape Component
Box Shape
Open 3D Engine (O3DE) Box Shape component reference.
100

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

Box Shape properties

Box Shape component 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
Dimensions The size of the shape in the X, Y and Z dimensions of local space. Vector3: -Infinity to Infinity X:1.0, Y:1.0, Z:1.0
Translation Offset Translation offset of the shape relative to its entity. Vector3: -Infinity to Infinity X:0.0, Y:0.0, Z:0.0
Edit Choose 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

The edit mode provides two sub-modes. You can switch between sub-modes using the buttons in the Viewport UI Cluster in the top left of the Editor, by using the keyboard hotkeys listed below, or by using Ctrl + Mousewheel Up/Down.

Mode Icon Keyboard Hotkey Description
Dimensions Shape component mode dimensions submode icon 1 Left-click and drag the black handles on the sides of the Box Shape to resize the box in its local X, Y, and Z dimensions. By default, each face of the box can be separately edited. Hold Shift to edit opposite pairs of faces symmetrically.
Translation Offset Shape component mode translation offset submode icon 2 Left-click and drag the linear or planar manipulators to edit the Translation Offset.
Reset Current Mode R Resets the properties manipulated by the current sub-mode to their default values.

BoxShapeComponentRequestsBus

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

Request Name Description Parameter Return Scriptable
GetBoxConfiguration Returns the configuration of the box shape. None BoxShapeConfig object that contains the property Dimensions. Yes
GetBoxDimensions Returns the Dimensions of the box shape. None Dimensions: Vector3 Yes
SetBoxDimensions Sets the Dimensions of the box shape. Dimensions: Vector3 None Yes

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