Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomasf/helical
A SwiftSCAD library providing customizable threads, screws, bolts, nuts and related parts.
https://github.com/tomasf/helical
Last synced: 2 days ago
JSON representation
A SwiftSCAD library providing customizable threads, screws, bolts, nuts and related parts.
- Host: GitHub
- URL: https://github.com/tomasf/helical
- Owner: tomasf
- License: mit
- Created: 2024-02-27T18:47:44.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T16:54:00.000Z (2 months ago)
- Last Synced: 2025-02-02T02:47:34.586Z (5 days ago)
- Language: Swift
- Homepage:
- Size: 7.37 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Helical
Helical is a library for SwiftSCAD that simplifies the creation of threaded components and related parts. It supports widely-used metric threads, bolts, and nuts, as well as the ability to customize these components to fit specific requirements.
[Bolts demo](Sources/Demo/bolts.stl)
[Nuts and washers demo](Sources/Demo/nutsAndWashers.stl)
## Installation
Integrate Helical into your project with the Swift Package Manager by adding it as a dependency in your `Package.swift` file:
let package = Package(
name: "thingamajig",
dependencies: [
.package(url: "https://github.com/tomasf/SwiftSCAD.git", .upToNextMinor(from: "0.8.1")),
.package(url: "https://github.com/tomasf/Helical.git", from: "0.1.2")
],
targets: [
.executableTarget(name: "thingamajig", dependencies: ["SwiftSCAD", "Helical"])
]
)
Then, import Helical where it's needed:
```swift
import Helical
```
## Usage
### Standard Components
Helical simplifies the process of creating threaded shapes, making it easier to incorporate threaded holes into your models. It also provides a selection of standard bolts, nuts, and corresponding holes. Creating a typical M8x30 hex head bolt is simple:
```swift
Bolt.hexHead(.m8, length: 30, shankLength: 8)
```
This generates a standard [DIN 931](https://www.fasteners.eu/standards/DIN/931/) bolt, exactly as anticipated.
### Customizing Components
Beyond the standard offerings, Helical allows for modifications to fit unique requirements:
```swift
Bolt.hexHead(.isoMetric(.m8, pitch: 0.75), headWidth: 15, headHeight: 6.5, length: 30)
```
Or fully customize parts to your specific needs:
```swift
let thread = ScrewThread(
handedness: .left,
starts: 2,
pitch: 1.5,
majorDiameter: 6.2,
minorDiameter: 5.3,
form: .trapezoidal(angle: 90°, crestWidth: 0.25)
)
let customBolt = Bolt(
thread: thread,
length: 15,
shankLength: 3,
shankDiameter: 5,
headShape: .countersunk(angle: 80°, topDiameter: 10, boltDiameter: 5),
socket: .slotted(length: 10, width: 1, depth: 1.4)
)
```
### Holes
Creating a matching countersunk clearance hole for a bolt is straightforward:
```swift
Box([20, 20, 10])
.aligned(at: .centerXY)
.subtracting {
customBolt.clearanceHole(recessedHead: true)
}
```
As is making a threaded hole for a particular thread:
```swift
Box([20, 20, 10])
.aligned(at: .centerXY)
.subtracting {
ThreadedHole(thread: thread, depth: 10, unthreadedDepth: 2)
}
```
## Contributing
We welcome contributions. Feel free to open issues for feedback or suggestions and submit pull requests for improvements to the codebase.