colour.geometry.primitive_vertices_quad_mpl#

colour.geometry.primitive_vertices_quad_mpl(width: float = 1, height: float = 1, depth: float = 0, origin: ArrayLike = (0, 0), axis: Literal['+z', '+x', '+y', 'yz', 'xz', 'xy'] | str = '+z') → NDArrayFloat[source]#

Generate vertices of a quad primitive for use with Matplotlib mpl_toolkits.mplot3d.art3d.Poly3DCollection class.

Parameters:

  • width (float) – Width of the primitive.

  • height (float) – Height of the primitive.

  • depth (float) – Depth of the primitive.

  • origin (ArrayLike) – Origin of the primitive on the construction plane.

  • axis (Literal['+z', '+x', '+y', 'yz', 'xz', 'xy'] | str) – Axis to which the primitive will be normal, or plane with which the primitive will be co-planar.

Returns:

Quad primitive vertices.

Return type:

numpy.ndarray

Examples

>>> primitive_vertices_quad_mpl()
array([[0., 0., 0.],
       [1., 0., 0.],
       [1., 1., 0.],
       [0., 1., 0.]])