Sync repos

.babelrc

@@ -0,0 +1,5 @@
+{
+  "presets": [
+    ["@babel/preset-env"]
+  ],
+}

.eslintrc

@@ -0,0 +1,16 @@
+{
+  "env": {
+    "browser": true,
+    "es6": true,
+    "jest": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 9,
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-console": 0,
+    "semi": 1
+  }
+}

.gitignore

@@ -0,0 +1 @@
+node_modules

CODEOWNERS

@@ -0,0 +1 @@
+*   @elfrank @jaxry @lyonsno

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 HOVER
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Brief Description
+Please include a **summary** of the change and/or which issue is fixed. Please also include *relevant motivation and context*.
+
+## Image(s) or GIFs (if applicable)
+TODO or DELETE
+
+## Pull Request Guidelines
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] I have added pull requests labels which describe my contribution.
+- [ ] All existing tests passed.
+    - [ ] I have added tests to cover my changes, of which pass.
+- [ ] I have [compared](https://github.com/hoverinc/ray-tracing-renderer/wiki/Contributing#comparing-changes) the render output of my branch to `master`.
+- [ ] My code has passed the ESLint configuration for this project.
+- [ ] My change requires modifications to the documentation.
+    - [ ] I have updated the documentation accordingly.

README.md

@@ -0,0 +1,69 @@
+
+
+
+# Ray Tracing Renderer
+A [Three.js](https://github.com/mrdoob/three.js/) renderer which utilizes path tracing to render a scene with true photorealism. The renderer supports global illumination, reflections, soft shadows, and realistic environment lighting.
+
+[User Guide](https://github.com/hoverinc/ray-tracing-renderer/wiki/User-Guide) | [API Reference](https://github.com/hoverinc/ray-tracing-renderer/wiki/RayTracingRenderer) | [Contributing](https://github.com/hoverinc/ray-tracing-renderer/wiki/Contributing)
+
+
+## Usage
+
+RayTracingRenderer is the *early alpha stage* of development. Features are incomplete and subject to change, and the renderer is unstable on certain hardware.
+### Download
+
+* [Latest ES6 Build](https://raw.githubusercontent.com/hoverinc/ray-tracing-renderer/master/build/RayTracingRenderer.js)
+* [Latest ES5 Build](https://raw.githubusercontent.com/hoverinc/ray-tracing-renderer/master/build/RayTracingRenderer.es5.js)
+
+Or if you use npm, run
+`npm install git+ssh://github.com/hoverinc/three.js-ray-tracing-renderer`
+
+Ray Tracing Renderer relies on WebGL2, and any browser supporting WebGL2 also supports ES6. Thus, you should only use the ES5 build if the renderer inside your appliaction is *optional*, and your application must support older browsers.
+
+### Installation
+#### As an HTML script
+Ray Tracing Renderer requires Three.js, so make sure it is included in your html first. Then include,
+```javascript
+<script src="RayTracingRenderer.js"></script>
+```
+
+You can then use the renderer in your app.
+
+```javascript
+const renderer = new THREE.RayTracingRenderer();
+```
+#### As a module
+If you installed via npm, simply import the renderer as follows.
+```javascript
+import { RayTracingRenderer } from 'three.js-ray-tracing-renderer'
+```
+Or if you downloaded the renderer as a file,
+```javascript
+import { RayTracingRenderer } from './RayTracingRenderer.js'
+```
+The renderer can then be used in your app.
+```javascript
+const renderer = new RayTracingRenderer();
+```
+
+## Introduction
+Ray Tracing Renderer serves as a drop-in replacement to Three.js's [WebGLRenderer](https://threejs.org/docs/#api/en/renderers/WebGLRenderer). By simply swapping renderers, you can get instant photorealistic lighting.
+
+[![](preview.jpg)](https://hover-demos.s3.amazonaws.com/ray-tracing-renderer/readme-example/index.html)
+[(Click to run example)](https://hover-demos.s3.amazonaws.com/ray-tracing-renderer/readme-example/index.html)
+
+Ray Tracing Renderer runs on WebGL2, and does so by implementing a [path tracing](https://en.wikipedia.org/wiki/Path_tracing) algorithm inside a shader. It supports arbitrary Three.js scenes, with some restrictions.
+
+### Features
+* **Global illumination.** Surfaces are illuminated with light reflected from every surface, not just manually placed light sources. This results in natural looking renders with realistic light bouncing and propagation.
+* **Soft Shadows.** Shadows are computed automatically without the need to configure shadow properties on Three.js's light sources. The resulting shadows are soft and true-to-life without any visual artifacts.
+* **Reflections.** Shiny and metallic surfaces reflect their surroundings, greatly attributing to realism.
+* **Environment lighting.** A new light type has been added which dynamically illuminates a scene entirely from an HDR environment map! Manually placed light sources are a thing of the past.
+
+### Limitations
+* **Progressive rendering.** Path tracing is a progressive method. This means that the more computation time that is spent on rendering, the better the resulting image looks. In order to render a high quality image, the camera must stay still for several seconds, as the render gradually improves. This is in stark contract to WebGLRenderer's method which is able to render a full quality image in one frame.
+* **Static geometry**. A BVH acceleration structure is computed for the scene to speed up ray intersections. This computation can take several seconds when first initializing the renderer, and it must be recomputed whenever scene geometry moves or changes. Therefore only camera movement is supported in real-time.
+
+We are currently developing solutions to both these limitations, so that a full, noise-free render can be rendered in just one frame, as well as being able to support dynamic geometry.
+
+For a more detailed guide on how to use the renderer, please read the [User Guide](https://github.com/hoverinc/ray-tracing-renderer/wiki/User-Guide) .