Add skline examples

OCADml · May 1, 2023 · 8243669 · 8243669
1 parent 7886391
commit 8243669
Show file tree

Hide file tree

Showing 37 changed files with 188 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ _opam/
 _esy/
 
 examples/scads
+examples/pngs/incl_*.png
diff --git a/docs/index.mld b/docs/index.mld
@@ -85,6 +85,7 @@ should serve as a helpful reference.
 
 {2 Skins and Morphs}
 - {{!page-"profile_skinning"} {b Profile skinning}}
+- {{!page-"spline_skinning"} {b Continuous skinning with Bézier splines}}
 - {{!page-"morphing_sweeps"} {b Morphing sweeps and extrusions}}
 
 {2 Function Plotting}

diff --git a/examples/docs/morphing_sweeps.mld b/examples/docs/morphing_sweeps.mld
@@ -18,7 +18,7 @@ let () =
       V3.[ v 0. 0. 2.; v 0. 20. 20.; v 40. 20. 10.; v 30. 0. 10. ]
       |> Path3.quaternion (Quaternion.make (v3 1. 1. 0.) (Float.pi /. -5.))
     in
-    Bezier3.curve ~fn:60 @@ Bezier3.of_path ~size:(`Flat (`Rel 0.3)) control
+    Bezier3.curve ~fn:80 @@ Bezier3.of_path ~size:(`Flat (`Rel 0.3)) control
   and caps =
     Mesh.Cap.(capped ~bot:(round @@ circ (`Radius 0.5)) ~top:(round @@ circ (`Radius 0.5)))
   and a = Poly2.ring ~fn:5 ~thickness:(v2 2.5 2.5) (v2 6. 6.)

diff --git a/examples/docs/profile_skinning.mld b/examples/docs/profile_skinning.mld
@@ -56,15 +56,3 @@ let () =
 <img src="_assets/vaccum_connector.png" style="width:150mm;"/>
 </p> %}
 
-
-{[
-let () =
-  Mesh.skin
-    ~refine:2
-    ~slices:(`Flat 25)
-    ~mapping:(`Flat `Tangent)
-    Path3.[ circle ~fn:5 4.; translate (v3 0. 0. 3.) @@ circle ~fn:80 2. ]
-  |> Scad.of_mesh
-  |> Scad.to_file "tangent_skin_test.scad"
-]}
-
diff --git a/examples/docs/spline_skinning.mld b/examples/docs/spline_skinning.mld
@@ -0,0 +1,96 @@
+{0 Bézier Sklines} 
+
+{[
+open OCADml
+open OSCADml
+]}
+
+{{!OCADml.Mesh.skline} [Mesh.skline]}, like {{!OCADml.Mesh.skin}
+[Mesh.skin]} provides a means of generating a mesh that covers a series of
+given profiles, but where [skin] linearly transistions between each profile
+independently, [skline] splines through each of the paths formed by the
+associated vertices from the first profile to the last (or in a loop).
+to generate meshes that cover over series of profiles. However, unlike
+[skin] only resampling is made available for mapping vertices between
+incomensurate profiles as the point duplication methods (tangent and
+distance) can easily lead to edge intersections. 
+
+{[
+let handle_profiles =
+  let circ = Path3.circle ~fn:64 5. in
+  let base = Path3.scale (v3 1.2 1.2 1.) circ
+  and handle = Path3.scale (v3 0.7 0.7 1.) circ in
+  Path3.
+    [ ztrans (-3.) base
+    ; circ
+    ; translate (v3 15. 0. 20.) (yrot (Float.pi /. 2.) handle)
+    ; xtrans 30. (yrot Float.pi circ)
+    ; translate (v3 30. 0. (-3.)) (yrot Float.pi base)
+    ]
+]}
+
+A quick look at the points of our profiles we are about to spline over with
+alternating colours may help a bit to conceptualize what we are about to
+give {{!OCADml.Mesh.skline} [Mesh.skline]} to work with. 
+
+{[
+let () =
+  let show i =
+    let c = if i mod 2 = 0 then Color.Magenta else Color.Aquamarine in
+    Debug.show_path3 (fun _ -> Scad.(color c @@ sphere 0.2))
+  in
+  List.mapi show handle_profiles |> Scad.union |> Scad.to_file "handle_points.scad"
+]}
+
+{%html:
+<p style="text-align:center;">
+<img src="_assets/handle_points.png" style="width:150mm;"/>
+</p> %}
+
+Using the [?tangents] parameter of {{!OCADml.Bezier3.of_path}
+[Bezier3.of_path]} we can specify the tangents we want for each profile,
+rather than leaving them up to the automatically computed derivatives (that
+may differ for each edge path tracing between the profiles). Here we
+contstrain them to cardinals so we can get a handle that sticks closer to
+right angles. 
+
+{[
+let () =
+  let up = v3 0. 0. 1. in
+  let tangents = `Tangents [ up; up; v3 1. 0. 0.; V3.neg up; V3.neg up ] in
+  Mesh.skline ~fn:200 ~size:(`Flat (`Rel 0.5)) ~tangents handle_profiles
+  |> Scad.of_mesh
+  |> Scad.to_file ~incl:true "handle_skline.scad"
+]}
+
+{%html:
+<p style="text-align:center;">
+<img src="_assets/handle_skline.png" style="width:150mm;"/>
+</p> %}
+
+As mentioned above, continuous curvature loops are also possible. Here we
+morph cyclically through circular and pentagonal profiles by specifying
+[~endcaps:`Loop]. 
+
+{[
+let () =
+  let circ = Path3.circle ~fn:64 5. in
+  let pent = Path3.(circle ~fn:5 5.) in
+  let profs =
+    Path3.
+      [ circ
+      ; translate (v3 15. 0. 20.) (yrot (Float.pi /. 2.) pent)
+      ; xtrans 30. (yrot Float.pi circ)
+      ; translate (v3 15. 0. (-20.)) (yrot (Float.pi *. 1.5) pent)
+      ]
+  in
+  Mesh.skline ~endcaps:`Loop ~fn:200 ~size:(`Flat (`Rel 0.1)) profs
+  |> Scad.of_mesh
+  |> Scad.to_file ~incl:true "edgy_loop.scad"
+]}
+
+{%html:
+<p style="text-align:center;">
+<img src="_assets/edgy_loop.png" style="width:150mm;"/>
+</p> %}
+
diff --git a/examples/dune b/examples/dune
@@ -15,6 +15,7 @@
   resampled_path
   default_vs_euler_sweeps
   profile_skinning
+  spline_skinning
   morphing_sweeps)
  (libraries OSCADml OCADml.PolyText))
 

diff --git a/examples/morphing_sweeps.ml b/examples/morphing_sweeps.ml
@@ -15,7 +15,7 @@ let () =
       V3.[ v 0. 0. 2.; v 0. 20. 20.; v 40. 20. 10.; v 30. 0. 10. ]
       |> Path3.quaternion (Quaternion.make (v3 1. 1. 0.) (Float.pi /. -5.))
     in
-    Bezier3.curve ~fn:60 @@ Bezier3.of_path ~size:(`Flat (`Rel 0.3)) control
+    Bezier3.curve ~fn:80 @@ Bezier3.of_path ~size:(`Flat (`Rel 0.3)) control
   and caps =
     Mesh.Cap.(capped ~bot:(round @@ circ (`Radius 0.5)) ~top:(round @@ circ (`Radius 0.5)))
   and a = Poly2.ring ~fn:5 ~thickness:(v2 2.5 2.5) (v2 6. 6.)

diff --git a/examples/pngs/arc_points_2d.png b/examples/pngs/arc_points_2d.png
diff --git a/examples/pngs/arc_points_3d.png b/examples/pngs/arc_points_3d.png
diff --git a/examples/pngs/arc_wedge_2d.png b/examples/pngs/arc_wedge_2d.png
diff --git a/examples/pngs/bezier_spline_path.png b/examples/pngs/bezier_spline_path.png
diff --git a/examples/pngs/cartesian_gravity_well.png b/examples/pngs/cartesian_gravity_well.png
diff --git a/examples/pngs/chamfered_loop.png b/examples/pngs/chamfered_loop.png
diff --git a/examples/pngs/chamfered_square_with_holes.png b/examples/pngs/chamfered_square_with_holes.png
diff --git a/examples/pngs/circular_rounding.png b/examples/pngs/circular_rounding.png
diff --git a/examples/pngs/edgy_loop.png b/examples/pngs/edgy_loop.png
diff --git a/examples/pngs/elbow.png b/examples/pngs/elbow.png
diff --git a/examples/pngs/handle_points.png b/examples/pngs/handle_points.png
diff --git a/examples/pngs/handle_skline.png b/examples/pngs/handle_skline.png
diff --git a/examples/pngs/helix_extrude.png b/examples/pngs/helix_extrude.png
diff --git a/examples/pngs/helix_path_points.png b/examples/pngs/helix_path_points.png
diff --git a/examples/pngs/incl_polar_rose.png b/examples/pngs/incl_polar_rose.png
diff --git a/examples/pngs/offset_poly.png b/examples/pngs/offset_poly.png
diff --git a/examples/pngs/polar_rose.png b/examples/pngs/polar_rose.png
diff --git a/examples/pngs/resampled_path.png b/examples/pngs/resampled_path.png
diff --git a/examples/pngs/rounded_polyhole_sweep.png b/examples/pngs/rounded_polyhole_sweep.png
diff --git a/examples/pngs/rounded_prism_star.png b/examples/pngs/rounded_prism_star.png
diff --git a/examples/pngs/spiral.png b/examples/pngs/spiral.png
diff --git a/examples/pngs/sweep_path_default.png b/examples/pngs/sweep_path_default.png
diff --git a/examples/pngs/sweep_path_euler.png b/examples/pngs/sweep_path_euler.png
diff --git a/examples/pngs/sweep_starburst_default.png b/examples/pngs/sweep_starburst_default.png
diff --git a/examples/pngs/sweep_starburst_euler.png b/examples/pngs/sweep_starburst_euler.png
diff --git a/examples/pngs/tangent_morph_sweep.png b/examples/pngs/tangent_morph_sweep.png
diff --git a/examples/pngs/tangent_skin_test.png b/examples/pngs/tangent_skin_test.png
diff --git a/examples/pngs/test_hull_3d.png b/examples/pngs/test_hull_3d.png
diff --git a/examples/profile_skinning.ml b/examples/profile_skinning.ml
@@ -47,12 +47,3 @@ let () =
     <img src="_assets/vaccum_connector.png" style="width:150mm;"/>
     </p> %}
     *)
-
-let () =
-  Mesh.skin
-    ~refine:2
-    ~slices:(`Flat 25)
-    ~mapping:(`Flat `Tangent)
-    Path3.[ circle ~fn:5 4.; translate (v3 0. 0. 3.) @@ circle ~fn:80 2. ]
-  |> Scad.of_mesh
-  |> Scad.to_file "tangent_skin_test.scad"
diff --git a/examples/spline_skinning.ml b/examples/spline_skinning.ml
@@ -0,0 +1,87 @@
+(** {0 Bézier Sklines} *)
+
+open OCADml
+open OSCADml
+
+(** {{!OCADml.Mesh.skline} [Mesh.skline]}, like {{!OCADml.Mesh.skin}
+    [Mesh.skin]} provides a means of generating a mesh that covers a series of
+    given profiles, but where [skin] linearly transistions between each profile
+    independently, [skline] splines through each of the paths formed by the
+    associated vertices from the first profile to the last (or in a loop).
+    to generate meshes that cover over series of profiles. However, unlike
+   [skin] only resampling is made available for mapping vertices between
+   incomensurate profiles as the point duplication methods (tangent and
+   distance) can easily lead to edge intersections. *)
+
+let handle_profiles =
+  let circ = Path3.circle ~fn:64 5. in
+  let base = Path3.scale (v3 1.2 1.2 1.) circ
+  and handle = Path3.scale (v3 0.7 0.7 1.) circ in
+  Path3.
+    [ ztrans (-3.) base
+    ; circ
+    ; translate (v3 15. 0. 20.) (yrot (Float.pi /. 2.) handle)
+    ; xtrans 30. (yrot Float.pi circ)
+    ; translate (v3 30. 0. (-3.)) (yrot Float.pi base)
+    ]
+
+(** A quick look at the points of our profiles we are about to spline over with
+    alternating colours may help a bit to conceptualize what we are about to
+    give {{!OCADml.Mesh.skline} [Mesh.skline]} to work with. *)
+let () =
+  let show i =
+    let c = if i mod 2 = 0 then Color.Magenta else Color.Aquamarine in
+    Debug.show_path3 (fun _ -> Scad.(color c @@ sphere 0.2))
+  in
+  List.mapi show handle_profiles |> Scad.union |> Scad.to_file "handle_points.scad"
+
+(** {%html:
+    <p style="text-align:center;">
+    <img src="_assets/handle_points.png" style="width:150mm;"/>
+    </p> %}
+    *)
+
+(** Using the [?tangents] parameter of {{!OCADml.Bezier3.of_path}
+    [Bezier3.of_path]} we can specify the tangents we want for each profile,
+    rather than leaving them up to the automatically computed derivatives (that
+    may differ for each edge path tracing between the profiles). Here we
+    contstrain them to cardinals so we can get a handle that sticks closer to
+    right angles. *)
+
+let () =
+  let up = v3 0. 0. 1. in
+  let tangents = `Tangents [ up; up; v3 1. 0. 0.; V3.neg up; V3.neg up ] in
+  Mesh.skline ~fn:200 ~size:(`Flat (`Rel 0.5)) ~tangents handle_profiles
+  |> Scad.of_mesh
+  |> Scad.to_file ~incl:true "handle_skline.scad"
+
+(** {%html:
+    <p style="text-align:center;">
+    <img src="_assets/handle_skline.png" style="width:150mm;"/>
+    </p> %}
+    *)
+
+(** As mentioned above, continuous curvature loops are also possible. Here we
+    morph cyclically through circular and pentagonal profiles by specifying
+    [~endcaps:`Loop]. *)
+
+let () =
+  let circ = Path3.circle ~fn:64 5. in
+  let pent = Path3.(circle ~fn:5 5.) in
+  let profs =
+    Path3.
+      [ circ
+      ; translate (v3 15. 0. 20.) (yrot (Float.pi /. 2.) pent)
+      ; xtrans 30. (yrot Float.pi circ)
+      ; translate (v3 15. 0. (-20.)) (yrot (Float.pi *. 1.5) pent)
+      ]
+  in
+  Mesh.skline ~endcaps:`Loop ~fn:200 ~size:(`Flat (`Rel 0.1)) profs
+  |> Scad.of_mesh
+  |> Scad.to_file ~incl:true "edgy_loop.scad"
+
+(** {%html:
+    <p style="text-align:center;">
+    <img src="_assets/edgy_loop.png" style="width:150mm;"/>
+    </p> %}
+    *)