add example. refactor sdf. remove API surface

soypat · soypat · commit 1c69dc40a608 · 2022-05-02T15:38:56.000-03:00
diff --git a/examples/README.md b/examples/README.md
@@ -7,7 +7,7 @@ Click on image to go to code directory.
 
 | Example | Execution Time | File size |
 |---|---|---|
-|ADZ Nagano sensor cover|1s|10MB|
+|[ADZ Nagano sensor cover](adz-sensor-cover)|0.5s|10MB|
 
 [![ADZ Nagano sensor cover](fig/adz-sensor-cover.png)](adz-sensor-cover)
 
@@ -16,7 +16,7 @@ Click on image to go to code directory.
 
 | Example | Execution Time | File size |
 |---|---|---|
-|NPT Flange|1s|10MB|
+|[NPT Flange](npt-flange)|0.5s|10MB|
 
 [![NPT Flange](fig/npt-flange.png)](npt-flange)
 
@@ -25,16 +25,25 @@ Click on image to go to code directory.
 
 | Example | Execution Time | File size |
 |---|---|---|
-|ATX Bench power supply mod|1s|4540kB|
+|[ATX Bench power supply mod](atx-bench-supply)|0.5s|4540kB|
 
 [![ATX Bench power supply mod](fig/atx-bench-supply.png)](atx-bench-supply)
 
 
-## PCB circuit spacer
+## PCB spacer
 
 | Example | Execution Time | File size |
 |---|---|---|
-|PCB circuit spacer|1s|9736kB|
+|[PCB spacer](pcb-spacer)|1s|9736kB|
 
-[![PCB circuit spacer](fig/pcb-spacer.png)](pcb-spacer)
+[![PCB spacer](fig/pcb-spacer.png)](pcb-spacer)
+
+
+## PCB support
+
+| Example | Execution Time | File size |
+|---|---|---|
+|[PCB support](pcb-support)|0.5s|7961kB|
+
+[![PCB support](fig/pcb-support.png)](pcb-support)
 
diff --git a/examples/README.tmpl b/examples/README.tmpl
@@ -7,7 +7,7 @@ Click on image to go to code directory.
 
 | Example | Execution Time | File size |
 |---|---|---|
-|{{ $val.Name }}|{{ $val.ExecutionTime }}|{{ $val.STLSize }}|
+|[{{ $val.Name }}]({{ $val.Dir }})|{{ $val.ExecutionTime }}|{{ $val.STLSize }}|
 
 [![{{ $val.Name }}]({{ $val.PNGResult }})]({{ $val.Dir }})
 
diff --git a/examples/adz-sensor-cover/cover.go b/examples/adz-sensor-cover/cover.go
@@ -32,23 +32,23 @@ func main() {
 	cover = form3.Box(r3.Vec{X: dim, Y: dim, Z: connectorSensSpacing/2 + coverProtude}, round)
 	dim = material.InternalDimScale(connectorDim)
 	empty = form3.Box(r3.Vec{X: dim, Y: dim, Z: coverProtude}, 0)
-	empty = sdf.Transform3D(empty, sdf.Translate3d(r3.Vec{Z: connectorSensSpacing / 4}))
+	empty = sdf.Transform3D(empty, sdf.Translate3D(r3.Vec{Z: connectorSensSpacing / 4}))
 	cover = sdf.Difference3D(cover, empty)
 
 	// We now create sensor-facing part
 	sensorCover = form3.Cylinder(coverProtude+connectorSensSpacing/2, adzDiam/2+coverThick, round)
 	dim = material.InternalDimScale(adzDiam / 2)
 	empty = form3.Cylinder(coverProtude, dim, round*2)
 
-	empty = sdf.Transform3D(empty, sdf.Translate3d(r3.Vec{Z: -connectorSensSpacing / 4}))
+	empty = sdf.Transform3D(empty, sdf.Translate3D(r3.Vec{Z: -connectorSensSpacing / 4}))
 	sensorCover = sdf.Difference3D(sensorCover, empty)
-	sensorCover = sdf.Transform3D(sensorCover, sdf.Translate3d(r3.Vec{Z: -(coverProtude + connectorSensSpacing/2)}))
+	sensorCover = sdf.Transform3D(sensorCover, sdf.Translate3D(r3.Vec{Z: -(coverProtude + connectorSensSpacing/2)}))
 	cover = sdf.Union3D(cover, sensorCover)
 
 	// Make hole for connector pins.
 	dim = 10
 	hole = form3.Box(r3.Vec{X: dim, Y: dim, Z: 4 * coverThick}, 0)
-	hole = sdf.Transform3D(hole, sdf.Translate3d(r3.Vec{Z: -2 * coverThick}))
+	hole = sdf.Transform3D(hole, sdf.Translate3D(r3.Vec{Z: -2 * coverThick}))
 	cover = sdf.Difference3D(cover, hole)
 	cover = material.Scale(cover)
 	err := render.CreateSTL("cover.stl", render.NewOctreeRenderer(cover, 180))
diff --git a/examples/atx-bench-supply/atx.go b/examples/atx-bench-supply/atx.go
@@ -69,7 +69,7 @@ func main() {
 	regBlock = sdf.Transform2D(regBlock, sdf.Translate2d(regOut.BoundingBox().Center()))
 	regBlock = sdf.Difference2D(regBlock, regOut)
 	regBlock3 := sdf.Extrude3D(regBlock, panelThickness+regBlockDepth) // extrude does it both ways.
-	regBlock3 = sdf.Transform3D(regBlock3, sdf.Translate3d(r3.Vec{0, 0, regBlockDepth / 2}))
+	regBlock3 = sdf.Transform3D(regBlock3, sdf.Translate3D(r3.Vec{0, 0, regBlockDepth / 2}))
 	panel = sdf.Difference2D(panel, regOut)
 
 	// Speaker clamps
diff --git a/examples/fig/pcb-support.png b/examples/fig/pcb-support.png
diff --git a/examples/generate_examples.go b/examples/generate_examples.go
@@ -55,11 +55,17 @@ var examples = []struct {
 		view:      defaultView,
 	},
 	{
-		Name:      "PCB circuit spacer",
+		Name:      "PCB spacer",
 		Dir:       "pcb-spacer",
 		resultSTL: "pcb_base.stl",
 		view:      defaultView,
 	},
+	{
+		Name:      "PCB support",
+		Dir:       "pcb-support",
+		resultSTL: "support.stl",
+		view:      defaultView,
+	},
 }
 
 func main() {
diff --git a/examples/npt-flange/flange.go b/examples/npt-flange/flange.go
@@ -33,7 +33,7 @@ func main() {
 	// PLA scaling to thread
 	pipe = sdf.Transform3D(pipe, sdf.Scale3d(r3.Vec{plaScale, plaScale, 1}))
 	flange = form3.Cylinder(flangeH, flangeD/2, flangeH/8)
-	flange = sdf.Transform3D(flange, sdf.Translate3d(r3.Vec{0, 0, -tlen / 2}))
+	flange = sdf.Transform3D(flange, sdf.Translate3D(r3.Vec{0, 0, -tlen / 2}))
 	union := sdf.Union3D(pipe, flange)
 	// set flange fillet
 	union.SetMin(sdf.MinPoly(0.2))
diff --git a/examples/pcb-spacer/boardspacer.go b/examples/pcb-spacer/boardspacer.go
@@ -53,7 +53,7 @@ func base() sdf.SDF3 {
 	s2 := sdf.Extrude3D(pan, baseThickness)
 	xOfs := 0.5 * baseLength
 	yOfs := 0.5 * baseWidth
-	s2 = sdf.Transform3D(s2, sdf.Translate3d(r3.Vec{xOfs, yOfs, 0}))
+	s2 = sdf.Transform3D(s2, sdf.Translate3D(r3.Vec{xOfs, yOfs, 0}))
 
 	// standoffs
 	zOfs := 0.5 * (pillarHeight + baseThickness)
diff --git a/examples/pcb-support/support.go b/examples/pcb-support/support.go
@@ -1,13 +1,88 @@
 package main
 
 import (
-	"fmt"
-
-	"github.com/soypat/sdf/form3"
+	"github.com/soypat/sdf"
+	"github.com/soypat/sdf/form2/obj2"
+	"github.com/soypat/sdf/form3/must3"
+	"github.com/soypat/sdf/helpers/matter"
+	"github.com/soypat/sdf/render"
+	"gonum.org/v1/gonum/spatial/r2"
 	"gonum.org/v1/gonum/spatial/r3"
 )
 
+const (
+	supportThickness         = 2.5
+	backsidePillarHeight     = 9.0
+	backsidePillarDiam       = 8.0
+	backsidePillarHollowDiam = 6.0
+	// holeSpacing
+	hsX = 102.0 // shared by standoffs too
+	hsY = 60.0
+	// Standoff spacing
+	soX      = hsX
+	soY      = 95.0
+	diamSO   = 8.0
+	diamHole = 3.5
+)
+
+var (
+	material    = matter.PLA
+	supportSize = r2.Vec{100, 100}
+	boxHoles    = []r2.Vec{
+		{13, 30},
+		{13 + hsX, 30},
+		{13, 30 + hsY},
+		{13 + hsX, 90 + hsY},
+	}
+
+	boxStandoffs = []r2.Vec{
+		{13, 12.5},
+		{13 + soX, 12.5},
+		{13, 12.5 + soY},
+		{13 + soX, 12.5 + soY},
+	}
+)
+
 func main() {
-	_, err := form3.Box(r3.Vec{1, 1, 1}, -1)
-	fmt.Println(err)
+	// Support basic shape
+	panel, err := obj2.Panel(obj2.PanelParams{
+		Size:         supportSize,
+		CornerRadius: diamHole * 1.2,
+		HoleDiameter: material.InternalDimScale(diamHole),
+		HoleMargin:   [4]float64{4.5, 4.5, 4.5, 4.5},
+		HolePattern:  [4]string{"x", "x", "x", "x"},
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	support := sdf.Extrude3D(panel, supportThickness)
+	support = sdf.Transform3D(support, sdf.Translate3D(r3.Vec{X: supportSize.X / 2, Y: supportSize.Y / 2}))
+
+	for _, so := range boxStandoffs {
+		var standoff sdf.SDF3 = must3.Cylinder(supportThickness*2, diamSO/2, 0)
+		standoff = sdf.Transform3D(standoff, sdf.Translate3D(r3.Vec{X: so.X, Y: so.Y}))
+		support = sdf.Difference3D(support, standoff)
+	}
+
+	for _, so := range boxHoles {
+		var hole sdf.SDF3 = must3.Cylinder(10, diamHole/2, 0)
+		hole = sdf.Transform3D(hole, sdf.Translate3D(r3.Vec{X: so.X, Y: so.Y}))
+		support = sdf.Difference3D(support, hole)
+	}
+	// make back-side support pillars
+	var backsidePillars = []r2.Vec{
+		{85, 85},
+		{85, 15},
+		{50, 50},
+	}
+	for _, pillar := range backsidePillars {
+		var s sdf.SDF3 = must3.Cylinder(backsidePillarHeight, backsidePillarDiam/2, 0)
+		s = sdf.Difference3D(s, must3.Cylinder(backsidePillarHeight, backsidePillarHollowDiam/2, 0))
+		s = sdf.Transform3D(s, sdf.Translate3D(r3.Vec{X: pillar.X, Y: pillar.Y, Z: (backsidePillarHeight + supportThickness) / 2}))
+		union := sdf.Union3D(support, s)
+		union.SetMin(sdf.MinPoly(3))
+		support = union
+	}
+	render.CreateSTL("support.stl", render.NewOctreeRenderer(support, 190))
 }
diff --git a/form3/obj3/bolt.go b/form3/obj3/bolt.go
@@ -52,7 +52,7 @@ func Bolt(k BoltParms) (s sdf.SDF3, err error) {
 	shankLength := k.ShankLength + hh/2
 	shankOffset := shankLength / 2
 	var shank sdf.SDF3 = form3.Cylinder(shankLength, t.Radius, hh*0.08)
-	shank = sdf.Transform3D(shank, sdf.Translate3d(r3.Vec{0, 0, shankOffset}))
+	shank = sdf.Transform3D(shank, sdf.Translate3D(r3.Vec{0, 0, shankOffset}))
 
 	// external thread
 	threadLength := k.TotalLength - k.ShankLength
@@ -68,7 +68,7 @@ func Bolt(k BoltParms) (s sdf.SDF3, err error) {
 		// chamfer the thread
 		thread = form3.ChamferedCylinder(thread, 0, 0.5)
 
-		thread = sdf.Transform3D(thread, sdf.Translate3d(r3.Vec{0, 0, threadOffset}))
+		thread = sdf.Transform3D(thread, sdf.Translate3D(r3.Vec{0, 0, threadOffset}))
 	}
 
 	return sdf.Union3D(head, shank, thread), nil // TODO error handling
diff --git a/form3/obj3/hex.go b/form3/obj3/hex.go
@@ -26,10 +26,10 @@ func HexHead(radius float64, height float64, round string) (s sdf.SDF3, err erro
 		sphere3d := form3.Sphere(topRound)
 		zOfs := math.Sqrt(topRound*topRound-d*d) - height/2
 		if round == "t" || round == "tb" {
-			hex3d = sdf.Intersect3D(hex3d, sdf.Transform3D(sphere3d, sdf.Translate3d(r3.Vec{0, 0, -zOfs})))
+			hex3d = sdf.Intersect3D(hex3d, sdf.Transform3D(sphere3d, sdf.Translate3D(r3.Vec{0, 0, -zOfs})))
 		}
 		if round == "b" || round == "tb" {
-			hex3d = sdf.Intersect3D(hex3d, sdf.Transform3D(sphere3d, sdf.Translate3d(r3.Vec{0, 0, zOfs})))
+			hex3d = sdf.Intersect3D(hex3d, sdf.Transform3D(sphere3d, sdf.Translate3D(r3.Vec{0, 0, zOfs})))
 		}
 	}
 	return hex3d, nil // TODO error handling.
diff --git a/form3/obj3/panel.go b/form3/obj3/panel.go
@@ -41,9 +41,9 @@ func EuroRackPanel(k obj2.EuroRackParams) (sdf.SDF3, error) {
 	// add the ridges to the sides
 	zOfs := 0.5 * (k.Thickness + zSize)
 	xOfs := 0.5 * (k.HPSize() - xSize)
-	r = sdf.Transform3D(r, sdf.Translate3d(r3.Vec{0, 0, zOfs}))
-	r0 := sdf.Transform3D(r, sdf.Translate3d(r3.Vec{xOfs, 0, 0}))
-	r1 := sdf.Transform3D(r, sdf.Translate3d(r3.Vec{-xOfs, 0, 0}))
+	r = sdf.Transform3D(r, sdf.Translate3D(r3.Vec{0, 0, zOfs}))
+	r0 := sdf.Transform3D(r, sdf.Translate3D(r3.Vec{xOfs, 0, 0}))
+	r1 := sdf.Transform3D(r, sdf.Translate3D(r3.Vec{-xOfs, 0, 0}))
 
 	return sdf.Union3D(s, r0, r1), nil
 }
@@ -82,7 +82,7 @@ func PanelHole(k *PanelHoleParams) (sdf.SDF3, error) {
 	// build the indent
 	indent = form3.Box(k.Indent, 0)
 	zOfs := (k.Thickness - k.Indent.Z) * 0.5
-	indent = sdf.Transform3D(indent, sdf.Translate3d(r3.Vec{k.Offset, 0, zOfs}))
+	indent = sdf.Transform3D(indent, sdf.Translate3D(r3.Vec{k.Offset, 0, zOfs}))
 
 	s = sdf.Union3D(s, indent)
 	if k.Orientation != 0 {
diff --git a/form3/obj3/standoff.go b/form3/obj3/standoff.go
@@ -52,7 +52,7 @@ func pillarWeb(k StandoffParams) sdf.SDF3 {
 	w.Add(0, k.WebHeight)
 	p := form2.Polygon(w.Vertices())
 	s := sdf.Extrude3D(p, k.WebWidth)
-	m := sdf.Translate3d(r3.Vec{0, 0, -0.5 * k.PillarHeight}).Mul(sdf.RotateX(d2r(90.0)))
+	m := sdf.Translate3D(r3.Vec{0, 0, -0.5 * k.PillarHeight}).Mul(sdf.RotateX(d2r(90.0)))
 	return sdf.Transform3D(s, m)
 }
 
@@ -69,5 +69,5 @@ func pillarHole(k StandoffParams) sdf.SDF3 {
 	}
 	s := form3.Cylinder(math.Abs(k.HoleDepth), 0.5*k.HoleDiameter, 0)
 	zOfs := 0.5 * (k.PillarHeight - k.HoleDepth)
-	return sdf.Transform3D(s, sdf.Translate3d(r3.Vec{0, 0, zOfs}))
+	return sdf.Transform3D(s, sdf.Translate3D(r3.Vec{0, 0, zOfs}))
 }
diff --git a/matrix.go b/matrix.go
@@ -105,8 +105,8 @@ func Identity() m22 {
 		0, 1}
 }
 
-// Translate3d returns a 4x4 translation matrix.
-func Translate3d(v r3.Vec) m44 {
+// Translate3D returns a 4x4 translation matrix.
+func Translate3D(v r3.Vec) m44 {
 	return m44{
 		1, 0, 0, v.X,
 		0, 1, 0, v.Y,
diff --git a/render/render.go b/render/render.go
@@ -18,15 +18,6 @@ type Triangle3 struct {
 	V [3]r3.Vec
 }
 
-// NewTriangle3 returns a new 3D triangle.
-func NewTriangle3(a, b, c r3.Vec) *Triangle3 {
-	t := Triangle3{}
-	t.V[0] = a
-	t.V[1] = b
-	t.V[2] = c
-	return &t
-}
-
 // Normal returns the normal vector to the plane defined by the 3D triangle.
 func (t *Triangle3) Normal() r3.Vec {
 	e1 := t.V[1].Sub(t.V[0])
diff --git a/sdf3.go b/sdf3.go
@@ -234,7 +234,7 @@ func (s *extrudeRounded) Evaluate(p r3.Vec) float64 {
 			d = b
 		} else {
 			// outside the boundary
-			d = math.Sqrt((a * a) + (b * b))
+			d = math.Hypot(a, b)
 		}
 	} else {
 		// within the object Z extent
@@ -265,8 +265,8 @@ type loft3 struct {
 	bb         d3.Box
 }
 
-// MustLoft3D extrudes an SDF3 that transitions between two SDF2 shapes.
-func MustLoft3D(sdf0, sdf1 SDF2, height, round float64) SDF3 {
+// Loft3D extrudes an SDF3 that transitions between two SDF2 shapes.
+func Loft3D(sdf0, sdf1 SDF2, height, round float64) SDF3 {
 	switch {
 	case sdf0 == nil || sdf1 == nil:
 		panic("nil sdf argument")
@@ -598,8 +598,8 @@ type array3 struct {
 	bb   d3.Box
 }
 
-// MustArray3D returns an XYZ array of a given SDF3
-func MustArray3D(sdf SDF3, num V3i, step r3.Vec) SDF3Union {
+// Array3D returns an XYZ array of a given SDF3
+func Array3D(sdf SDF3, num V3i, step r3.Vec) SDF3Union {
 	// check the number of steps
 	if num[0] <= 0 || num[1] <= 0 || num[2] <= 0 {
 		return empty3From(sdf)
@@ -854,7 +854,7 @@ func LineOf3D(s SDF3, p0, p1 r3.Vec, pattern string) SDF3 {
 		// dx := p1.Sub(p0).DivScalar(float64(len(pattern))) //TODO VERIFY
 		for _, c := range pattern {
 			if c == 'x' {
-				objects = append(objects, Transform3D(s, Translate3d(x)))
+				objects = append(objects, Transform3D(s, Translate3D(x)))
 			}
 			x = x.Add(dx)
 		}
@@ -872,7 +872,7 @@ func Multi3D(s SDF3, positions d3.Set) SDF3 {
 	}
 	objects := make([]SDF3, len(positions))
 	for i, p := range positions {
-		objects[i] = Transform3D(s, Translate3d(p))
+		objects[i] = Transform3D(s, Translate3D(p))
 	}
 	return Union3D(objects...)
 }
