package OCADml

  1. Overview
  2. Docs
Types and functions for building CAD packages in OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

OCADml-0.6.0.tbz
sha256=2d93cd5f2a41c6c0a183c02ac93ed8c4113fbc42d5557c769adbdc30c6421049
sha512=a9450c05bb1b798a70655f76ae04e8a9c46cde0f255687959f1639d9691cd3822e52065014d8cc5d4bd6229057a8036c28d917afdadb283a397fc823cac1fd30

Description

Types and functions for building CAD packages in OCaml

Tags

OCADml CAD

Published: 01 May 2023

README

OCADml

OCADml is a collection of types and functions built on top of Gg facilitating Computer Aided Design (CAD) in OCaml. In particular, the style of design currently supported is that of 2D drawing and mesh generation via sweeping/extrusion.

Usage

  open OCADml

  let () =
    let fn = 128 in
    let base =
      let sq = Path3.square ~center:true (v2 2. 4.) in
      Path3.(roundover ~fn (Round.flat ~corner:(Round.circ (`Radius 0.5)) sq))
    and c r h = Path3.ztrans h @@ Path3.circle ~fn r in
    let cones = List.map (fun h -> [ c 0.6 h; c 0.5 (h +. 1.) ]) [ 4.; 5.; 6. ] in
    List.flatten ([ base; Path3.ztrans 2. base; c 0.5 3.; c 0.5 4. ] :: cones)
    |> Mesh.skin ~slices:(`Flat 0)
    |> Mesh.to_stl "vacuum_connector.stl"

Documentation

Documentation is available online, covering the API. As this library is not associated with any CAD backend, it is a bit dry on it's own and replete of examples. To get a better idea of what can be done with the tools provided it may be helpful to check out a library utilizing them.

CAD Package Specific Frontends

This library only provides a means to generate point and face based geometries, in order to perform boolean operations and validation of properties such as manifoldness you'll need to work with a particular CAD package.

OSCADml

OManifold

Companion PPX

There is a companion ppx, [@@deriving cad] for generating transformation functions for user-defined records and abstract types made up of CAD specific types such as OSCADml's Scad.t, along with their corresponding vector (V2.t or V3.t) types (and those composed of them) provided in this library.

Inspiration

This effort began as an extension of the Scad_ml OpenSCAD DSL, but grew to the point where it seemed prudent to break out into a "backend" agnostic format so as to be more generally useful.

Module organization and implementations borrow heavily from existing libraries in the OpenSCAD community:

Dependencies (3)

  1. gg >= "1.0.0"
  2. dune >= "3.6"
  3. ocaml >= "4.14.0"

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test

Used by (2)

  1. OSCADml >= "0.2.2"
  2. ppx_deriving_cad >= "0.2.0"

Conflicts (1)

  1. cairo2 < "0.6.2"