White Box Component

The White Box component is a tool you can use to sketch 3D proxy meshes in Open 3D Engine (O3DE) Editor. Add the White Box component to an entity, select a primitive shape to use as a basis for your proxy mesh, then enter edit mode to access the tools to quickly rough out a mesh for your entity.

White Box component interface.

Because White Box is implemented as a component, you can create well-defined entities that accurately represent the size, shape, and function of the final production entity in O3DE Editor before investing the time and effort into building finished models for your entity. Meshes created with White Box can be saved to disk as white box mesh assets (.wbm) and reused in other White Box components. White box meshes can also be exported to .obj files and used as a template in a third-party 3D modeling application to build final production assets.

Provider

White Box Gem

White Box properties

Primitive Shapes

Mesh Asset

PropertyDescriptionValuesDefault
Save as assetChoose this button to save the proxy mesh to a white box mesh (.wbm) asset. You can load the saved (.wbm) asset in other White Box components. The .wbm file functions like an instance, and any changes made to the mesh propagate to all White Box components that use the .wbm file.
ExportChoose the Export button to export the mesh to a .obj file. The .obj file can be loaded into a 3D modeling application and used as a template for creating the production mesh asset for the entity.
Default ShapeThe default primitive shape of the white box mesh. From the list you can select a primitive shape, or choose to load a saved white box mesh (.wbm) asset. The default primitive size is one meter in world space.Cube, Tetrahedron, Icosahedron, Cylinder, Sphere, Custom Mesh AssetCube
Mesh AssetRefer to Mesh Asset properties below.
TintSet a tint color for the white box mesh. Choose the swatch to open a color picker, or enter comma separated red, blue, and green 8-bit values into the field to set a tint color for the White Box component.Eight bits per channel color: 0-255255,255,255
Use TextureEnable Use Texture to display a checkerboard texture on the white box mesh. Each square is a half meter in size, and the texture is projected on the local X, Y, and Z axes of the mesh. This maintains an easy reference for the size of the proxy mesh, regardless of how the entity is oriented in the level.BooleanTrue
VisibleEnable Visible to make the white box mesh visible at runtime. When you use White Box to create custom invisible collision meshes, disable the Visible property to hide the mesh at runtime.BooleanTrue
EditChoose the Edit button to enter Edit mode. In Edit mode, you can modify the white box mesh 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.

Mesh Asset properties

Mesh Asset properties are available only for the Mesh Asset Default Shape type.

PropertyDescriptionValuesDefault
Mesh AssetA pre-existing white box mesh (.wbm) asset to use for the default white box primitive shape.The path to the mesh asset.None

White Box .wbm mesh instancing.

White Box edit mode

In edit mode, you can quickly sketch meshes for your entities in O3DE Editor by selecting and dragging the face, edge, and vertex components of the white box mesh. To begin, add a White Box component to an entity, choose a default primitive shape in the White Box component interface, and choose Edit to enter edit mode.

Move polygon

  1. Hover over a polygon.

  2. Hold the Left Mouse Button.

  3. Drag the polygon along its normal.

    White Box move face.

Move edge

  1. Hover over an edge.

  2. Hold the Left Mouse Button.

  3. Drag the edge.

    White Box move edge.

Move vertex

  1. Hover over a vertex. The vertex will highlight.

  2. Hold the Left Mouse Button.

  3. Drag the vertex along the edge guides.

    White Box move vertex.

Scale polygon

  1. Select a polygon.

  2. Hover over one of the polygon’s vertices.

  3. Hold the Left Mouse Button.

  4. Drag the vertex toward or away from the center of the selected polygon.

    White Box scale face.

Scale edge

  1. Select an edge.

  2. Hover over one of the edge’s vertices.

  3. Hold the Left Mouse Button.

  4. Drag the vertex along the length of the selected edge.

    White Box scale edge.

Non-uniform scale edge

  1. Select an edge.

  2. Hover over one of the edge’s vertices.

  3. Hold Alt and drag the vertex along the length of the selected edge.

    White Box scale edge.

Extrude polygon

  1. Hover over a polygon.

  2. Hold Ctrl + Left Mouse Button.

  3. Drag the polygon along its normal.

    White Box extrude face.

Extrude edge

  1. Hover over an edge.

  2. Hold Ctrl + Left Mouse Button.

  3. Drag the edge.

    White Box extrude edge.

Extrude scale

  1. Select a polygon.

  2. Hover over one of the polygon’s vertices.

  3. Hold Ctrl + Left Mouse Button.

  4. Drag the vertex toward or away from the center of the selected polygon to scale.

  5. Hover over the selected polygon.

  6. Hold the Left Mouse Button.

  7. Drag the polygon along its normal.

    White Box extrude scale.

Flip edge

  1. Hold Ctrl + Shift to show hidden edges.

  2. Right-click on a hidden edge to flip its orientation.

    White Box flip edge.

Hide edge

  1. Select an edge.

  2. Press H.

    White Box hide edge.

Show edge

  1. Hold Ctrl + Shift to show edges.

  2. Select an edge to unhide it.

    White Box extrude edge.

Hide vertex

  1. Select a vertex.

  2. Press H.

    White Box hide edge.

Show vertex

  1. Hold Ctrl + Shift to show hidden vertices.

  2. Select a vertex to unhide it.


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.