meshwriter-cudu 3.0.0

package/dist/src/variableFontLoader.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Load and parse a variable font from URL
+ * @param {string} url - URL to TTF or WOFF2 file
+ * @param {object} [options] - Loading options
+ * @param {number} [options.cacheSize=5000] - Maximum glyph cache size
+ * @param {number} [options.maxVariations=10] - Maximum cached weight variations
+ * @returns {Promise<VariableFontHandle>}
+ */
+export function loadVariableFont(url: string, options?: {
+    cacheSize?: number;
+    maxVariations?: number;
+}): Promise<VariableFontHandle>;
+export const DEFAULT_CHARSET: string;
+/**
+ * Handle for a loaded variable font
+ * Provides methods to generate FontSpec at different weights
+ */
+export class VariableFontHandle {
+    /**
+     * @param {object} font - fontkit font object
+     * @param {object} fontkit - fontkit module reference
+     * @param {string} url - Source URL
+     * @param {object} axisInfo - Axis information
+     * @param {boolean} isVariable - Whether font is actually variable
+     * @param {number} cacheSize - Maximum glyph cache size
+     * @param {number} maxVariations - Maximum cached weight variations
+     */
+    constructor(font: object, fontkit: object, url: string, axisInfo: object, isVariable: boolean, cacheSize: number, maxVariations: number);
+    _baseFont: any;
+    _fontkit: any;
+    _url: string;
+    _axisInfo: any;
+    _isVariable: boolean;
+    _glyphCache: GlyphCache;
+    _kerningCache: Map<any, any>;
+    _fontCache: Map<any, any>;
+    _maxVariations: number;
+    _reverseShapes: boolean;
+    _reverseHoles: boolean;
+    /**
+     * Get axis information for this font
+     * @returns {object} - Axis info with weight min/max/default
+     */
+    getAxisInfo(): object;
+    /**
+     * Get the source URL
+     * @returns {string}
+     */
+    getUrl(): string;
+    /**
+     * Check if this is actually a variable font
+     * @returns {boolean}
+     */
+    isVariable(): boolean;
+    /**
+     * Get or create a font instance at the specified weight
+     * @param {number} weight - Weight value
+     * @returns {object} - fontkit font instance
+     */
+    _getFontAtWeight(weight: number): object;
+    /**
+     * Generate FontSpec for a specific weight
+     * @param {number} weight - Weight value (100-900 for most fonts)
+     * @param {string} [charset] - Characters to include (default: Latin + symbols)
+     * @returns {object} - FontSpec compatible with MeshWriter
+     */
+    generateFontSpec(weight: number, charset?: string): object;
+    /**
+     * Get or create a cached glyph specification
+     * @param {object} font - fontkit font instance at specific weight
+     * @param {string} char - Character
+     * @param {number} weight - Weight value
+     * @returns {object|null} - GlyphSpec or null if glyph not found
+     */
+    _getOrCreateGlyph(font: object, char: string, weight: number): object | null;
+    /**
+     * Clear all cached glyphs and font instances
+     * Call this when changing weight frequently to free memory
+     */
+    clearCache(): void;
+    /**
+     * Get current cache statistics
+     * @returns {{ glyphCount: number, kerningCount: number, fontCount: number, maxSize: number, maxVariations: number }}
+     */
+    getCacheStats(): {
+        glyphCount: number;
+        kerningCount: number;
+        fontCount: number;
+        maxSize: number;
+        maxVariations: number;
+    };
+    /**
+     * Ensure a cache map respects the max variations limit (simple LRU)
+     * @param {Map} map
+     * @private
+     */
+    private _evictIfNeeded;
+}
+import { GlyphCache } from './variableFontCache.js';

package/fonts/LICENSE-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020, 2024 Braille Institute of America, Inc. (https://www.brailleinstitute.org/)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/fonts/README.md

@@ -0,0 +1,174 @@
+# So you want to build a 3-D font, eh?
+
+3-D font conversion is now an automatic process. 
+The documentation further below is no longer needed (although you are welcome to read it). 
+Instead, go to https://github.com/briantbutton/meshwriter-font for a package that will convert full font files. 
+When you have done that, come back here for further instructions.
+
+
+## Building MeshWriter with a customized font set
+
+MeshWriter can build with an arbitrary selection of font files. 
+All font files should be converted into MeshWriter form and placed in this directory. 
+Linking the font files into your build is done with a require statement. 
+Easy. 
+Open /meshwriter/index.js and take a look at the steps described in the first fifty lines of that file. 
+Three steps for each font file. 
+
+### Step 1 - reference the font files into variable names
+
+### Step 2 - call each font with 'codelist'
+
+This just passes along the encoding function. 
+Sorry if it seems awkward.
+
+### Step 3 - Assign a text name (or two) to each font
+
+This is used to invoke it.
+
+
+## Build a package
+
+Make sure that you have loaded Earcut in npm – this is the only dependency. 
+On your dev machine (set up as described in meshwriter-font) go to the /meshwriter repo. 
+Type:
+
+	npm run build
+
+This has placed an unminified version of meshwriter, with all your fonts, in /meshwriter/dist. 
+Almost there! 
+It only remains to minify it. 
+Use any tool you want.  However, save "MeshWriter" as a reserved word.  Here is the command I use:
+
+	terser meshwriter.js -m reserved=['MeshWriter'] --mangle-props regex=/^[xyw][Md][tia][nxh]/
+
+We are now *finished*. 
+Back to our regularly scheduled programming, describing in detail how shapes are specified. 
+
+You may turn off your television sets now. 
+
+Stop reading. 
+
+## Background information:  How shapes are specified
+
+### Basic shapes
+
+Meshwriter curves follow SVG-style rules.  These include:    
+  ~ 'M' move to, only at the beginning   
+  ~ 'L' line, never at the beginning   
+  ~ 'l' line   
+  ~ 'Q' quadratic curve   
+  ~ 'q' quadratic curve   
+  ~ 'C' cubic curve   
+  ~ 'c' cubic curve
+
+Just below is an example from Comic (a gnarly font) showing the letter 'j' in SVG and in MeshWriter. 
+In MeshWriter, the commands are placed in arrays. 
+The length of the array indicates the command type. 
+  ~ 2: M or L   
+  ~ 3: l   
+  ~ 4: Q   
+  ~ 5: q   
+  ~ 6: C   
+  ~ 7: c
+
+**Key** **Point** Meshwriter shapes are superficially similar to SVG shapes but, instead of a parseable text string, commands are in arrays. 
+The size of the array indicates which command is specified.
+
+Since 'j' has two shapes, including the dot, the fullPath shows two M commands. 
+In Meshwriter, this converted to two arrays, one for each shape. 
+So this means that shapeCmds has three levels. 
+At the top is an array containing all shapes, usually one or more. 
+Each shape is an array of commands, each command containing multiple coordinates. 
+
+	Three encodings for the letter 'j'
+	fullPath  : "M 233.5 632.5 Q 209.5 632.5 192 649.5 Q 175 666.5 175 690 Q 175 714 192 731 Q 209.5 748 233.5 748 Q 257.5 748 275 731 Q 292.5 714 292.5 690 Q 292.5 666.5 275 649.5 Q 257.5 632.5 233.5 632.5 Z M 229.5 -116 Q 230 -57.5 212.5 183.5 L 195.5 459 Q 195.5 484 209.5 503.5 Q 224 523 246 523 Q 263 523 280 510.5 Q 297 498 298 485 L 314.5 197 L 328 -111 Q 328 -180.5 286.5 -237 Q 241.5 -298.5 177 -298.5 Q 69.5 -298.5 -3 -133 Q -9 -119.5 -9 -109 Q -9 -89 6.5 -74.5 Q 22.5 -60 42.5 -60 Q 72 -60 104 -125 Q 112 -142 132 -174 Q 151.5 -199 177 -199 Q 199 -199 214.5 -166 Q 226.5 -141 229.5 -116 Z",
+	shapeCmds : [[[233.5,632.5],[209.5,632.5,192,649.5],[175,666.5,175,690],[175,714,192,731],[209.5,748,233.5,748],[257.5,748,275,731],[292.5,714,292.5,690],[292.5,666.5,275,649.5],[257.5,632.5,233.5,632.5]],[[229.5,-116],[230,-57.5,212.5,183.5],[195.5,459],[195.5,484,209.5,503.5],[224,523,246,523],[263,523,280,510.5],[297,498,298,485],[314.5,197],[328,-111],[328,-180.5,286.5,-237],[241.5,-298.5,177,-298.5],[69.5,-298.5,-3,-133],[-9,-119.5,-9,-109],[-9,-89,6.5,-74.5],[22.5,-60,42.5,-60],[72,-60,104,-125],[112,-142,132,-174],[151.5,-199,177,-199],[199,-199,214.5,-166],[226.5,-141,229.5,-116]]],
+	sC        : ['D¸K3 DfK3DBKU CÃKxCÃL% CÃLVDBLy DfL½D¸L½ EEL½EiLy E®LVE®L% E®KxEiKU EEK3D¸K3','D°?Z D±@ODlD1 DIHX DIH­DfI1 D¥IXE.IX EPIXEsI? E·I%E¹H¯ F7DL FR?e FR>YE¢=i E$<nD#<n BM<nA<?8 A0?SA0?i A0?³AO@- Ap@JAº@J BR@JBµ?H C!?%CJ>g Cr>4D#>4 DP>4Dp>w Dª?(D°?Z'],
+
+The third version, sC is an encoded version, saving 45% of the space.&nbsp;
+This may be handy should we want a lot of fonts in one package.&nbsp;
+The encoding is proprietary, simple and built into MeshWriter.&nbsp;
+It puts an array of arrays into an ASCII string.&nbsp;
+
+Furthermore it is optional; any given symbol may present either shapeCmds or sC.&nbsp;
+I usually encode stable symbols after a while.
+
+### Acquiring the shapes
+
+My approach has been to visit https://opentype.js.org/glyph-inspector.html, upload my font and then acquire glyphs in semi-SVG form.&nbsp; 
+
+I have not been able to use the output of Glyph Inspector without review and, often, tuning.&nbsp;
+More on that below.
+
+### Holes
+
+Many letters have holes in them.&nbsp;
+Glyph Inspector also outputs the holes.&nbsp;
+Meshwriter supports holes.&nbsp;
+The basic task here is that fonts need not line up the hole to the shape it is coming from.&nbsp;
+For MeshWriter, we must.&nbsp;
+The '%', shown just below, is a classic example.
+
+	Commands for Percent '%', with three shapes and two holes 
+	shapeCmds : [
+	  [[338,-24],[260,-24],[649,724],[725,724],[338,-24]],
+	  [[751,-14],[665,-14,622,45],[584,96,584,185],[584,272,624,325],[668,384,751,384],[834,384,878,325],[918,272,918,185],[918,96,880,45],[837,-14,751,-14]],
+	  [[249,316],[163,316,120,375],[82,426,82,515],[82,602,122,655],[166,714,249,714],[332,714,376,655],[416,602,416,515],[416,426,378,375],[335,316,249,316]]
+	],
+	holeCmds  : [
+	  [],
+	  [[[674,185],[674,51,750,51],[828,51,828,185],[828,319,750,319],[674,319,674,185]]],
+	  [[[172,515],[172,381,248,381],[326,381,326,515],[326,649,248,649],[172,649,172,515]]]
+	]
+
+**Key** **Point** Hole commands are always one array level deeper than shape commands.&nbsp;
+This is necessary because a single shape may have multiple holes, like 'B'.
+
+### Tuning A, lining up holes
+
+The hole commands must line up with the shape commands and, AFAIK, this must be done manually.&nbsp;
+Fonts do not seem to need to do this at all.&nbsp;
+They might list the holes in any order and they may come before or after the shapes.&nbsp;
+I seriously spend some time eyeballing shapes and holes and then organize them for correct results.
+
+### Tuning B, rotation
+
+Fonts may specify a Shape clockwise or counter-clockwise.&nbsp;
+They may specify a Hole clockwise or counter-clockwise.&nbsp;
+Any given font might pick any pair of directions.&nbsp;
+Luckily, they seem to stick with it through all the symbols.
+
+My experience is the Babylon is only happy with one direction; I forget which.&nbsp;
+So, the output of the Glyph Inspector might need reversal for Babylon.&nbsp;
+I put some font-level flags in place to handle this.&nbsp;
+You will find them at the top of each font file.&nbsp; 
+My scientific method is to try all combinations until I find the one that looks good.
+
+	Declarations for each current font
+	(helvetica neue) { reverseHoles : false , reverseShapes : true  };
+	(comic)          { reverseHoles : false , reverseShapes : true  };
+	(jura)           { reverseHoles : true  , reverseShapes : false };
+
+
+## 'C' is for Cat
+
+So let's start with a simple letter, C.&nbsp;
+Because we believe life should be easy, we will use 'HelveticaNeue-Medium.ttf'.&nbsp;
+(This is a modern font and its files are pretty well-behaved.)&nbsp;
+Visit https://opentype.js.org/glyph-inspector.html, upload the font file, and then click on the letter C.&nbsp;
+What you see should be similar to the screen capture immediately below.&nbsp;
+
+![alt text](https://raw.githubusercontent.com/briantbutton/meshwriter/master/fonts/Figure1.png "Logo Title Text 1")
+
+Note that the information we need is immediately visible.&nbsp;
+The key thing is to get that information into MeshWriter in a form it can take.&nbsp;
+
+## This
+
+document is not
+
+## Finished
+
+yet
+

package/fonts/atkinson-hyperlegible-next.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Atkinson Hyperlegible Next Font for MeshWriter
+ * Auto-generated TypeScript declaration
+ */
+import type { FontSpec } from 'meshwriter';
+
+declare const font: FontSpec;
+export default font;