https://github.com/tomasf/manifold-swift

Swift interface to the Manifold solid mesh geometry library
https://github.com/tomasf/manifold-swift

Last synced: 2 days ago
JSON representation

Swift interface to the Manifold solid mesh geometry library

• Host: GitHub
• URL: https://github.com/tomasf/manifold-swift
• Owner: tomasf
• License: mit
• Created: 2024-12-05T09:39:59.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2025-01-14T10:48:54.000Z (23 days ago)
• Last Synced: 2025-01-14T11:53:23.642Z (23 days ago)
• Language: Swift
• Homepage:
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Manifold-Swift

A Swift interface to the [Manifold geometry library](https://github.com/elalish/manifold), for manipulation of solid 3D meshes. 

![CI status](https://github.com/tomasf/manifold-swift/actions/workflows/swift.yml/badge.svg) ![Platforms](https://img.shields.io/badge/Platforms-macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS_%7C_Linux_%7C_Windows-47D?logo=swift&logoColor=white)

This SPM package includes Manifold, as well as its dependencies Clipper2 and oneTBB as Git submodules, so no additional dependencies are needed beyond the C++ standard library. Manifold-Swift covers most of the Manifold API, and naming is similar but using Swift conventions. It works on all Apple platforms as well as Linux and Windows. 

Due to a bug in Swift that isn't fixed in the latest release (as of 2025-01-13, version 6.0.3), the library requires a recent development snapshot of Swift to build on Windows.

## Usage

Add the package as a dependency in your Package.swift (or Xcode project). Because the library interfaces with C++, you need to enable C++ interoperability.

```swift

let package = Package(

    name: "manifold-swift-example",

    dependencies: [

        .package(url: "https://github.com/tomasf/manifold-swift.git", .upToNextMinor(from: "0.1.0"))

    ],

    targets: [

        .executableTarget(

            name: "manifold-swift-example",

            dependencies: [.product(name: "Manifold", package: "manifold-swift")],

            swiftSettings: [.interoperabilityMode(.Cxx)]

        )

    ]

)

```

## Example

The library uses protocols for vectors and matrices, so you can add conformance to your own types and send them in without conversion.

```swift

import Manifold3D

struct V: Vector3 {

    let x: Double

    let y: Double

    let z: Double

}

let sphere = Manifold.sphere(radius: 10, segmentCount: 25)

let box = Manifold.cube(size: V(x: 12, y: 20, z: 20))

    .rotate(V(x: 20, y: 25, z: 0))

let difference = sphere.boolean(.difference, with: box)

let meshGL = difference.meshGL()

// Render or save meshGL.vertices, meshGL.triangles, etc.

```

Read the [Manifold documentation](https://manifoldcad.org/docs/html) for more information.

## Contributions

Contributions are welcome! Submit pull requests or open issues to discuss improvements or report bugs.