README.md

SDF Viewer Go

SDF Viewer integration for Go libraries. This allows you to design 3D models in Go using Signed Distance Functions while visualizing the results as fast as possible. Check out the SDF Viewer App's README for more information.

Go modules included in this repository:

• sdf-viewer-go: Pure Go implementation of the SDF Viewer API. Usage example.
• sdf-viewer-go-auto: Utilities for the automatic implementation of the sdf-viewer-go API.
• sdf-viewer-go-sdfx: SDFX implementation of the SDF Viewer API. Usage example.
• sdf-viewer-go-sdf: SDF (fork of SDFX by soypat) implementation of the SDF Viewer API. Usage example.

This project uses TinyGo to build the WebAssembly binary (for now) as the Go Compiler can't export WebAssembly functions. This means that it won't "be able to compile every Go program out there", but should be good enough for most projects. It is also slower to build (and run) than the Go Compiler.

Quickstart (SDFX)

Write the following main.go file:

package main

import (
	sdfviewergo "github.com/Yeicor/sdf-viewer-go/sdf-viewer-go"
	sdfviewergosdfx "github.com/Yeicor/sdf-viewer-go/sdf-viewer-go-sdfx"
	. "github.com/deadsy/sdfx/sdf"
)

//export init
func init() {
	// This is the only function you need to call to initialize the SDF Viewer.
	sdfviewergo.SetRootSDF(sceneSDF())
}

// sceneSDF returns the root SDF of the scene.
func sceneSDF() sdfviewergo.SDF {

	// Simple scene:
	box, _ := Box3D(V3{X: 1., Y: 1., Z: 1.}, 0.25)
	cyl, _ := Cylinder3D(1.5, 0.25, 0.25)
	sdfxSDF := Union3D(box, cyl)
	cyl2, _ := Cylinder3D(1.5, 0.25, 0.25)
	cyl2rot := Transform3D(cyl2, RotateY(DtoR(90)))
	sdfxSDF = Difference3D(sdfxSDF, cyl2rot)

	return sdfviewergosdfx.NewSDF(sdfxSDF)
}

The build command is:

tinygo build -o example.wasm -target wasi -opt 2 -x -no-debug .

Then just open the generated WebAssembly file with SDF Viewer App:

sdf-viewer app url relative/path/to/example.wasm

Or, on a web browser that also publishes the WebAssembly file:

http://localhost:8080/?cliurl=relative/path/to/example.wasm&envdark

If you want to automate reloading the object when the source code changes

Set up a server process that will automatically build the WebAssembly file when the Go file changes, and send the updated file to the SDF Viewer App:

sdf-viewer server -s relative/path/to/example.wasm -w relative/path/to/main.go -b /bin/sh -b \-c -b "cd relative/path/to/ && tinygo build -o example.wasm -target wasi -opt 2 -x -no-debug -wasm-abi generic ."

Connect the app to this server process:

sdf-viewer app url http://localhost:8080/relative/path/to/example.wasm

Or, on a web browser with access to the local server:

http://localhost:8080/?cliurl=http://localhost:8080/relative/path/to/example.wasm&envdark

Demo: phone case

This is the SDFX example generated from this source file. View it online or download the WebAssembly file to view it on the desktop app.

The demo was recorded at a lower framerate, but it runs in real time on an integrated graphics card.