@snailicid3/gbt-scope 0.0.1

package/types/types.d.ts

@@ -0,0 +1,84 @@
+import { type Dimensions } from './helpers.ts';
+import { type GbtScopeAnimator, type GbtScopeInputOverrides } from './motion/animator.ts';
+/**
+ * Curve parameters controlling how an input value (eg. pointer distance from center, scroll velocity) maps to an effect
+ * amount. Replaces the old `[min, max]` tuple form of `mouse_curve` with a richer, named shape.
+ *
+ * @see applyCurve in ./motion/curve.ts
+ */
+export type GbtScopeCurve = {
+    /** Input magnitude below this is treated as 0. Default 0. */
+    deadzone?: number;
+    /** Shaping exponent (1 = linear, >1 = ease-in). Default 1. */
+    exponent?: number;
+    /** Negate the result. Default false. */
+    invert?: boolean;
+    /** Upper clamp applied after curving. Default 1. */
+    max?: number;
+    /** Lower clamp applied after curving. Default 0. */
+    min?: number;
+    /** Linear gain applied before the exponent. Default 1. */
+    multiplier?: number;
+};
+/**
+ * Shared, serializable material props for all GbtScope viewers (flat + 3D mesh). camelCase only — animation is
+ * data-driven via {@link GbtScopeAnimator}, not speed fields. `rotation`/`offset`/`scaleFactor`/`opacity` are the
+ * resting (base) values the animators build on.
+ */
+export type GbtScopeMaterialProps = {
+    /** Pre-resolved texture dimensions; viewers derive this from `resolution`. */
+    dimensions?: Dimensions;
+    imageAspect?: number;
+    offset?: [number, number];
+    /** Multiplier on the offset uniform (`uOffsetAmount`). */
+    offsetScale?: number;
+    opacity?: number;
+    rotation?: number;
+    /** Multiplier on the rotation uniform (`uRotationAmount`). */
+    rotationScale?: number;
+    scaleFactor?: number;
+    segments?: number;
+    src: string;
+    tileMode?: GbtScopeTileMode;
+    tiling?: number;
+};
+/**
+ * Tiling strategy applied to the kaleidoscope pattern after the radial fold.
+ *
+ * - `none` — no wrapping; the pattern is sampled directly.
+ * - `repeat` — `fract(uv * tiling)` square repeats (the historical behavior).
+ * - `mirror` — mirrored repeats for seamless edges.
+ */
+export type GbtScopeTileMode = 'mirror' | 'none' | 'repeat';
+/**
+ * Canonical default values for {@link GbtScopeMaterialProps}. `src` is required and has no default. Imported by
+ * component defaults and Storybook args so the defaults live in a single place.
+ */
+export declare const defaultGbtScopeMaterialProps: {
+    imageAspect: number;
+    offset: [number, number];
+    offsetScale: number;
+    opacity: number;
+    rotation: number;
+    rotationScale: number;
+    scaleFactor: number;
+    segments: number;
+    tileMode: GbtScopeTileMode;
+    tiling: number;
+};
+/**
+ * Viewer-level props shared by both the flat and mesh viewers. Camera config is viewer-specific and declared on each
+ * component. Material props are forwarded down to {@link GbtScopeMaterialProps}.
+ */
+export type GbtScopeViewerBaseProps = {
+    /** Declarative motion rules applied each frame. */
+    animators?: Array<GbtScopeAnimator>;
+    /** Aspect ratio of the host canvas. */
+    aspect_ratio?: 'parent' | number;
+    bg_color?: string;
+    /** Fixed values replacing the live pointer/scroll inputs (mock/testing). */
+    inputOverrides?: GbtScopeInputOverrides;
+    /** Canvas background; `'screen'` resolution matches the viewport. */
+    resolution?: 'screen' | Dimensions | null;
+};
+//# sourceMappingURL=types.d.ts.map

package/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EACH,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC9B,MAAM,sBAAsB,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,oDAAoD;IACpD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,gBAAgB,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;AAE3D;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;YAEnB,CAAC,MAAM,EAAE,MAAM,CAAC;;;;;;;cAOZ,gBAAgB;;CAEI,CAAA;AAE9C;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC,mDAAmD;IACnD,SAAS,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACnC,uCAAuC;IACvC,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAA;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4EAA4E;IAC5E,cAAc,CAAC,EAAE,sBAAsB,CAAA;IACvC,qEAAqE;IACrE,UAAU,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAA;CAC5C,CAAA"}