svg3d

Three-dimensional vector rendering software in Python. This primary package contains object primitives (Mesh) and the rendering engine Engine itself.

class svg3d.svg3d.Engine(views, precision=14)

Bases: object

Parameters:

precision (int)

__init__(views, precision=14)

The engine used to render a scene into an image.

Example

> import svg3d > scene = [svg3d.Mesh.example_mesh()] > view = svg3d.View.isometric(scene) > svg3d.Engine([view]).render(“example.svg”) Wrote file “example.svg”

Parameters:

• views (list[View]) – List of View objects to render. Each is rendered into the same image, allowing for composite graphics from multiple viewpoints. For simplicity, a single View object is often best.

• precision (int) – Number of decimal places of precision for numeric quantities in the mesh. Smaller values will reduce file sizes but may result in minor inconsistencies in very small geometries. Default value: 14

property precision

Get or set the rounding precision for vertices of rendered polygons.

Type:

int

render(filename, size=(512, 512), viewbox='-0.5 -0.5 1.0 1.0', **extra)

Render the current view or views to a file.

Parameters:

• filename (str) – The name of the file to save the render to. Should be postfixed with .svg

• size (tuple of int, optional) – Size of the render in pixels. Default is (512, 512).

• viewbox (str, optional) – viewBox attribute for the SVG. Default is “-0.5 -0.5 1.0 1.0”.

• **extra – Additional keyword arguments to be passed into svgwrite.

Raises:

• RuntimeWarning – If all faces of a mesh are pruned due to an incorrect projection matrix.

• RuntimeWarning – If render() is called without any Views to render.

property views

Get or set the list of views to render.

Type:

list[View]

class svg3d.svg3d.Mesh(faces, shader=None, circle_radius=0.0)

Bases: object

Parameters:

• faces (list[ndarray])

• shader (Callable[[int, Self], dict] | None)

• circle_radius (float)

__init__(faces, shader=None, circle_radius=0.0)

Parameters:

• faces (list[ndarray])

• shader (Callable[[int, Self], dict] | None)

• circle_radius (float)

property circle_radius

property faces

Get or set the faces of the Mesh

Type:

np.ndarray

classmethod from_coxeter(poly, shader=None)

Create a Mesh object from a coxeter ConvexPolyhedron.

Parameters:

• poly (coxeter.shapes.ConvexPolyhedron)

• shader (Callable[[int, Self], dict] | None)

classmethod from_vertices_and_faces(vertices, faces, shader=None)

Parameters:

• vertices (ndarray[float])

• faces (list[ndarray[int]])

• shader (Callable[[int, Self], dict] | None)

property normals

Get the normals for the faces of the Mesh.

Type:

np.ndarray

property shader

Get or set the Shader for the Mesh

Type:

Callable