Initial squashed commit!

Author: sukanya aneja

.eslintignore

@@ -0,0 +1 @@
+*.js

.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+  },
+  parser: '@typescript-eslint/parser',
+  extends: ['plugin:@typescript-eslint/recommended'],
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  ignorePatterns: ['dist/**', 'lib/**', 'examples/installation/**']
+}

.gitignore

@@ -0,0 +1,6 @@
+*.swp
+*.swo
+node_modules
+lib
+temp
+etc

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "bracketSpacing": true,
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 2, 
+  "trailingComma": "all"
+}

CHANGELOG.md

@@ -0,0 +1,5 @@
+## v1.0
+
+### v1.0.0
+
+- First public release!

CODEOWNERS

@@ -0,0 +1,6 @@
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the
+# repo. Unless a later match takes precedence, these owners will be
+# requested for review when someone opens a pull request.
+* @Avnerus

CODE_OF_CONDUCT.md

@@ -0,0 +1,47 @@
+---
+layout: code-of-conduct
+version: v1.0
+---
+
+This code of conduct outlines our expectations for participants within **The New York Times** Open Source community, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates this code of conduct may be banned from the community.
+
+Our open source community strives to:
+
+* **Be friendly and patient.**
+* **Be welcoming**: We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
+* **Be considerate**: Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
+* **Be respectful**:  Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one.
+* **Be careful in the words that we choose**: we are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable.
+* **Try to understand why we disagree**: Disagreements, both social and technical, happen all the time. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of our community comes from its diversity, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
+
+### Diversity Statement
+
+We encourage everyone to participate and are committed to building a community for all. Although we will fail at times, we seek to treat everyone both as fairly and equally as possible. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong.
+
+Although this list cannot be exhaustive, we explicitly honor diversity in age, gender, gender identity or expression, culture, ethnicity, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected
+characteristics above, including participants with disabilities.
+
+### Reporting Issues
+
+If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via **[email protected]**. All reports will be handled with discretion. In your report please include:
+
+- Your contact information.
+- Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please
+include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link.
+- Any additional information that may be helpful.
+
+After filing a report, a representative will contact you personally, review the incident, follow up with any additional questions, and make a decision as to how to respond. If the person who is harassing you is part of the response team, they will recuse themselves from handling your incident. If the complaint originates from a member of the response team, it will be handled by a different member of the response team. We will respect confidentiality requests for the purpose of protecting victims of abuse.
+
+### Attribution & Acknowledgements
+
+We all stand on the shoulders of giants across many open source communities.  We'd like to thank the communities and projects that established code of conducts and diversity statements as our inspiration:
+
+* [Django](https://www.djangoproject.com/conduct/reporting/)
+* [Python](https://www.python.org/community/diversity/)
+* [Ubuntu](http://www.ubuntu.com/about/about-ubuntu/conduct)
+* [Contributor Covenant](http://contributor-covenant.org/)
+* [Geek Feminism](http://geekfeminism.org/about/code-of-conduct/)
+* [Citizen Code of Conduct](http://citizencodeofconduct.org/)
+
+This Code of Conduct was based on https://github.com/todogroup/opencodeofconduct
+

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Introduction
+
+Thank you for considering contributing the 3D Tiles loader.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the loader itself.
+
+**HINT**: Check the [Roadmap section](https://github.com/nytimes/threebird-loader-3d-tiles#roadmap) in the README, as well as `//TODO` comments within the code hinting at pending tasks.
+
+# Ground Rules
+
+ * Use Typescript and proper typings for all of the code that you write.
+ * Create a test for any new feature.
+ * Write [typedoc comments](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) for new information.
+ * Ensure cross-browser compatibility for every change. Refer to the `browserslist` field in [package.json](./package.json) for target browsers.
+ * Keep feature versions as small as possible, preferably one new feature per version.
+ * Refer to [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
+ 
+
+# Getting started
+
+Build instructions are available in the main [README](./README.md). To contribute, follow these steps:
+
+1. Create your own fork of the code
+2. Do the changes in your fork (**don't forget to write tests and generate documentation!**).
+
+3. If you like the change and think the project could use it. Send a pull request. Thank you!
+
+# How to report a bug
+If you find a security vulnerability, do NOT open an issue. Please report the vulnerability to the person or team maintaining the code. (refer to [SECURITY.md](./SECURITY.md)).
+
+ When filing an issue, make sure to answer these five questions:
+
+1. What version of Three.js you are using?
+2. What browser and operating system are you using? What graphics card?
+3. What did you do?
+4. What did you expect to see?
+5. What did you see instead?
+
+# How to suggest a feature or enhancement
+
+If you find yourself wishing for a feature that doesn't exist in the 3D tiles loader, you are probably not alone. There are bound to be others out there with similar needs. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
+
+Thank you for contributing!

LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2020 The New York Times Company
+ 
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this library except in compliance with the License.
+You may obtain a copy of the License at
+ 
+[www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+ 
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

README.md

@@ -0,0 +1,179 @@
+# @threebird/loader-3d-tiles  
+![license](https://img.shields.io/badge/License-Apache%202.0-yellow.svg) ![version](https://img.shields.io/badge/version-1.0.0-blue)
+
+[Demos](#demos) —
+[Usage](#basic-usage) —
+[Roadmap](#roadmap) —
+[Contributing](#contributing) —
+[Docs](#docs) —
+[Alternatives](#alternatives)
+
+
+This is a [Three.js](https://threejs.org/) loader module for handling [OGC 3D Tiles](https://www.ogc.org/standards/3DTiles), created by [Cesium](https://github.com/CesiumGS/3d-tiles). It currently supports the two main formats:
+
+1. Batched 3D Model (b3dm) - based on glTF.
+2. Point cloud.
+
+Internally, the loader uses the [loaders.gl library](https://github.com/visgl/loaders.gl), which is part of the [vis.gl platform](https://vis.gl/), openly governed by the [Urban Computing Foundation](https://uc.foundation/). Cesium has [worked closely with loaders.gl](https://cesium.com/blog/2019/11/06/cesium-uber/) to create a platform-independent implementation of their 3D Tiles viewer.
+
+Development of this library started at The New York Times R&D as an effort to create a clean bridge between the 3D Tiles specification and the widely used 3D library Three.js. The library helps us deliver massive 3D and Geographical journalism to desktops and mobile readers alike. From **Re**porting to **Tele**porting!
+
+---
+
+## Demos
+* [Photogrammetry exported to 3D Tiles in RealityCapture](https://automatic-lamp-fd84a7c4.pages.github.io/examples/demos/realitycapture)
+* [LiDAR Point Cloud hosted as 3D Tiles in Cesium ION](https://automatic-lamp-fd84a7c4.pages.github.io/examples/demos/cesium)
+
+---
+
+## Basic Usage
+Here is a simple example using the `Loader3DTiles` module to view a `tileset.json` containing a 3d tile hierarchy.
+
+```javascript
+import { 
+  Scene, 
+  PerspectiveCamera, 
+  WebGLRenderer, 
+  Clock 
+} from 'three'
+import { Loader3DTiles } from '@threebird/loader-3d-tiles';
+
+const scene = new Scene()
+const camera = new PerspectiveCamera()
+const renderer = new WebGLRenderer()
+const clock = new Clock()
+
+renderer.setSize(window.innerWidth, window.innerHeight)
+document.body.appendChild(renderer.domElement)
+
+let tilesRuntime = null;
+
+async function loadTileset() {
+  const result = await Loader3DTiles.load(
+      url: 'https://<TILESET URL>/tileset.json',
+      renderer: renderer,
+      options: {
+        dracoDecoderPath: 'https://unpkg.com/[email protected]/examples/js/libs/draco',
+        basisTranscoderPath: 'https://unpkg.com/[email protected]/examples/js/libs/basis'        
+      }
+  )
+  const {model, runtime} = result
+  tilesRuntime = runtime
+  scene.add(model)
+}
+
+function render(t) {
+  const dt = clock.getDelta()
+  if (tilesRuntime) {
+    tilesRuntime.update(dt, renderer, camera)
+  }
+  renderer.render(scene, camera)
+  window.requestAnimationFrame(render)
+}
+
+render()
+```
+
+---
+
+## Installation
+
+The library depends on [three.js](https://threejs.org/) r129 and uses its GLTF, Draco, and KTX2/Basis loaders.
+Refer to the `browserslist` field in [package.json](./package.json) for target browsers.
+
+### 1. ES Module
+Download [dist/threebird-loader-3d-tiles.esm.min.js](dist/threebird-loader-3d-tiles.esm.min.js) and use an `importmap-shim` to import the dependencies. See [here](examples/installation/es-module) for a full example. The [demos](examples/demos) also use this method of installation:
+
+#### **`index.html`**
+  ```html
+  <script async src="https://unpkg.com/[email protected]/dist/es-module-shims.js"></script>
+  <script type="importmap-shim">
+    {
+      "imports": {
+        "three": "https://cdn.skypack.dev/[email protected]",
+        "three/examples/jsm/loaders/GLTFLoader": "https://cdn.skypack.dev/[email protected]/examples/jsm/loaders/GLTFLoader",
+        "three/examples/jsm/loaders/DRACOLoader": "https://cdn.skypack.dev/[email protected]/examples/jsm/loaders/DRACOLoader",
+        "three/examples/jsm/loaders/KTX2Loader": "https://cdn.skypack.dev/[email protected]/examples/jsm/loaders/KTX2Loader",
+        "@threebird/loader-3d-tiles" : "./threebird-loader-3d-tiles.esm.min.js"
+      }
+    }
+  </script>
+  <script src='index.js' type='module-shim'>
+
+  ```
+#### **`index.js`**
+  ```javascript
+  import { Scene, PerspectiveCamera } from 'three';
+  import { Loader3DTiles } from '@threebird/loader-3d-tiles';
+  ```
+
+### 3. NPM
+If you use a build system such as Webpack / Parcel / Rollup etc, you should also install the library along with three.js from npm:
+```
+npm install -s three @threebird/loader-3d-tiles
+```
+The application script would be the same as in the ES Module example (when using `importmap-shim`).
+
+See [here](examples/installation/webpack) for a complete webpack example.
+
+---
+## Roadmap 
+
+### Geo-referencing and layering: WGS84.
+
+Currently the library does not use geo-referenced locations of tiled models, instead transforming them to Point `[0,0,0]`. We should support maintaining *WGS84* coordinates, so that models could be layered on top of maps and terrains.
+
+## Skip-traversal
+Implementing the [Skip traversal mechanism](https://cesium.com/blog/2017/05/05/skipping-levels-of-detail/) could greatly improve performance of b3dm (mesh) tiles, but requires a shader/Stencil buffer-based implementation which manually manges Z-culling. This is a very wanted features and contributions would be greatly appreciated.
+
+
+## Contributing
+
+Refer to [CONTRIBUTING.MD](./CONTRIBUTING.md) for general contribution instructions.
+
+### Developing
+The library is built using rollup. To run a simple development server type:
+```
+npm run dev
+```
+It is also possible to develop the library while developing loaders.gl. Just clone the source of loaders.gl and run:
+```
+LOADERS_GL_SRC=<path to loaders.gl> npm run dev
+```
+
+### Building
+To build the library run:
+```
+npm run build
+```
+To build the production minified version run:
+```
+npm run build:production
+```
+And to build the API documentation run:
+```
+npm run build:docs
+```
+
+
+### Tests
+A rudimentary test spec is available at [./test](./test). To run it type:
+```
+npm run test
+```
+
+
+## Docs
+* API documentation is available [here](docs/loader-3d-tiles.md). 
+* Code for the demos is in [`examples/demos`](examples/demos).
+
+## Alternatives
+To our knowledge, this is the only [loaders.gl](https://github.com/visgl/loaders.gl)-based Three.js library, but there are several implementations of 3D Tiles for Three.js. Notable examples:
+
+ - [NASSA-AMMOS / 3DTilesRendererJS](https://github.com/NASA-AMMOS/3DTilesRendererJS)
+ - [ebeaufay / 3DTilesViewer](https://github.com/ebeaufay/3DTilesViewer)
+ - [iTowns](https://github.com/iTowns/itowns)
+
+ ---
+
+> This repository is maintained by the Research & Development team at The New York Times and is provided as-is for your own use. For more information about R&D at the Times visit [rd.nytimes.com](https://rd.nytimes.com)