cadquery:vtk

Examples of the cadquery:vtk directive.

Development Status

Development Status:: 2 - Pre-Alpha

This directive is experimental.

cadquery:vtk is based on the docutils “figure” directive having similar features and syntax:

The model may be captioned.
Notes may be added below the code block.
Models may be referenced by name: color example.

The model source code is defined in either a code-block or literalinclude, meaning:

All options for code-block or literalinclude may be used such as code-block:linenos and code-block:emphasize-lines.
Model source code blocks may be referenced by name: CadQuery source code for a rectangular plate.

Tip

View the reStructuredText source of this page by following the View page source link in the header.

Simple rectangular plate

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery as cq

result = cadquery.Workplane().box(2, 2, 0.5)

Notes:

Line numbers are added with linenos.
Line number 5 is emphasized with emphasize-lines.

Assembly

An assembly of two cones.

cone = cq.Solid.makeCone(1, 0, 2)

assembly = cq.Assembly()
assembly.add(
    cone,
    loc=cq.Location((0, 0, 0), (1, 0, 0), 180),
    name="cone0",
    color=cq.Color("green"),
)
assembly.add(cone, name="cone1", color=cq.Color("blue"))

show_object(assembly)

Sketch

A sketch.

import cadquery as cq

result = (
    cq.Sketch()
    .trapezoid(4, 3, 90)
    .vertices()
    .circle(0.5, mode="s")
    .reset()
    .vertices()
    .fillet(0.25)
    .reset()
    .rarray(0.6, 1, 5, 1)
    .slot(1.5, 0.4, mode="s", angle=90)
)

Source from file

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery

result = cadquery.Workplane().box(2, 2, 0.5)

Content variations

Code block: without caption or source

Code block: with both caption and source

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery as cq

result = cadquery.Workplane().box(2, 2, 0.5)

Code block: with caption, source, and notes

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery as cq

result = cadquery.Workplane().box(2, 2, 0.5)

Notes may follow the code-block.

The model source code is loaded from a code-block directive.
The model is captioned.
The model source code is displayed.
These are notes.

Source from file: without caption or source

Source from file: with both caption and source

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery

result = cadquery.Workplane().box(2, 2, 0.5)

Source from file: with caption, source, and notes

A simple rectangular plate measuring 2 × 2 × 0.5 mm.

"""Simple rectangular plate."""

import cadquery

result = cadquery.Workplane().box(2, 2, 0.5)

Notes may follow the literalinclude.

Material:: stainless steel
Finish:: brushed

Options

Default color

The color option defines the default color of VTK.js render.

Default color set to 0.5, 1, 0.8, 1.

result = cadquery.Workplane().box(2, 2, 0.5)