Skip to content

Commit

Permalink
Release 5.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Kai Salmen committed Oct 16, 2022
1 parent cff00b0 commit 294699e
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 17 deletions.
22 changes: 13 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,22 @@

- Clean-up and uncluttering
- Remove all code related to worker online assembly and minification workarounds
- Fully rely on module workers. Use vite config to generate standard workers from module workers at build time
- Upgrade to versions `2.1.0` of `three-wtm` into `wtd-core`
- `OBJLoader2Parallel` is no longer using `WorkerTaskDirector`, but only using the generic `WorkerTask`
- Make parser independent and thereby reduce worker size to a minimum
- Transformed repository to npm workspaces
- Switched to vite for development and bundle creation
- `package.json` now exports:
- `wwobjloader2`: Unpacked javascript module code
- `wwobjloader2/bundle`: An esm bundle
- `wwobjloader2/worker`: The raw module parser worker
- `bundle/worker/module`: Pre-packaged module parser worker
- `bundle/worker/classic`: Pre-packaged classic parser worker
- Switched to vite for development and bundle creation [#63](https://github.com/kaisalmen/WWOBJLoader/issues/63)
- Webworker with three-wtm and webpack [#60](https://github.com/kaisalmen/WWOBJLoader/issues/60)
- Make parser independent and thereby reduce worker size to a minimum
- Fully rely on module workers. Use vite config to generate standard workers from module workers at build time
- `package.json` now exports:
- `wwobjloader2`: Unpacked javascript module code
- `wwobjloader2/bundle`: An esm bundle
- `wwobjloader2/worker`: The raw module parser worker
- `bundle/worker/module`: Pre-packaged module parser worker
- `bundle/worker/classic`: Pre-packaged classic parser worker
- Add @react-three/fiber examples [#69](https://github.com/kaisalmen/WWOBJLoader/pull/69)
- Explore aligning types with the core loaders [#68](https://github.com/kaisalmen/WWOBJLoader/issues/68)
- three.js versioning in package file [#65](https://github.com/kaisalmen/WWOBJLoader/issues/65)

## 4.0.1

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ In any environment the server is reachable on port 8085.

If you want to get started see take a look at the following examples. They get more advanced from top to bottom:

* OBJLoader2 basic usage: [[html](./packages/examples/obj2_basic.html)] [[js](./packages/examples/src/examples/OBJLoader2BasicExample.js)]
* OBJLoader2Parallel basic: [[html](./packages/examples/obj2parallel_basic.html)] [[js](./packages/examples/src/examples/OBJLoader2ParalleleBasicExample.js)]
* OBJLoader2 usage options: [[html](./packages/examples/obj2_options.html)] [[js](./packages/examples/src/examples/OBJLoader2OptionsExample.js)]
* OBJLoader2 / OBJLoader parser capability comparison: [[html](./packages/examples/obj2_obj_compare.html)] [[js](./packages/examples/src/examples/OBJLoader2OBJLoaderCompareExample.js)]
* OBJLoader2 in react with a .jpg texture: [[html](./packages/examples/obj2_react.html)] [[js](./packages/examples/src/examples/ReactExample.js)]
* OBJLoader2 in react with a .mtl material: [[html](./packages/examples/obj2_react-mtl.html)] [[js](./packages/examples/src/examples/ReactExampleMtl.js)]
* OBJLoader2 basic usage: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2_basic.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/OBJLoader2BasicExample.js)]
* OBJLoader2Parallel basic: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2parallel_basic.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/OBJLoader2ParalleleBasicExample.js)]
* OBJLoader2 usage options: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2_options.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/OBJLoader2OptionsExample.js)]
* OBJLoader2 / OBJLoader parser capability comparison: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2_obj_compare.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/OBJLoader2OBJLoaderCompareExample.js)]
* OBJLoader2 in react with a .jpg texture: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2_react.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/ReactExample.js)]
* OBJLoader2 in react with a .mtl material: [[html](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/obj2_react-mtl.html)] [[js](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/ReactExampleMtl.js)]

### Main Branches

Expand All @@ -53,7 +53,7 @@ The parser `OBJLoader2Parser` used by `OBJLoader2` and `OBJLoader2Parallel` has
* The `parse` methods of `OBJLoader2Parser` accepts `ArrayBuffer` or `String` as input. Text processing is approx. 15-20 pecent slower.
* In case `OBJLoader2Parallel` the of Parser `OBJLoader2Parser` is executed inside a worker.
* `OBJLoader2Parser` features indexed rendering including vertex reduction.
* Indexed rendering is available if switched on via `setUseIndices` (see `useIndices` in example **[OBJLoader2 usage options](./packages/examples/src/examples/OBJLoader2OptionsExample.js#L99)**).
* Indexed rendering is available if switched on via `setUseIndices` (see `useIndices` in example **[OBJLoader2 usage options](https://github.com/kaisalmen/WWOBJLoader/blob/main/packages/examples/src/examples/OBJLoader2OptionsExample.js#L99)**).
* Face N-Gons are supported.
* Multi-Materials are created when needed.
* Flat smoothing defined by "s 0" or "s off" is supported and Multi-Material is created when one object/group defines both smoothing groups equal and not equal to zero.
Expand Down
2 changes: 1 addition & 1 deletion packages/objloader2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"README.md"
],
"scripts": {
"clean": "npx shx rm -rf tsconfig.tsbuildinfo ./dist ./lib ./src/worker/OBJLoader2WorkerClassic.js ./src/worker/OBJLoader2WorkerModule.js",
"clean": "npx shx rm -rf tsconfig.tsbuildinfo ./dist ./lib ./src/worker/OBJLoader2WorkerClassic.js ./src/worker/OBJLoader2WorkerModule.js ./docs ",
"doc": "npx jsdoc -c jsdoc.json",
"lint": "npx eslint src",
"build:worker:copy": "npx shx mkdir -p ./lib/worker && npx shx cp ./src/worker/OBJLoader2WorkerModule.js ./lib/worker/ && npx shx cp ./src/worker/OBJLoader2WorkerClassic.js ./lib/worker/",
Expand Down

0 comments on commit 294699e

Please sign in to comment.