openscad/round-anything
1
0
Fork 0
mirror of https://github.com/Irev-Dev/Round-Anything.git synced 2025-08-30 10:49:49 +02:00
Code Issues Releases Wiki Activity

Update unionRoundMask-Doc.md

Browse Source 
doc clean up
This commit is contained in:
TLC123
2021-08-23 16:19:56 +02:00
committed by GitHub
parent 1b7623e17b
commit f35262f955
1 changed files with 29 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
unionRoundMask-Doc.md
View File

@@ -1,14 +1,20 @@
## unionRoundMask
### Union with round fillet at selected places.
## unionRoundMask / unionRound
---
### Union with round fillet at selected places. Created for Round-Anything by TLC123 (2021).
A shortcut for faster fillet union is enabled when the operation constrained to convex operands.
For most cases unionRoundMask / unionRound replaces MinkowskiRound.
Combined with a system of mask selectors, unionRound becomes even more versetile.
![unionround-doc-example](https://user-images.githubusercontent.com/10944617/130456818-c5fd43d1-e6df-4e88-8474-aed1a0c3ca31.png)
## unionRoundMask
---
Union with round fillet at selected places.
### module unionRoundMask(r=1, detail = 5 , q=70, epsilon = 1e-6, showMask = true)
module unionRoundMask(r=1, detail = 5 , q=70, epsilon = 1e-6, showMask = true)
Masks are a method to perform unionRound on selected only areas,
and circumvents the limitation of common convex work area.
Mask are essentially just common primitives that is used to mark out areas.
Masks are a method to perform unionRound on selected only areas,
and circumvents the previous limitation to common convex work area.
Mask are essentially just common primitives that is used to mark out areas by intersection.
r:
* approximate radius for fillet. Exact radius is dependant on crease angle.
@@ -42,7 +48,8 @@ unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q = $preview ? 30 : 70 )
---
## unionRound
module unionRound(r=1, detail = 5 , q=70, epsilon = 1e-6)
---
### module unionRound(r=1, detail = 5 , q=70, epsilon = 1e-6)
Module unionRound is the underlying work module of unionRoundMask.
It can be used by it self, in some cases faster but more raw.
@@ -58,19 +65,23 @@ unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q= $preview ? 30 : 70 )
---
## intersectionRound
module intersectionRound(r, q=70, epsilon = 1e-6,showOperands = true)
Undocumented for now.
---
## helpers
module clad(r,q=70) // speed is limited to convex operand
module shell(r,q=70) // not in use
module inset(r,q=20) // speed is limited to convex operand
module intersectionRound(r, q=70, epsilon = 1e-6,showOperands = true)
prototype module
Undocumented for now.
---
## helpers
---
````
module clad(r,q=70) // speed is limited to convex operand.
module shell(r,q=70) // not in use.
module inset(r,q=20) // speed is limited to convex operand.
````
---
## Citation
roundUnionMask Includes code based on examples from:
---
### roundUnionMask Includes code based on examples from:
Kogan, Jonathan (2017)
"A New Computationally Efficient Method for Spacing n Points on a Sphere,"
Rose-Hulman Undergraduate Mathematics Journal: Vol. 18 : Iss. 2 , Article 5.