colour.geometry.primitive_vertices_quad_mpl¶

colour.geometry.primitive_vertices_quad_mpl(width=1, height=1, depth=0, origin=array([0, 0]), axis='+z')[source]¶

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

Parameters

width (numeric, optional) – Quad width.
height (numeric, optional) – Quad height.
depth (numeric, optional) – Quad depth.
origin (array_like, optional) – Quad origin on the construction plane.
axis (array_like, optional) – {‘+z’, ‘+x’, ‘+y’, ‘yz’, ‘xz’, ‘xy’}, Axis the quad will be normal to, or plane the quad will be co-planar with.

Returns

Quad primitive vertices.

Return type

ndarray

Examples

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