colour.primitive_vertices#

colour.primitive_vertices(method: Literal['Cube MPL', 'Quad MPL', 'Grid MPL', 'Sphere'] | str = 'Cube MPL', **kwargs: Any) → NDArrayFloat[source]#

Generate vertices of a geometry primitive.

Parameters:

method (Literal['Cube MPL', 'Quad MPL', 'Grid MPL', 'Sphere'] | str) – Method for generating primitive vertices.
axis – {colour.geometry.primitive_vertices_quad_mpl(), colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_sphere()}, {‘+z’, ‘+x’, ‘+y’, ‘yz’, ‘xz’, ‘xy’}, Axis to which the primitive will be normal, or plane with which the primitive will be co-planar.
depth – {colour.geometry.primitive_vertices_quad_mpl(), colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl()}, Depth of the primitive.
depth_segments – {colour.geometry.primitive_vertices_cube_mpl()}, Number of depth segments defining quad primitive counts along the depth axis.
height – {colour.geometry.primitive_vertices_quad_mpl(), colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl()}, Height of the primitive.
height_segments – {colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl()}, Number of height segments defining quad primitive counts along the height axis.
intermediate – {colour.geometry.primitive_vertices_sphere()}, Whether to generate sphere vertices at the centres of the faces outlined by the segments of a regular sphere generated without the intermediate argument set to True. The resulting sphere is inscribed within the regular sphere faces while maintaining identical poles.
origin – {colour.geometry.primitive_vertices_quad_mpl(), colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl(), colour.geometry.primitive_vertices_sphere()}, Origin of the primitive on the construction plane.
planes – {colour.geometry.primitive_vertices_cube_mpl()}, {‘-x’, ‘+x’, ‘-y’, ‘+y’, ‘-z’, ‘+z’, ‘xy’, ‘xz’, ‘yz’, ‘yx’, ‘zx’, ‘zy’}, Grid primitives to include in the cube construction.
radius – {colour.geometry.primitive_vertices_sphere()}, Radius of the sphere.
segments – {colour.geometry.primitive_vertices_sphere()}, Number of latitude-longitude segments. If the intermediate argument is True, the sphere will have one fewer segment along its longitude.
width – {colour.geometry.primitive_vertices_quad_mpl(), colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl()}, Width of the primitive.
width_segments – {colour.geometry.primitive_vertices_grid_mpl(), colour.geometry.primitive_vertices_cube_mpl()}, Number of width segments defining quad primitive counts along the width axis.
kwargs (Any)

Returns:

Vertices of the primitive.

Return type:

numpy.ndarray

Examples

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

       [[0., 0., 1.],
        [1., 0., 1.],
        [1., 1., 1.],
        [0., 1., 1.]],

       [[0., 0., 0.],
        [1., 0., 0.],
        [1., 0., 1.],
        [0., 0., 1.]],

       [[0., 1., 0.],
        [1., 1., 0.],
        [1., 1., 1.],
        [0., 1., 1.]],

       [[0., 0., 0.],
        [0., 1., 0.],
        [0., 1., 1.],
        [0., 0., 1.]],

       [[1., 0., 0.],
        [1., 1., 0.],
        [1., 1., 1.],
        [1., 0., 1.]]])
>>> primitive_vertices("Quad MPL")
array([[0., 0., 0.],
       [1., 0., 0.],
       [1., 1., 0.],
       [0., 1., 0.]])
>>> primitive_vertices("Sphere", segments=4)
array([[[ 0.0000000...e+00,  0.0000000...e+00,  5.0000000...e-01],
        [-3.5355339...e-01, -4.3297802...e-17,  3.5355339...e-01],
        [-5.0000000...e-01, -6.1232340...e-17,  3.0616170...e-17],
        [-3.5355339...e-01, -4.3297802...e-17, -3.5355339...e-01],
        [-6.1232340...e-17, -7.4987989...e-33, -5.0000000...e-01]],

       [[ 0.0000000...e+00,  0.0000000...e+00,  5.0000000...e-01],
        [ 2.1648901...e-17, -3.5355339...e-01,  3.5355339...e-01],
        [ 3.0616170...e-17, -5.0000000...e-01,  3.0616170...e-17],
        [ 2.1648901...e-17, -3.5355339...e-01, -3.5355339...e-01],
        [ 3.7493994...e-33, -6.1232340...e-17, -5.0000000...e-01]],

       [[ 0.0000000...e+00,  0.0000000...e+00,  5.0000000...e-01],
        [ 3.5355339...e-01,  0.0000000...e+00,  3.5355339...e-01],
        [ 5.0000000...e-01,  0.0000000...e+00,  3.0616170...e-17],
        [ 3.5355339...e-01,  0.0000000...e+00, -3.5355339...e-01],
        [ 6.1232340...e-17,  0.0000000...e+00, -5.0000000...e-01]],

       [[ 0.0000000...e+00,  0.0000000...e+00,  5.0000000...e-01],
        [ 2.1648901...e-17,  3.5355339...e-01,  3.5355339...e-01],
        [ 3.0616170...e-17,  5.0000000...e-01,  3.0616170...e-17],
        [ 2.1648901...e-17,  3.5355339...e-01, -3.5355339...e-01],
        [ 3.7493994...e-33,  6.1232340...e-17, -5.0000000...e-01]]])

colour.primitive_vertices#

This Page