docs.rs failed to build cadrum-0.4.4
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: cadrum-0.7.6

cadrum

Rust CAD library powered by OpenCASCADE (OCCT 7.9.3).

Usage

More examples with source code are available at lzpel.github.io/cadrum.

Add this to your Cargo.toml:

[dependencies]
cadrum = "^0.4"

Primitives: box, cylinder, sphere, cone, torus — colored and exported as STEP + SVG. (examples/01_primitives.rs)

cargo run --example 01_primitives

use cadrum::{Color, Shape, Solid};
use glam::DVec3;

fn main() {
    let example_name = std::path::Path::new(file!()).file_stem().unwrap().to_str().unwrap();

    let box_ = Solid::box_from_corners(DVec3::ZERO, DVec3::new(10.0, 20.0, 30.0))
        .color_paint(Some(Color::from_str("#4a90d9").unwrap()));
    let cylinder = Solid::cylinder(DVec3::new(30.0, 0.0, 0.0), 8.0, DVec3::Z, 30.0)
        .color_paint(Some(Color::from_str("#e67e22").unwrap()));
    let sphere = Solid::sphere(DVec3::new(60.0, 0.0, 15.0), 8.0)
        .color_paint(Some(Color::from_str("#2ecc71").unwrap()));
    let cone = Solid::cone(DVec3::new(90.0, 0.0, 0.0), DVec3::Z, 8.0, 0.0, 30.0)
        .color_paint(Some(Color::from_str("#e74c3c").unwrap()));
    let torus = Solid::torus(DVec3::new(130.0, 0.0, 15.0), DVec3::Z, 12.0, 4.0)
        .color_paint(Some(Color::from_str("#9b59b6").unwrap()));

    let shapes = vec![box_, cylinder, sphere, cone, torus];

    let mut f = std::fs::File::create(format!("{example_name}.step")).expect("failed to create file");
    cadrum::write_step_with_colors(&shapes, &mut f).expect("failed to write STEP");

    let svg = shapes.to_svg(DVec3::new(1.0, 1.0, 1.0), 0.5).expect("failed to export SVG");
    std::fs::write(format!("{example_name}.svg"), svg.as_bytes()).expect("failed to write SVG");
}

Full: Make drum with colors, boolean ops, and SVG export, which is shown at the top of this page. (examples/05_chijin.rs)

cargo run --example 05_chijin

Provides safe, ergonomic wrappers around the OCC C++ kernel for:

Reading/writing STEP and BRep formats (stream-based, no temp files)
Constructing primitive shapes (box, cylinder, sphere, cone, torus)
Boolean operations (union, subtract, intersect)
Face/edge topology traversal
Meshing with customizable tolerance
SVG export with hidden-line removal and face colors (color feature)

Requirements

A C++17 compiler (GCC, Clang, or MSVC)
CMake

Tested with GCC 15.2.0 (MinGW-w64) and CMake 3.31.11 on Windows.

Build

By default, cargo build downloads OCCT 7.9.3 source and builds it automatically. The built library is placed in target/occt/ and removed by cargo clean.

To cache the OCCT build across cargo clean, set OCCT_ROOT to a persistent directory:

export OCCT_ROOT=~/occt
cargo build

If OCCT_ROOT is set and the directory already contains OCCT libraries, they are linked directly (no rebuild).
If OCCT_ROOT is set but the directory is empty or missing, OCCT is built and installed there.
To force a rebuild, remove the directory: rm -rf ~/occt

Features

color (default): Colored STEP I/O via XDE (STEPCAFControl). Enables write_step_with_colors, read_step_with_colors, and per-face color on Solid. Colors are preserved through boolean operations and other transformations.

License

This project is licensed under the MIT License.