three-text 0.2.2 → 0.2.4

package/LICENSE_THIRD_PARTY

@@ -20,17 +20,18 @@ HarfBuzzJS is distributed under the MIT License, with some components
 
 ---
 
-2. libtess2 / tess2-ts
+2. libtess.js
 
-This software includes tess2-ts (https://github.com/eXponenta/tess2.js), a
-TypeScript fork of Mikko Mononen's tess2.js (https://github.com/memononen/tess2.js),
-which in turn is a port of libtess2, based on the GLU tesselator by Eric Veach.
+This software includes libtess.js (https://github.com/brendankenny/libtess.js),
+a JavaScript port of the polygon tessellation library from the OpenGL Utility
+Library (GLU), originally written by Eric Veach while at Silicon Graphics, Inc.
 
 Original GLU tesselator:
-Copyright (C) 1991-2000, 2000 Eric Veach, Silicon Graphics, Inc.
+Copyright (C) 1991-2000 Silicon Graphics, Inc.
 
-libtess2 and tess2.js:
-Copyright (C) 2012-2013 Mikko Mononen (memon@inside.org)
+libtess.js:
+Copyright (C) 2000 Silicon Graphics, Inc.
+Copyright (C) 2015 Google Inc.
 
 The software is licensed under the SGI Free Software License B, Version 2.0
 (See Appendix C for full license text)

package/README.md

@@ -19,18 +19,15 @@ A high fidelity 3D font renderer and text layout engine for the web
 
 The library has a framework-agnostic core that returns raw vertex data, with lightweight adapters for [Three.js](https://threejs.org), [React Three Fiber](https://docs.pmnd.rs/react-three-fiber), [p5.js](https://p5js.org), [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API), and [WebGPU](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API)
 
-Under the hood, three-text relies on [HarfBuzz](https://github.com/harfbuzz/harfbuzzjs) for text shaping, [Knuth-Plass](http://www.eprg.org/G53DOC/pdfs/knuth-plass-breaking.pdf) line breaking, [Liang](https://tug.org/docs/liang/liang-thesis.pdf) hyphenation, [libtess2](https://github.com/memononen/libtess2) (based on the [OpenGL Utility Library (GLU) tessellator](https://www.songho.ca/opengl/gl_tessellation.html) by Eric Veach) for removing overlaps and triangulation, bezier curve polygonization from Maxim Shemanarev's [Anti-Grain Geometry](https://web.archive.org/web/20060128212843/http://www.antigrain.com/research/adaptive_bezier/index.html), and [Visvalingam-Whyatt](https://hull-repository.worktribe.com/preview/376364/000870493786962263.pdf) [line simplification](https://bost.ocks.org/mike/simplify/).
+Under the hood, three-text relies on [HarfBuzz](https://github.com/harfbuzz/harfbuzzjs) for text shaping, [Knuth-Plass](http://www.eprg.org/G53DOC/pdfs/knuth-plass-breaking.pdf) line breaking, [Liang](https://tug.org/docs/liang/liang-thesis.pdf) hyphenation, [libtess](https://github.com/brendankenny/libtess.js), based on the [GLU tessellator](https://www.songho.ca/opengl/gl_tessellation.html) by Eric Veach) for removing overlaps and triangulation, bezier curve polygonization from Maxim Shemanarev's [Anti-Grain Geometry](https://web.archive.org/web/20060128212843/http://www.antigrain.com/research/adaptive_bezier/index.html), and [Visvalingam-Whyatt](https://hull-repository.worktribe.com/preview/376364/000870493786962263.pdf) [line simplification](https://bost.ocks.org/mike/simplify/).
 
 ## Table of contents
 
 - [Overview](#overview)
 - [Getting started](#getting-started)
   - [Three.js](#threejs)
-  - [p5.js](#p5js)
   - [React Three Fiber](#react-three-fiber)
-  - [WebGL](#webgl)
-  - [WebGPU](#webgpu)
-  - [Core](#core)
+  - [p5.js](#p5js)
 - [Development and examples](#development-and-examples)
 - [Architecture](#architecture)
 - [Why three-text?](#why-three-text)
@@ -94,6 +91,26 @@ const mesh = new THREE.Mesh(result.geometry, material);
 scene.add(mesh);
 ```
 
+#### React Three Fiber
+
+```jsx
+import { Canvas } from '@react-three/fiber';
+import { Text } from 'three-text/three/react';
+
+Text.setHarfBuzzPath('/hb/hb.wasm');
+
+function App() {
+  return (
+    <Canvas>
+      <ambientLight />
+      <Text font="/fonts/Font.woff" size={72} depth={10}>
+        Hello React
+      </Text>
+    </Canvas>
+  );
+}
+```
+
 #### p5.js
 
 ```javascript
@@ -123,6 +140,9 @@ function draw() {
 }
 ```
 
+`createThreeTextGeometry()` accepts all the same options as Three.js (`layout`, `fontVariations`, `depth`, etc.) and returns `{ geometry, planeBounds, glyphs }`. Use `planeBounds` to center the text
+
+
 ### Setup
 
 The library bundles harfbuzzjs but requires the WASM binary to be available at runtime. You have two options for providing it:
@@ -969,7 +989,7 @@ The build generates multiple module formats for core and all adapters:
 
 ## Acknowledgements
 
-`three-text` is built on HarfBuzz and TeX, and this library would not exist without the authors and communities who contribute to, support, and steward these projects. Thanks to Theo Honohan and Yasi Perera for advice on graphics
+`three-text` is built on HarfBuzz and TeX, and started as a Three.js project; this library would not exist without the authors and communities who contribute to, support, and steward these projects. Thanks to Theo Honohan and Yasi Perera for the advice on graphics
 
 ## License