openscad/round-anything
1
0
Fork 0
mirror of https://github.com/Irev-Dev/Round-Anything.git synced 2025-01-16 18:48:14 +01:00
Code Issues Releases Wiki Activity

Update unionRoundMask-Doc.md

Browse Source 
cleanup headers
This commit is contained in:
TLC123 2021-08-23 15:52:21 +02:00 committed by GitHub
parent c56190a81b
commit 1b7623e17b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
unionRoundMask-Doc.md
View File

@ -1,12 +1,33 @@
#unionRoundMask
## unionRoundMask
### Union with round fillet at selected places.
![unionround-doc-example](https://user-images.githubusercontent.com/10944617/130456818-c5fd43d1-e6df-4e88-8474-aed1a0c3ca31.png)
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 just common primitives that is used to mark out areas.
Masks are a method to perform unionRound on selected only areas,
and circumvents the limitation of common convex work area.
usage:
unionRoundMask(r=1,detail=3,q=30)
Mask are essentially just common primitives that is used to mark out areas.
r:
* approximate radius for fillet. Exact radius is dependant on crease angle.
* detail: numbers of fillet segments. 1 is essensially a chamfer/bevel.
* Set low for faster preview. ( $preview?3:10 )
q:
* determine how detailed clad operations are.
* Set low for faster preview. ( $preview?30:70 )
epsilon:
* For debugging, leave as is.
showMask:
* For debugging, try it.
### usage:
````
unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q = $preview ? 30 : 70 )
{
yourObject1();
yourObject2();
@ -17,31 +38,40 @@ unionRoundMask(r=1,detail=3,q=30)
// ...
// ...
}
````
#unionRound
---
## unionRound
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.
usage:
unionRoundMask(r=1,detail=3,q=30)
### usage:
````
unionRoundMask( r = 1 , detail = $preview ? 3 : 10 , q= $preview ? 30 : 70 )
{
yourObject1();
yourObject2();
}
````
---
## intersectionRound
module intersectionRound(r, q=70, epsilon = 1e-6,showOperands = true)
#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
---
## 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:
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.
Available at: [https://scholar.rose-hulman.edu/rhumj/vol18/iss2/5]
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.
Available at: [https://scholar.rose-hulman.edu/rhumj/vol18/iss2/5]