[[./assets/svo-d7.jpg]]
Contents :toc_3_gh:
About the project
** Status
The project was in active, almost daily development from late 2011 - summer 2016 during its 4th iteration/rewrite cycle. Originally developed in a Literate Programming style using Emacs & Org-mode, in May 2018 it was decided to revert to a traditional Clojure project setup to encourage more contributions from other interested parties. The original .org source files are kept for reference in the [[./org/]] directory until further notice.
Regardless of version number, the library is mature and has been used successfully in several commercial projects over the past 10 years and can be considered stable for most use cases.
** Leiningen coordinates
[thi.ng/geom "1.0.1"]
*** Additional dependencies for JOGL
If you're intending to use this library's OpenGL functionality under Clojure (not ClojureScript), the following additional native dependencies must be added to your project (for each platform you intend to use):
[org.jogamp.gluegen/gluegen-rt "2.3.2" :classifier "natives-macosx-universal"] [org.jogamp.jogl/jogl-all "2.3.2" :classifier "natives-macosx-universal"]
The full list of supported platform =:classifier='s:
| natives-android-aarch64.jar | | natives-android-armv6.jar | | natives-linux-amd64.jar | | natives-linux-armv6.jar | | natives-linux-armv6hf.jar | | natives-linux-i586.jar | | natives-macosx-universal.jar | | natives-solaris-amd64.jar | | natives-solaris-i586.jar | | natives-windows-amd64.jar | | natives-windows-i586.jar |
** Overview
thi.ng/geom is a comprehensive and modular geometry & visualization toolkit for Clojure/ClojureScript. It provides a large set of purely math & geometry oriented data types, a polymorphic, largely protocol based API to transform/convert types and various ways to create interactive visualizations in SVG, WebGL, OpenGL, both in the browser and in desktop environments.
Embracing Clojure's approach of data transformations, the library's core philosophy is based on a functional approach to generative design tasks with hundreds of hours spent on refining & optimizing the core API for both Clojure & Clojurescript.
Unlike most other open source projects, this project has been developed in a literate programming style and has been in active, regular development since late 2011, currently in its 4th iteration/rewrite cycle.
You're highly encouraged to consult the source code, which contains documentation, examples, diagrams and general usage pattern hints.
This project is part of the [[https://github.com/thi-ng/][thi.ng]] collection of Clojure & Clojurescript libraries and makes uses of several other projects in this collection (see dependencies further below).
*** Example usage
A growing number (currently ~40) of small examples are included in this repo under the =/examples= directory:
Interactive examples:
Growing list of [[http://workshop.thi.ng/][thi.ng workshop]] repositories (These workshops were running on a monthly basis & internationally in 2015/2016):
A preliminary list of other projects using this library:
*** Project structure
Use the diagram below to quickly navigate to any namespace in the project. Nodes in the graph have tooltips with a brief description of each namespace. Note: Due to GH restrictions on SVG files, first click anywhere on the diagram before trying to navigate to a specific namespace.
[[http://dev.thi.ng/geom/overview2.svg]]
*** Main features (non-exhaustive list)
*** API scope
Since the core library does only deal with pure "platonic" geometry types, it doesn't directly address any display or rendering functionality at all. However a number of support modules are provided, incl. OpenGL 3/4, WebGL & SVG support, to allow visualizing results and/or exporting generated assets. 2D/3D shape/mesh exporters are provided as well and together with sister libraries like [[https://github.com/thi-ng/luxor][thi.ng/luxor]], it's also possible to generate complete 3D scenes for high quality & high resolution non-realtime rendering using [[https://github.com/LuxRender][Luxrender]] now [[https://luxcorerender.org/][LuxCoreRender]].
Furthermore, providing all functionality under a common API for both Clojure & Clojurescript, makes it trivial to offload heavy operations (e.g. large mesh processing) to the server side.
** Project structure *** core
[[./src/thi/ng/geom/core/][source]]
These namespaces define the core functionality of this library, including the approx. 50 protocols and implementations of fundamental geometry types/functions like 2d/3d vector algebra, matrices, quaternion (+ related convenience constructors & conversions)
*** types
[[./src/thi/ng/geom/][source]]
This directory contains all high-level 2d/3d data types with their implementations of the various core protocols. From a user perspective, these namespaces defined here provide most of this project's core functionality.
*** utils
[[./src/thi/ng/geom/utils/][source]]
A number of often needed utility functions to deal with point collections, normals, path sampling, triangle properties etc. Also included here are shape intersection tests, curve subdivisions and 2D Delaunay triangulation.
*** mesh
[[./src/thi/ng/geom/mesh/][source]]
Several tools & operations related to working with 3d meshes, incl. I/O, subdivisions, repair / cleaning, CSG / Boolean mesh merge, mesh generators (polyhedra, lathe etc.)
*** physics
[[./src/thi/ng/geom/physics/][source]]
This module provides a simple 2d/3d particle-based physics engine with Verlet integration and support for custom behaviors and constaints, both for individual particles and global. Particles can be connected with springs of varying stiffness as well as made interdependent using positive or negative force fields (attractors).
*** svg
[[./src/thi/ng/geom/svg/][source]]
A module to help with building SVG based visualizations of geom entities using hiccup compatible syntax. Includes a customizable 3D mesh renderer w/ software shader support.
*** viz
[[./src/thi/ng/geom/viz/][source]]
Declarative, highly customizable 2D data visualization module with ~10 different layout methods, 3 axis types, cartesian and polar domain support. Currently SVG only, but planned to be format-independent.
*** voxel
[[./src/thi/ng/geom/voxel/][source]]
An experimental implementation of a in-memory sparse voxel tree (SVO) and related functionality to extract isosurface polygon meshes from the tree.
*** OpenGL & WebGL
[[./src/thi/ng/geom/gl/][source]]
This module provides a unified API to common OpenGL/WebGL functionality (context creation, shader management & presets, buffer management, textures, FBO etc.), as well as a number of optimized mesh types, conversion & rendering functions, cameras etc. to simplify the use of other geometry types defined in this project with OpenGL, both on the desktop and in the browser. The Clojure version wraps JOGL.
** Release history & changelog
See [[./CHANGELOG.org][CHANGELOG.org]] for further details.
| Version | Released | Lein coordinates | Tagged Github URL | |-----------+------------+-----------------------------+--------------------------------------------------------------| | 1.0.1 | 2023-10-23 | =[thi.ng/geom "1.0.1"]= | [[https://github.com/thi-ng/geom/tree/1.0.1][1.0.1]] | | 1.0.0 | 2023-01-22 | =[thi.ng/geom "1.0.0"]= | [[https://github.com/thi-ng/geom/tree/1.0.0][1.0.0]] | | 1.0.0-RC5 | 2022-04-23 | =[thi.ng/geom "1.0.0-RC5"]= | [[https://github.com/thi-ng/geom/tree/1.0.0-RC5][1.0.0-RC5]] | | 1.0.0-RC4 | 2019-10-07 | =[thi.ng/geom "1.0.0-RC4"]= | [[https://github.com/thi-ng/geom/tree/1.0.0-RC4][1.0.0-RC4]] | | 1.0.0-RC3 | 2018-06-01 | =[thi.ng/geom "1.0.0-RC3"]= | [[https://github.com/thi-ng/geom/tree/1.0.0-RC3][1.0.0-RC3]] | | 1.0.0-RC2 | 2018-06-01 | =[thi.ng/geom "1.0.0-RC2"]= | [[https://github.com/thi-ng/geom/tree/1.0.0-RC2][1.0.0-RC2]] | | 1.0.0-RC1 | 2018-05-31 | =[thi.ng/geom "1.0.0-RC1"]= | [[https://github.com/thi-ng/geom/tree/1.0.0-RC1][1.0.0-RC1]] | | 0.0.908 | 2015-11-08 | =[thi.ng/geom "0.0.908"]= | [[https://github.com/thi-ng/geom/tree/r908][r908]] | | 0.0.881 | 2015-06-21 | =[thi.ng/geom "0.0.881"]= | [[https://github.com/thi-ng/geom/tree/r881][r881]] | | 0.0.859 | 2015-06-15 | =[thi.ng/geom "0.0.859"]= | [[https://github.com/thi-ng/geom/tree/r856][r859]] | | 0.0.856 | 2015-06-14 | =[thi.ng/geom "0.0.856"]= | [[https://github.com/thi-ng/geom/tree/r856][r856]] | | 0.0.815 | 2015-06-01 | =[thi.ng/geom "0.0.815"]= | [[https://github.com/thi-ng/geom/tree/r815][r815]] | | 0.0.803 | 2015-05-26 | =[thi.ng/geom "0.0.803"]= | [[https://github.com/thi-ng/geom/tree/r803][r803]] | | 0.0.783 | 2015-04-27 | =[thi.ng/geom "0.0.783"]= | [[https://github.com/thi-ng/geom/tree/r783][r783]] | | 0.0.770 | 2015-03-29 | =[thi.ng/geom "0.0.770"]= | [[https://github.com/thi-ng/geom/tree/r770][r770]] | | 0.0.743 | 2015-03-23 | =[thi.ng/geom "0.0.743"]= | [[https://github.com/thi-ng/geom/tree/r743][r743]] | | 0.0.737 | 2015-03-22 | =[thi.ng/geom "0.0.737"]= | [[https://github.com/thi-ng/geom/tree/r737][r737]] | | 0.0-725 | 2015-03-15 | =[thi.ng/geom "0.0-725"]= | [[https://github.com/thi-ng/geom/tree/r725][r725]] | | 0.0-715 | 2015-02-25 | =[thi.ng/geom "0.0-715"]= | [[https://github.com/thi-ng/geom/tree/r715][r715]] | | 0.0-709 | 2015-02-22 | =[thi.ng/geom "0.0-709"]= | [[https://github.com/thi-ng/geom/tree/r709][r709]] | | 0.2.0 | 2014-03-10 | =[thi.ng/geom "0.2.0"]= | [[https://github.com/thi-ng/geom/tree/0.2.0][0.2.0]] |
** Contributors
** License
(c) 2013 - 2023 Karsten Schmidt
This project is open source and licensed under the [[http://www.apache.org/licenses/LICENSE-2.0][Apache Software License 2.0]].