@opsydyn/effect-three-foldkit 0.0.0-stage → 0.2.0

package/dist/element.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element.d.ts","sourceRoot":"","sources":["../src/element.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGxC,qFAAqF;AACrF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGrB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAC;AAIhD,wEAAwE;AACxE,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;EAW3B,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAC;AAE5D,oFAAoF;AACpF,eAAO,MAAM,eAAe;;EAE1B,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAC;AAE1D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCvB,CAAC;AAEH,sDAAsD;AACtD,eAAO,MAAM,YAAY;oBAChB,aAAa;0BACP,oBAAoB;0BACpB,oBAAoB;0BACpB,oBAAoB;wBACtB,kBAAkB;2BACf,qBAAqB;0BACtB,oBAAoB;2BACnB,qBAAqB;4BACpB,sBAAsB;oBAC9B,aAAa;mBACd,YAAY;sBACT,gBAAgB;sBAChB,eAAe;0BACX,oBAAoB;wBACtB,iBAAiB;2BACd,qBAAqB;uBACzB,gBAAgB;4BACX,sBAAsB;sBAC5B,gBAAgB;uBACf,iBAAiB;wBAChB,kBAAkB;sBACpB,gBAAgB;uBACf,iBAAiB;uBACjB,iBAAiB;iCACP,mBAAmB;CACwC,CAAC;AAElF,yFAAyF;AACzF,eAAO,MAAM,cAAc;;;QAEV,MAAM;;EACrB,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAC"}

package/dist/environment.d.ts

@@ -0,0 +1,64 @@
+/**
+ * App-wide state shared by every scene element: one GPU resource store and one
+ * animation-frame scheduler. Create it once at the application entry point.
+ *
+ * @module
+ */
+import { type Behaviour, type LabelEngine, type PhysicsEngine, type RendererFactory, type ResourceStore } from '@opsydyn/effect-three';
+import { type AnimationFrameHost } from './dom/animationFrames.ts';
+import { type PixelRatio } from './dom/viewport.ts';
+/** The browser APIs the adapter uses; normally `window`. */
+export type EnvironmentHost = AnimationFrameHost & Pick<Window, 'matchMedia' | 'devicePixelRatio'> & Partial<Pick<Window, 'navigator'>>;
+export type EnvironmentOptions = {
+    /** Creates each scene's renderer from its canvas. Defaults to WebGL2. */
+    readonly renderer?: (canvas: HTMLCanvasElement) => RendererFactory;
+    /** Drawing-buffer pixel ratio: fixed, or `[min, max]` around the device's. Default `[1, 2]`. */
+    readonly pixelRatio?: PixelRatio;
+    /** Behaviours scenes may name with `behave(name)`, beside the built-in `float`. */
+    readonly behaviours?: Readonly<Record<string, Behaviour>>;
+    /**
+     * The physics engine for scenes with `physics`, or the promise of one: pass
+     * `loadRapier()` from `@opsydyn/effect-three-rapier` as it is, and scenes start once it
+     * has loaded. Without one, bodies stay where they are described.
+     */
+    readonly physics?: PhysicsEngine | Promise<PhysicsEngine>;
+    /**
+     * Draws `label` nodes: pass `troikaLabels()` from `@opsydyn/effect-three-troika`.
+     * Without one, labels are empty.
+     */
+    readonly labels?: LabelEngine;
+};
+/** Creates the shared environment for `host`. Call `dispose` when the app shuts down. */
+export declare const makeEnvironment: (host: EnvironmentHost, options?: EnvironmentOptions) => {
+    host: EnvironmentHost;
+    store: ResourceStore;
+    frames: import("@opsydyn/effect-three").FrameScheduler;
+    renderer: (canvas: HTMLCanvasElement) => RendererFactory;
+    pixelRatio: PixelRatio;
+    behaviours: Readonly<Record<string, Behaviour>>;
+    /** The physics engine, once loaded; `undefined` when there is none. */
+    physics: Promise<PhysicsEngine | undefined>;
+    /** The label engine; `undefined` when there is none. */
+    labels: LabelEngine | undefined;
+    /** Loads textures and glTF models by URL and lends them to the store. */
+    assets: {
+        loadTexture: (id: string, url: string) => import("effect/Effect").Effect<string, import("./assets.ts").AssetLoadError, never>;
+        loadModel: (id: string, url: string) => import("effect/Effect").Effect<import("./assets.ts").ModelInfo, import("./assets.ts").AssetLoadError, never>;
+        loadEnvironment: (id: string, url: string) => import("effect/Effect").Effect<string, import("./assets.ts").AssetLoadError, never>;
+        loadFont: (id: string, url: string) => import("effect/Effect").Effect<string, import("./assets.ts").AssetLoadError, never>;
+        unload: (id: string) => import("effect/Effect").Effect<void, never, never>;
+        dispose: () => void;
+    };
+    /** Enters and leaves immersive (WebXR) sessions, from Commands. */
+    xr: {
+        supported: (mode: import("./index.ts").XrMode) => import("effect/Effect").Effect<boolean, never, never>;
+        enter: (mode: import("./index.ts").XrMode) => import("effect/Effect").Effect<void, import("./xr.ts").XrUnavailable, never>;
+        exit: import("effect/Effect").Effect<void, never, never>;
+    };
+    /** The page's presentable scenes and its session; scene mounts register here. */
+    xrHub: import("./dom/xrHub.ts").XrHub;
+    /** Disposes every loaded asset and every GPU resource still held. */
+    dispose: () => void;
+};
+export type Environment = ReturnType<typeof makeEnvironment>;
+//# sourceMappingURL=environment.d.ts.map

package/dist/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EACL,KAAK,SAAS,EAEd,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,aAAa,EACnB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAA2B,KAAK,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC5F,OAAO,EAAqB,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAKvE,4DAA4D;AAC5D,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAC9C,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,kBAAkB,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAErC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,eAAe,CAAC;IACnE,gGAAgG;IAChG,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IACjC,mFAAmF;IACnF,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1D;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B,CAAC;AAEF,yFAAyF;AACzF,eAAO,MAAM,eAAe,SAAU,eAAe,YAAW,kBAAkB;;;;uBAnBnD,iBAAiB,KAAK,eAAe;;;IA8BhE,uEAAuE;;IAEvE,wDAAwD;;IAExD,yEAAyE;;;;;;;;;IAEzE,mEAAmE;;;;;;IAEnE,iFAAiF;;IAEjF,qEAAqE;;CAMxE,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Foldkit adapter for `@opsydyn/effect-three`.
+ *
+ * ```ts
+ * // entry.ts: once per app
+ * const environment = EffectThreeFoldkit.makeEnvironment(window);
+ * export const sceneMount = EffectThreeFoldkit.makeSceneMount(environment);
+ *
+ * // view.ts
+ * EffectThreeFoldkit.view(
+ *   { scene: sceneFor(model), mount: sceneMount, onLifecycle: GotSceneLifecycle, onClick: ClickedNode },
+ *   h,
+ * );
+ * ```
+ *
+ * @module
+ */
+export { AssetLoadError, type Assets, makeAssets, type ModelInfo } from './assets.ts';
+export { animationFrameScheduler, type AnimationFrameHost } from './dom/animationFrames.ts';
+export { capturesPointer, claimsContextMenu, type Rect, toNdc, toPointerInput, } from './dom/pointer.ts';
+export { defaultPixelRatio, type PixelRatio, resolvePixelRatio } from './dom/viewport.ts';
+export { webglRendererFactory, type WebGLOptions } from './dom/webgl.ts';
+export { type WebGPUOptions, webgpuRendererFactory } from './dom/webgpu.ts';
+export { domEventName, ReconciledDetail, SceneError, sceneElement, SceneLifecycle, XrSessionDetail, } from './element.ts';
+export { type XrMode } from './dom/xrHub.ts';
+export { type XrControls, XrUnavailable } from './xr.ts';
+export { summarise } from './dom/reconciled.ts';
+export { type Environment, type EnvironmentHost, type EnvironmentOptions, makeEnvironment, } from './environment.ts';
+export { makeSceneMount, type SceneMount } from './mount.ts';
+export { type OverlayView } from './overlayView.ts';
+export { type AutoRotatedDetail, type ButtonDetail, type CollisionDetail, type ContactForceDetail, type DragDetail, type Gesture, type HitDetail, type KeyDetail, type LabelMeasuredDetail, type MeasuredDetail, type MissDetail, type PerformanceDetail, view, type ViewConfig, type WheelDetail, type XrButtonDetail, type XrMeshesDetail, type XrMovedDetail, type XrPlanesDetail, type XrStickDetail, type XrSurfaceDetail, } from './view.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,cAAc,EAAE,KAAK,MAAM,EAAE,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AACtF,OAAO,EAAE,uBAAuB,EAAE,KAAK,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC5F,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,KAAK,IAAI,EACT,KAAK,EACL,cAAc,GACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,KAAK,UAAU,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC1F,OAAO,EAAE,oBAAoB,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,KAAK,aAAa,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,KAAK,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,IAAI,EACJ,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,eAAe,GACrB,MAAM,WAAW,CAAC"}