sr
simple-raytracer
npm i simple-raytracer
sr

simple-raytracer

simple-raytracer works as a standalone version of the JS raytracer found in distracer.io, which was inspired by jsRayTracer. It's purpose is to offer a simple raytracing interface that can be run locally in, in a distributed fashion on a server or even in browsers

by David Dias

2.0.0 (see all)License:MITTypeScript:Not FoundCategories:Vanilla JavaScript 3D
npm i simple-raytracer
Readme

simple-raytracer

Build Status Dependency Status

simple-raytracer works as a standalone version of the JS raytracer found in distracer.io, which was inspired by jsRayTracer. It's presents a very simple interface to break a Ray Tracing job into multiple tasks that can be run sequentially or in parallel.

What is Ray Tracing?

tl;dr; In computer graphics, ray tracing is a technique for generating an image by tracing the path of light through pixels in an image plane and simulating the effects of its encounters with virtual objects.

The original authors of jsRayTracer offer a great in depth explanation of how Ray Tracing works and how the core of this module performs it. Worth checking it out.

If you would like to know more, wikipedia has your back

What does this module offer

A simple interface to execute a ray tracing job over a 'world' or 'scene' described in CSS, from scene parser, to job task partition, to the actual individual ray trace task and finally how to glue the results together so you can get your rendered image.

A great place to start is by checking the examples folder to see how to run it using Node.js or using the browser only.

API

/* require the module */
const srt = require('simple-raytracer');

/* load a scene */
const scene = srt.prepareScene.byPath(<path/to/scene/file>);

/* create individual tasks, each one is a work unit */
const tasks = srt.prepareTasks({
  split: 20,
  width: scene.global.width,
  height: scene.global.height
});

/* use srt.runTask to execute each of them */
const rayTraceResult = srt.runTask(scene, tasks[0]);

Example of running it with Node

You can find the example here, it is using pngjs to export the image to a .png to export the render to png. To run it simply do:

git clone git@github.com:diasdavid/simple-raytracer.git
cd simple-raytracer
npm i
cd examples/node
node index.js

Example of running it in the browser with browserify

You can find the example here. To run it simply do:

git clone git@github.com:daviddias/simple-raytracer.git
cd simple-raytracer
npm i
cd examples/browser
node serve.js
open your browser in http://localhost:9000

Acknowledgements

This module was initialy developed as part of David Dias' M.Sc Thesis project, browserCloudjs, under supervision by Luís Veiga, Distributed Systems Group @ INESC-ID Lisboa , Instituto Superior Técnico, Universidade de Lisboa, with the support of Fundação para a Ciência e Tecnologia.

More info on the team's work at:

Additionall thanks to Diogo Cunha and Pierre Ozoux for creating distracer.io and Igor Soarez for reviewing and helping me solve a gnarly bug :)

Downloads/wk

9

GitHub Stars

21

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
2.0.0
latest
2yrs ago
No tutorials found
Add a tutorial