box

m3sh.vis.box(a, b, opacity=1.0, edges=True, color=(1.0, 0.9804, 0.9804))[source]

Box shape.

Display the cuboid \(Q = [a_x, b_x] \times [a_y, b_y] \times [a_z, b_z]\).

Parameters:

  • a (array_like, shape (3, )) – Min corner of the box.

  • b (array_like, shape (3, )) – Max corner of the box.

  • opacity (float, optional) – Opacity of box.

  • edges (bool, optional) – Toggle edges of the box.

  • color (array_like, shape (3, ), optional) – RGB color triplet.

Returns:

The corresponding polygonal shape representation.

Return type:

PolyMesh

Note

Visual properties of the box edges can be further customized via the returned PolyMesh instance.