README

Polyform is for loading, generating, editing, and exporting 3D geometry and it's associated data.

Developers and artists are welcome to join the Discord to share feedback, get help, or discuss feature requests.

Quickstart

If you just want to play around without setting polyform up locally, you can check it out here

Pre-built binaries

Download the latest release of polyform and one of the example graphs and then run:

polyform <downloaded_example>.json edit

Go

Or if you have golang installed, simply clone the repo and run:

go run ./cmd/polyform ./examples/graphs/ufo.json edit

Nix

Or if you have Nix installed, run with:

nix run .#polyform ./examples/graphs/ufo.json edit

# List all available packages
nix flake show

Overview

• Formats

  • gltf - GLTF file format
  • obj - OBJ file format
  • ply - PLY file format
  • stl - STL file format
  • colmap - Utilities for loading COLMAP reconstruction data
  • opensfm - Utilities for loading OpenSFM reconstruction data
  • splat - Mkkellogg's SPLAT format
  • spz - Niantic Scaniverse's SPZ format
  • potree - Potree V2 file format
• Modeling

  • meshops - All currently implemented algorithms for transforming meshes.
  • marching - Multi-threaded Cube Marching algorithm and utilities.
  • extrude - Functionality for generating geometry from 2D shapes.
  • repeat - Functionality for copying geometry in common patterns.
  • primitives - Functionality pertaining to generating common geometry.
  • triangulation - Generating meshes from a set of 2D points.
• Drawing

  • coloring - Color utilities for blending multiple colors together using weights.
  • texturing - Traditional image processing utilities (common convolution kernels).

    • normals - Utilities for generating and editing normal maps.
• Math

  • colors - Making working with golang colors not suck as much.
  • curves - Common curves used in animation like cubic bezier curves.
  • geometry - AABB, Line2D, Line3D, Plane, and Rays.
  • noise - Utilities around noise functions for common usecases like stacking multiple samples of perlin noise from different frequencies.
  • quaternion - Quaternion math and helper functions
  • trs - Math and utilities around TRS transformations
  • sample - Serves as a group of definitions for defining a mapping from one numeric value to another
  • sdf - SDF implementations of different geometry primitives, along with common math functions. Basically slowly picking through Inigo Quilez's Distfunction article as I need them in my different projects.
• Generator - Application scaffolding for editing and creating meshes
• Trees - Implementation of common spatial partitioning trees.

Packages that have spawned from polyform's undertaking and have since been refactored into their own repositories:

• Node Flow - Another Flow-based Node Graph Library
• vector - Immutable vector math library
• jbtf - GLTF-inspired JSON schema for embedding arbitrary binaries
• iter - Iterator and utilities. Some inspiration from ReactiveX
• quill - Scheduler of operations on in-memory data
• sfm - Utilities for interacting with reconstruction data from different SFM programs
• bitlib - Utilities for reading and writing binary data

Procedural Generation Examples

You can at the different projects under the examples folder for different examples on how to procedurally generate meshes.

Evergreen Trees

This was my submission for ProcJam 2022. Pretty much uses every bit of functionality available in this repository.

[Source Here]

Evergreen Tree Demo

Evergreen Terrain Demo

Other Examples

[Source Here]	[Source Here]
[Source Here]	[Source Here]
[Source Here]	[Source Here]

Developing

If you so happen to want to build a configurator example, my preferred workflow is:

Set up the example to use the generator package that allows you to quickly spin up a web viewer to visualize the geoemetry of your program.

Use air to live reload the examples as you build them out. Set cmd = "go build -o ./tmp/main.exe ./examples/MY_EXAMPLE". Set include_ext = ["go", "tpl", "tmpl", "html", "js"].

air edit --port 8080

As you hit save on your go code, the webserver will restart, and the web page will automatically refresh itself.

If you want to mess with modern web browser features and need https, I recommend taking a look at https://github.com/FiloSottile/mkcert

mkcert -install
mkcert -key-file key.pem -cert-file cert.pem localhost
air edit --port 8080 --ssl

# And if you want to connect with your headset
air edit --port 8080 --ssl --host 0.0.0.0

WASM Deployment

Compile the polywasm app

go install ./cmd/polywasm

Build your app

GOOS=js GOARCH=wasm go build -ldflags="-w -s" -o main.wasm ./cmd/polyform
polywasm build --wasm main.wasm

Then serve

polywasm serve

Processing Example

Reads in a obj and applies the cube marching algorithm over the meshes 3D SDF.

package main

import (
  "github.com/EliCDavis/polyform/formats/obj"
  "github.com/EliCDavis/polyform/modeling"
  "github.com/EliCDavis/polyform/modeling/marching"
  "github.com/EliCDavis/polyform/modeling/meshops"
  "github.com/EliCDavis/vector"
)

func main() {
  loadedMesh, _ := obj.Load("test-models/stanford-bunny.obj")

  resolution := 10.
  scale := 12.

  transformedMesh := loadedMesh.Transform(
    meshops.Center3DTransformer{},
    meshops.Scale3DTransformer{Amount: vector3.Fill(scale)},
  )

  canvas := marching.NewMarchingCanvas(resolution)
  meshSDF := marching.Mesh(transformedMesh, .1, 10)
  canvas.AddFieldParallel(meshSDF)

  obj.Save("chunky-bunny.obj", canvas.MarchParallel(.3))
}

Results in:

Chunky Bunny

Todo List

Progress towards V1...

• Finalize Material Definition (or remove and defer to file format specifications)

• Finalize Node error propogation flow

• Cleanup Node interface

• Finalize package organization for node equivalent functionality (ie vector3 => vecn3)

• Proper WASM Deployment

Things I want to implement eventually...

• Cube Marching

• Bezier Curves

• Slice By Plane

• Slice By Bounding Box

• Constrained Delaunay Tesselation

• Meshing Pipeline

• Bones / Animations

• Quadric Error Decimation

• Proper Build Pipeline

• Documentation Website

• Primitive Meshes

  • Cube

  • Sphere

    • UV

    • Ico

    • Quad

  • Cylinder

  • Quad

  • Circle

  • Cone

  • Capsule

  • Hemisphere

  • Rounded Cube

• SDFs

  • Box

  • Line

  • Plane

  • Sphere

  • Rounded Cylinder

  • Rounded Box

  • Torus

  • Box Frame

  • Cone

  • Rounded Cone

  • Elipsoid

  • Triangle

• 3D Tesselation

• Slice By Octree

• Poisson Reconstruction

• Buncha texture patterns

• Noise...

  • Simplex

• Splines...

  • Catmull

  • B Spline

Resources

Resources either directly contributing to the code, or are just interesting finds while researching.

• Noise

  • Perlin Noise

    • Perlin Worms
    • Perline Noise Chapter 5 from "Ray Tracing The Next Week by Peter Shirley
    • Improving Noise By Ken Perlin

      • Java Implementation
      • C# Implementation by Keijiro
  • Worley/Cellular Noise
  • Book of Shaders on Noise
  • Simplex Noise
  • Stable Fiddusion: Frequency-domain blue noise generator by Steven Wittens
  • Tiling Noise

    • Tiling Noise by Ronja
    • gamedev.stackexchange How do you generate tileable Perlin noise?
• Triangulation

  • Delaunay

    • Bowyer–Watson

      • A short video overview
      • General Algorithm Description
    • Constraint/Refinement

      • Computing Constrained Delaunay Traingulations By Samuel Peterson
    • 3 Points To Create a Circle
  • Chew's Second Algorithm
  • Polygons

    • Wikipedia
    • Fast Polygon Triangulation Based on Seidel's Algorithm By Atul Narkhede and Dinesh Manocha
    • Triangulating a Monotone Polygon
  • Spheres

    • UV, Ico, Quad
• Texturing

  • Normal Map From Color Map
• Formats

  • OBJ/MTL

    • jburkardt MTL
    • Excerpt from FILE FORMATS, Version 4.2 October 1995 MTL
  • Just a ton of formats
  • GLTF

    • 2.0 Repo
    • Animations
    • Full 2.0 Spec
    • Viewer for Skeleton
• Generative Techniques

  • Country Flags by vividfax
  • Snow by Ryan King
  • Terrain

    • World Gen by Leather Bee
    • Procedural Hydrology: Dynamic Lake and River Simulation By: Nicholas McDonald
    • The Canyons of Your Mind By JonathanCR
    • Simulating hydraulic erosion By Job Talle
    • Coastal Landforms for Fantasy Mapping
  • Planet

    • Planet Generation
    • Procedural Gas Giant Planet Textures
  • Taming Randomness
  • Plants

    • Algorithmic Botany

      • A common developmental program can produce diverse leaf shapes by Adam Runions1, Miltos Tsiantis and Przemyslaw Prusinkiewicz
      • L-SYSTEMS: FROM THE THEORYTO VISUAL MODELS OF PLANTS by Przemyslaw Prusinkiewiczy, Mark Hammely, Jim Hananz, and Radomir Mechy
    • L-System User Notes Written by Paul Bourke
    • L System On Wikipedia
    • An Introduction to Lindenmayer Systems by Gabriela Ochoa
• Voronoi

  • Voronoi Edges by Inigo Quilez
• Functions / Curves / Animation Lines

  • Interpolation and Animation
  • Cubic Bézier by Maxime
• Marching Cubes / SDFs

  • LUT
  • Coding Adventure: Marching Cubes By Sebastian Lague
  • SDFs
  • Fast 2D SDF
  • Got Subtraction from Here
• Collisions

  • Closest point on Triangle
• Ray Tracing

  • Ray Tracing in One Weekend by Peter Shirley
  • Ray Tracing: The Next Week
  • Möller-Trumbore Ray-Triangle Intersection
  • Simulating the Colors of The Sky
• Math

  • Mat3x3 => Quaternion from Blender Source
• SkinningVolumetric Heat Diffusion Skinning by Wolfire Games
• Color Space

  • Threejs on Color Management
  • Threejs Colorspace conversion
  • Bartosz Ciechanowski on Color Spaces
• WFC

  • "The Wavefunction Collapse Algorithm explained very clearly" - Robert Heaton
  • Source code for "The Wavefunction Collapse Algorithm explained very clearly"
• UV Unwrapping

  • "ABF++ : Fast and Robust Angle Based Flattening" Alla Sheffer Bruno Levy Maxim Mogilnitsky Alexander Bogomyakov
  • OptCuts: Joint Optimization of Surface Cuts and Parameterization

    • Source Code
    • Paper
  • "Variational Surface Cutting" by Sharp & Crane, SIGGRAPH 2018

    • Source Code
    • Paper
  • Boundary First Flattening by Rohan Sawhney and Keenan Crane.

    • Source Code
    • Paper
• Drawing a Line

  • Did not expect to need to look that up

  • Bresenham's line algorithm (Aliased)
  • Xiaolin Wu's line algorithm (Anti-Aliased)
• Materials

  • The PBR Guide Part 2
• Flow Based Programming

  • Wikipedia Article
  • Repositories

    • Scipipe
    • Flowbase
    • Goflow
    • Gofbp
    • flow-based-programming
  • Articles

    • Flow-based Programming by J Paul Rodker Morrison
• Guassian Splatting

  • https://github.com/antimatter15/splat
  • https://github.com/mkkellogg/GaussianSplats3D
  • https://github.com/shg8/VulkanSplatting
  • Making Gaussian Splats Smaller by Aras Pranckevičius
  • Gaussian Explosion by Aras Pranckevičius
  • Rotating

    • Thread on Rotating
    • Winger D Matrix Wikipedia Article (required for rotating spherical harmonics)
• Coloring Stuff

  • Color Grading LUT

    • 3D Game Shaders For Beginners - Lookup Table (LUT) by David Lettier
  • Chromatic Aberration

    • TomasHubelbauer/canvas-chromatic-aberration
• Point Cloud Rendering

  • "Real-time Rendering of Massive Unstructured Raw Point Clouds using Screen-space Operators" Ruggero Pintus, Enrico Gobbetti, and Marco Agus
  • "Raw point cloud deferred shading through screen space pyramidal operators" Hassan Bouchiba, Jean-Emmanuel Deschaud, Francois Goulette
  • "THE PULL-PUSH ALGORITHM REVISITED" Martin Kraus

Web Libraries

Libraries the Webviewer depends on in some capacity

• three.js
• GaussianSplats3D
• dat.gui

Citiation

If Polyform contributes to an academic publication, cite it as:

@misc{polyform,
  title = {Polyform},
  author = {Eli Davis},
  note = {https://www.github.com/EliCDavis/polyform},
  year = {2024}
}