mesh-avatar 0.3.1 → 0.4.0

package/README.md

@@ -68,6 +68,9 @@ avatar.setVoiceLevel(0.6);
 avatar.setEmotion('happy', { playMotion: false });
 avatar.setExpression('smile');
 
+// Show optional overlay layers (such as glasses) by name; [] hides them all.
+avatar.setOverlays(['glasses']);
+
 // Apply tracked or posed parameters. Each call replaces the supplied overrides.
 avatar.setParameters({ angleX: 10, gazeX: 0.25 }, 1);
 
@@ -82,7 +85,7 @@ avatar.setParameters({});
 avatar.destroy();
 ```
 
-Emotion tags are `happy`, `sad`, `angry`, `surprised`, `relaxed` and `neutral` (or `null` to reset). Expressions are `neutral`, `smile`, `shy`, `surprise`, `halfLidded`, `angry`, `sad` and `wink`; `LIVE_EXPRESSIONS` exports that list. `PARAMS` exports the parameter IDs, ranges and defaults. Voice methods animate the avatar; your app handles audio playback.
+Emotion tags are `happy`, `sad`, `angry`, `surprised`, `relaxed` and `neutral` (or `null` to reset). Expressions are `neutral`, `smile`, `shy`, `surprise`, `halfLidded`, `angry`, `sad` and `wink`; `LIVE_EXPRESSIONS` exports that list. `PARAMS` exports the parameter IDs, ranges and defaults. Overlay names come from the avatar's optional `built/overlays/overlays.json`; unknown names are ignored. Voice methods animate the avatar; your app handles audio playback.
 
 `loadMeshAvatar` releases archives it opens on `destroy()` or load failure; when passed an existing `AvatarPackage` from `openAvatar`, the caller owns it and must call `release()` after its last user is destroyed.
 

package/dist/engine/createMeshAvatar.d.ts

@@ -18,6 +18,8 @@ export function createMeshAvatarImpl(canvas: HTMLCanvasElement, options: import(
     setEmotion(tag: any, opts: any): void;
     /** Live expression layered over tracking (see OVERLAY_EXPRESSIONS); 'neutral' clears it. */
     setExpression(name: any): void;
+    /** Show the named overlay layers (built/overlays/overlays.json) and hide the others. */
+    setOverlays(names: any): void;
     getExpression(): {
         name: "smile" | "shy" | "surprise" | "wink" | "neutral" | "halfLidded" | "angry" | "sad";
         active: boolean;

package/dist/engine/index.d.ts

@@ -37,6 +37,8 @@ export interface MeshAvatar {
         playMotion?: boolean;
     }): void;
     setExpression(name: LiveExpression): void;
+    /** Show the named overlay layers from built/overlays/overlays.json and hide the rest; unknown names are ignored. */
+    setOverlays(names: string[]): void;
     getExpression(): {
         name: LiveExpression;
         active: boolean;

package/dist/engine/overlays.d.ts

@@ -0,0 +1,15 @@
+/** [x, y, w, h] around the opaque pixels (alpha > 3) plus `pad`, or null when fully transparent. */
+export function opaqueRect(alpha: any, width: any, height: any, pad?: number): number[] | null;
+/**
+ * Builds one layer per overlay. Like the sprites, only the opaque part of each drawing gets a
+ * grid: a grid over the whole image would move every transparent vertex each frame (about
+ * 100k vertices for a 1254 x 1254 image at 4 px, ~12 ms per frame on a mid-range phone).
+ * `crop(img, rect)` returns that part of the image (a canvas, for example) for the texture.
+ * Brows and jaw do not move an accessory, so their weights are zeroed; hair weight is 0 as for
+ * the sprites.
+ */
+export function createOverlayLayers(renderer: any, sheet: any, images: any, buildGrid: any, alphaOf: any, baseWeights: any, cell: number | undefined, width: any, height: any, crop: any): {
+    /** Shows the named overlays and hides the rest. Unknown names are ignored. */
+    set(names: any): void;
+    update(P: any, phys: any, deformBase: any, out: any): void;
+};