4.0.0

Author: ycw

README.md

@@ -88,8 +88,9 @@ new TextMeshBuilder(BABYLON, earcut);
 ```
 
 - `.create(options, scene)` : create extruded text mesh.
-
-Ex.
+  - returns `Mesh` if a mesh is created.
+  - returns `null` if no mesh is created, e.g. text are all whitespaces.
+  - returns `undefined` if wasm failed to process (e.g. out of mem)   
 
 ```js
 builder.create({
@@ -110,6 +111,13 @@ builder.create({
 }, scene);
 ```
 
+ex. fallback 
+
+```js
+var mesh = builder.create(opt1, scene)
+if (mesh === undefined) mesh = builder.create(opt2, scene) 
+```
+
 
 
 # Thanks

assembly/index.ts

@@ -612,3 +612,11 @@ function isPolygonInsidePolygon(
   }
   return isPointInsidePolygon(A[0], B);
 }
+
+
+
+//
+// Export memoryBase
+//
+
+export const MEMORY_BASE = ASC_MEMORY_BASE

build/babylon.font.d.ts

@@ -1,19 +1,34 @@
 import * as loader from '@assemblyscript/loader';
 import * as BABYLON from 'babylonjs';
 
-interface IPathCommand {
-    type: string;
-    x?: number;
-    y?: number;
-    x1?: number;
-    y1?: number;
-    x2?: number;
-    y2?: number;
-}
+declare type PathCommand = {
+    type: 'M' | 'L';
+    x: number;
+    y: number;
+} | {
+    type: 'Q';
+    x: number;
+    y: number;
+    x1: number;
+    y1: number;
+} | {
+    type: 'C';
+    x: number;
+    y: number;
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+} | {
+    type: 'Z';
+};
 declare type Header = {
+    MEMORY_BASE: {
+        value: number;
+    };
     compile(bytesUsed: number, fmt: string, ppc: number, eps: number): number;
 };
-declare type Instaniated = loader.ResultObject & {
+declare type Wasm = loader.ResultObject & {
     exports: loader.ASUtil & Header;
 };
 declare type Vertex = [number, number];
@@ -24,14 +39,33 @@ declare type Shape = {
 };
 declare class Compiler {
     private wasm;
-    constructor(wasm: Instaniated);
+    constructor(wasm: Wasm);
     static Build(wasmUrl?: string): Promise<Compiler>;
-    encode(cmds: IPathCommand[], buffer: ArrayBuffer): number;
-    compileEncoded(buffer: ArrayBuffer, bytesUsed: number, fmt: string, ppc: number, eps: number): Shape[];
-    compile(cmds: IPathCommand[], fmt: string, ppc: number, eps: number): Shape[];
+    encode(cmds: PathCommand[]): number;
+    compile(cmds: PathCommand[], fmt: string, ppc: number, eps: number): Shape[] | null;
+    private bytesRequired;
 }
 
-declare type PolygonMeshOption = {
+declare class Metrics {
+    private font;
+    private name;
+    private size;
+    constructor(font: Font, name: string, size: number);
+    get ascender(): number;
+    get descender(): number;
+    get advanceWidth(): number;
+}
+
+declare class Font {
+    raw: opentype.Font;
+    private compiler;
+    private constructor();
+    static Install(fontUrl: string, compiler: Compiler, opentype: any): Promise<Font>;
+    measure(name: string, size: number): Metrics;
+    static Compile(font: Font, name: string, size: number, ppc: number, eps: number): Shape[] | null;
+}
+
+declare type CreatePolygonOptions = {
     backUVs?: BABYLON.Vector4;
     depth?: number;
     faceColors?: BABYLON.Color4[];
@@ -40,40 +74,19 @@ declare type PolygonMeshOption = {
     sideOrientation?: number;
     updatable?: boolean;
 };
-declare class Font {
-    raw: opentype.Font;
-    private compiler;
-    private constructor();
-    static Install(fontUrl: string, compiler: Compiler, opentype: any): Promise<Font>;
-    measure(name: string, size: number): Metrics;
-    static Compile(font: Font, name: string, size: number, ppc: number, eps: number): Shape[];
-}
-interface IBabylon {
-    Mesh: typeof BABYLON.Mesh;
-    MeshBuilder: typeof BABYLON.MeshBuilder;
-    Vector3: typeof BABYLON.Vector3;
-}
+declare type TextBuilderCreateOptions = {
+    font: Font;
+    text: string;
+    size: number;
+    ppc: number;
+    eps: number;
+} & CreatePolygonOptions;
 declare class TextMeshBuilder {
     private babylon;
     private earcut;
-    constructor(babylon: IBabylon, earcut: any);
+    constructor(babylon: typeof BABYLON, earcut: any);
     private createFromShapes;
-    create({ font, text, size, ppc, eps, ...option }: {
-        font: Font;
-        text: string;
-        size: number;
-        ppc: number;
-        eps: number;
-    } & PolygonMeshOption, scene?: BABYLON.Scene): BABYLON.Mesh;
-}
-declare class Metrics {
-    private font;
-    private name;
-    private size;
-    constructor(font: Font, name: string, size: number);
-    get ascender(): number;
-    get descender(): number;
-    get advanceWidth(): number;
+    create({ font, text, size, ppc, eps, ...createPolygonOptions }: TextBuilderCreateOptions, scene?: BABYLON.Scene): BABYLON.Nullable<BABYLON.Mesh> | undefined;
 }
 
-export { Compiler, Font, Metrics, Shape, TextMeshBuilder };
+export { Compiler, Font, Polygon, Shape, TextMeshBuilder, Vertex };

build/babylon.font.js

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8">
   <link rel="icon" href="data:,">
-  <title>Bare Example</title>
+  <title>Bare Example (v4.0.0)</title>
   <style>
     html,
     body {

build/optimized.wasm

@@ -14,7 +14,7 @@ const fontUrl = "../font/NotoSansMono-Thin.ttf";
 
   // Env
   const canvas = document.querySelector("canvas");
-  const engine = new BABYLON.Engine(canvas, true, null, true);
+  const engine = new BABYLON.Engine(canvas, true, undefined, true);
   const scene = new BABYLON.Scene(engine);
   engine.runRenderLoop(() => scene.render());
   window.addEventListener("resize", () => engine.resize());
@@ -31,7 +31,7 @@ const fontUrl = "../font/NotoSansMono-Thin.ttf";
 
   // Params
   const params = {
-    text: "BF3.0",
+    text: "BF4.0",
     size: 100,
     ppc: 2,
     eps: 0.001,
@@ -51,6 +51,15 @@ const fontUrl = "../font/NotoSansMono-Thin.ttf";
       depth: params.depth,
       sideOrientation: BABYLON.Mesh.DOUBLESIDE
     }, scene);
+
+    if (mesh === undefined) { // wasm fails to process
+      return null
+    }
+
+    if (mesh === null) { // no mesh created, e.g. text are all whtiespaces
+      return null
+    }
+
     const info = mesh.getBoundingInfo();
     mesh.position.copyFrom(info.boundingBox.center.scale(-1));
     return mesh;