scad-ml's Introduction

OpenSCAD DSL for OCaml

Overview

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).
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. linear_extrude can only be applied to 2D shapes) and enforcing non-mixing of 2D and 3D shapes during boolean operations.

Usage

open Scad_ml

let scad_logo =
  let rad = 5.
  and fn = 720 in
  let cyl = Scad.cylinder ~fn ~center:true (rad /. 2.) (rad *. 2.3) in
  let cross_cyl = Scad.rotate (0., Float.pi /. 2., 0.) cyl in
  Scad.union
    [ Scad.difference
        (Scad.sphere ~fn rad)
        [ cyl; cross_cyl; Scad.rotate (0., 0., Float.pi /. 2.) cross_cyl ]
    ; Scad.color ~alpha:0.25 Color.Magenta cross_cyl
    ]

let () =
  let oc = open_out "/path/to/things/scad_logo.scad" in
  Scad.write oc scad_logo;
  close_out oc

Generated scads can then be viewed with the OpenSCAD viewer as you normally would.

Documentation

Online documentation is available here.

Companion PPX

There is a companion ppx, [@@deriving scad] for generating transformation functions for user-defined records and abstract types made up of the Scad.t and Vec3.t types provided in this library.

Authors

@namachan10777
- Original author
@geoffder
- Overhaul and add many functions

License

BSL-1.0

scad-ml's People

Contributors

Stargazers

Watchers

scad-ml's Issues

rotate_extrude with ang

When using the rotate_extrude with angle as bellow, it seems missing comma ",".
my code:
Scad.rotate_extrude ~angle:(Float.pi /. 2.) ~convexity:2 ~fn
(Scad.translate(joint_len, 0., 0.)
(Scad.circle ~fn (joint_rad /. 2.)))
the result:
rotate_extrude(angle=90.000000convexity=2, $fn=100)
translate([2.000000, 0.000000, 0.000000])
circle(0.750000, $fn=100);

I think line 423 of scad.ml, (Option.map deg_of_rad angle |> maybe_fmt "angle=%f") should be change to (Option.map deg_of_rad angle |> maybe_fmt "angle=%f, ").

I'm sorry if I sound rude. My English still isn't that good.

OPAM Release (dashboard)

I have just created PR.

Remarks

The v1.0.0 tag and its release have been regenerated. This is because the 2 commits after the original v1.0.0 tag changed the git revision and it makes dune-release fail.

namachan10777 / scad-ml Goto Github PK