package OSCADml
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=406e45c5df8122e8b065342e10ba9deb7a066683b256619462c405da69ba5baa
sha512=20db4192d6204d9fd5914562ec83d8edbbb1f5c89a72e61928bf662fdcc9ecea38760b26c99af801ddfc5b877c451ad11c16fc89a6a36ef8c20881375627295b
README.md.html
OpenSCAD DSL for OCaml
Overview
In conjunction with OCADml, this library provides an OCaml front-end to the OpenSCAD solid modelling language. All SCAD primitives and transformation functions are made available.
Notable differences from the OpenSCAD language
Angles are represented in radians (and converted to degrees when compiling to OpenSCAD).
linear_extrude
androtate_extrude
have been renamed toextrude
andrevolve
The dimensional system (2D or 3D) each shape inhabits is tracked by the type system. This is used to restrict the operations that can be legally applied (e.g. 2D shapes cannot be moved off of the xy plane,
extrude
can only be applied to 2D shapes) and enforcing non-mixing of 2D and 3D shapes during boolean operations.
Usage
open OCADml
open OSCADml
let () =
let scad_logo =
let rad = 5.
and fn = 720 in
let cyl = Scad.cylinder ~fn ~center:true ~height:(rad *. 2.3) (rad /. 2.) in
let cross_cyl = Scad.rotate (v3 0. (Float.pi /. 2.) 0.) cyl in
Scad.union
[ Scad.difference
(Scad.sphere ~fn rad)
[ cyl; cross_cyl; Scad.rotate (v3 0. 0. (Float.pi /. 2.)) cross_cyl ]
; Scad.color ~alpha:0.25 Color.Magenta cross_cyl
]
in
Scad.to_file "scad_logo.scad" scad_logo
Generated scads can then be viewed with the OpenSCAD viewer as you normally would.
Documentation
Documentation for OSCADml is available online and offline via odig, covering the API as well as some walkthrough style examples. Referring to the manual for OCADml is also likely to be helpful.
Companion PPX
There is a companion ppx, [@@deriving cad] for generating transformation functions for user-defined records and abstract types made up of the Scad.t
, along with their corresponding vector (V2.t
or V3.t
) types (and those composed of them) provided in the OCADml library.
Generating models on write
For a more pleasant modelling experience, it is highly recommended to setup dune to automate writing your models to file whenever the source files are saved. To do so, add a dune rule that runs your projects executable after it is built. For example, in your_project/bin/dune
:
(executable
(public_name your_project)
(name main)
(libraries OCADml OSCADml))
(rule
(alias model)
(action
(run your_project)))
Then start dune
in watch mode with dune build -w @model
.