allan-feng / glibby

glibby

The goal of this project is to create a C++ library encapsulating both classical and experimental techniques in computational geometry, with a focus on real-time performance and ease of use.

Visit our documentation pages for more information on how to build and use glibby in your projects.

Spring 2023 Pitch Deck.

Table of Contents

• Installation
• Usage
• Examples
• High-Level Todos
• Contributing
• Maintainers
• License

Installation

git clone https://github.com/2020wmarvil/glibby.git
cmake -E make_directory build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug -DGLIBBY_BUILD_RENDERER=ON -DGLIBBY_BUILD_EXAMPLES=ON -DGLIBBY_BUILD_DOCS=OFF
make install -j8

Note, to build with the debug renderer, you will need the Vulkan SDK installed.

Usage

#include "glibby/primitives/point2D.h"

int main() {
    glibby::Distance({ 0.0f, 0.0f }, { 5.0f, 5.0f });
}

Examples

Coming soon...

High-Level Todos

• Core Geometry Library
  • Math Library
  • Primitive Shapes and Operations
  • Surface Mesh Data Structures
  • Volumetric Mesh Data Structures
  • Surface/Volumetric Mesh Operations
  • Triangulation/Tetrahedralization
  • Voronoi Diagrams
  • Arrangements
  • Surface/Shape Reconstruction
  • Spatial Algorithms
  • Convex Hulls
• Job Dispatch
• Compute Dispatch
• Companion Renderer
  • Vulkan (in progress)
  • OpenGL, DirectX, Metal
• Language Bindings
  • Python, C#, Rust, ...

Contributing

Feel free to dive in! Open an issue or submit PRs. Check out Contributing to see how to contribute.

glibby follows the Contributor Covenant Code of Conduct.

Contributors

This project exists thanks to all the people who contribute.

Maintainers

@Wyatt Marvil. Reach me at [email protected] or join our Discord server.

License

MIT (c) Wyatt Marvil