@3driseai/3drise-viewer 0.1.24 → 0.1.26

package/dist/animationsV2/ClipPlayer.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import type { AnimationClip, AnimationSequence } from './types';
+export interface ClipPlayerProps {
+    getSettings: (state: string) => any;
+    /** Start the sequences flagged `autoplay` (published viewer). The studio leaves this off. */
+    autoplay?: {
+        sequences: AnimationSequence[];
+        clips: AnimationClip[];
+    };
+}
+declare const ClipPlayer: React.FC<ClipPlayerProps>;
+export default ClipPlayer;
+//# sourceMappingURL=ClipPlayer.d.ts.map

package/dist/animationsV2/ClipPlayer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClipPlayer.d.ts","sourceRoot":"","sources":["../../src/animationsV2/ClipPlayer.tsx"],"names":[],"mappings":"AAuBA,OAAO,KAA4B,MAAM,OAAO,CAAC;AAIjD,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC;IACpC,6FAA6F;IAC7F,QAAQ,CAAC,EAAE;QAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;QAAC,KAAK,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;CACzE;AAMD,QAAA,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,eAAe,CAwGzC,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/dist/animationsV2/ClipPlayer.js

@@ -0,0 +1,140 @@
+// =============================================================================
+// ClipPlayer — drives ClipsRuntime from the R3F frame loop, and feeds it input.
+// =============================================================================
+//
+// Mount inside the Canvas AFTER the objects and the environment: R3F runs
+// same-priority frame callbacks in subscription order, so clips write after the
+// objects' own per-frame animation. Priority stays 0 — a positive priority would
+// take rendering over from R3F (see CLAUDE.md on the cloud pass).
+//
+// `getSettings(state)` returns an element's authored settings (action patches
+// included) — the value a stopped track restores. The studio reads it from Redux,
+// the published viewer from the loaded project (resolveElementSettings).
+//
+// Input drivers (sequence.driver):
+//   mouseX / mouseY  the pointer's position over the canvas is the progress (0–1).
+//   mouseWheel       the wheel moves the progress (sensitivity); touch: vertical drag.
+//                    While one runs, OrbitControls zoom is off. At either end the wheel
+//                    is let through, so the host page can scroll on.
+// Listeners sit on window and check the canvas rect: studio overlays above the
+// canvas would otherwise swallow the events.
+//
+// `autoplay` (published viewer): sequences flagged autoplay start once, on mount.
+//
+import { useEffect, useRef } from 'react';
+import { useFrame, useThree } from '@react-three/fiber';
+import ClipsRuntime from './ClipsRuntime.js';
+import { clipMap } from './sequenceUtils.js';
+/** Wheel delta in pixels, whatever the device reports. */
+const wheelPixels = (e) => e.deltaMode === 1 ? e.deltaY * 16 : e.deltaMode === 2 ? e.deltaY * window.innerHeight : e.deltaY;
+const ClipPlayer = ({ getSettings, autoplay }) => {
+    const camera = useThree((s) => s.camera);
+    const controls = useThree((s) => s.controls);
+    const gl = useThree((s) => s.gl);
+    // Read at restore time through a ref, so the context object stays stable.
+    const settingsRef = useRef(getSettings);
+    settingsRef.current = getSettings;
+    useEffect(() => {
+        ClipsRuntime.setContext({ camera, controls, getSettings: (state) => settingsRef.current(state) });
+        return () => ClipsRuntime.setContext(null);
+    }, [camera, controls]);
+    // --- autoplay (once per sequence id) -------------------------------------------
+    const autoplayed = useRef(new Set());
+    useEffect(() => {
+        if (!autoplay)
+            return;
+        const lookup = clipMap(autoplay.clips);
+        for (const seq of autoplay.sequences) {
+            if (!seq.autoplay || autoplayed.current.has(seq.id))
+                continue;
+            autoplayed.current.add(seq.id);
+            ClipsRuntime.playSequence(seq, lookup);
+        }
+    }, [autoplay?.sequences, autoplay?.clips]);
+    // --- input drivers ----------------------------------------------------------------
+    useEffect(() => {
+        const canvas = gl.domElement;
+        const inside = (x, y) => {
+            const r = canvas.getBoundingClientRect();
+            return x >= r.left && x <= r.right && y >= r.top && y <= r.bottom ? r : null;
+        };
+        /** Progress along the wheel-driven sequences; true when any of them moved. */
+        const nudgeWheel = (pixels) => {
+            let moved = false;
+            for (const d of ClipsRuntime.getDrivenSequences()) {
+                if (d.driver !== 'mouseWheel')
+                    continue;
+                const dir = d.settings?.invert ? -1 : 1;
+                const delta = pixels * dir * Math.max(0.01, d.settings?.sensitivity ?? 1) / 1000;
+                if (ClipsRuntime.nudgeSequenceProgress(d.id, delta))
+                    moved = true;
+            }
+            return moved;
+        };
+        let touchY = null;
+        const onPointerMove = (e) => {
+            const r = inside(e.clientX, e.clientY);
+            if (!r)
+                return;
+            for (const d of ClipsRuntime.getDrivenSequences()) {
+                if (d.driver !== 'mouseX' && d.driver !== 'mouseY')
+                    continue;
+                const raw = d.driver === 'mouseX' ? (e.clientX - r.left) / r.width : (e.clientY - r.top) / r.height;
+                ClipsRuntime.setSequenceProgress(d.id, d.settings?.invert ? 1 - raw : raw);
+            }
+            // Touch has no wheel: a vertical drag stands in for it (drag up = forward).
+            if (e.pointerType === 'touch' && touchY !== null) {
+                nudgeWheel(touchY - e.clientY);
+                touchY = e.clientY;
+            }
+        };
+        const onPointerDown = (e) => {
+            if (e.pointerType === 'touch' && inside(e.clientX, e.clientY))
+                touchY = e.clientY;
+        };
+        const onPointerUp = () => { touchY = null; };
+        const onWheel = (e) => {
+            if (!inside(e.clientX, e.clientY))
+                return;
+            // Only swallow the wheel while it moved something; at either end the page scrolls.
+            if (nudgeWheel(wheelPixels(e)))
+                e.preventDefault();
+        };
+        window.addEventListener('pointermove', onPointerMove);
+        window.addEventListener('pointerdown', onPointerDown);
+        window.addEventListener('pointerup', onPointerUp);
+        window.addEventListener('pointercancel', onPointerUp);
+        window.addEventListener('wheel', onWheel, { passive: false });
+        return () => {
+            window.removeEventListener('pointermove', onPointerMove);
+            window.removeEventListener('pointerdown', onPointerDown);
+            window.removeEventListener('pointerup', onPointerUp);
+            window.removeEventListener('pointercancel', onPointerUp);
+            window.removeEventListener('wheel', onWheel);
+        };
+    }, [gl]);
+    // --- zoom: OrbitControls must not zoom while the wheel drives a sequence -----------
+    const zoomRestore = useRef(null);
+    useEffect(() => () => {
+        const z = zoomRestore.current;
+        if (z?.controls)
+            z.controls.enableZoom = z.enableZoom;
+        zoomRestore.current = null;
+    }, []);
+    useFrame((_state, delta) => {
+        ClipsRuntime.tick(delta);
+        const wheelActive = ClipsRuntime.getDrivenSequences().some(d => d.driver === 'mouseWheel');
+        const z = zoomRestore.current;
+        if (wheelActive && controls && !z) {
+            zoomRestore.current = { controls, enableZoom: controls.enableZoom !== false };
+            controls.enableZoom = false;
+        }
+        else if ((!wheelActive || z?.controls !== controls) && z) {
+            if (z.controls)
+                z.controls.enableZoom = z.enableZoom;
+            zoomRestore.current = null;
+        }
+    });
+    return null;
+};
+export default ClipPlayer;

package/dist/animationsV2/ClipsRuntime.d.ts

@@ -0,0 +1,111 @@
+import type { AnimationClip, AnimationSequence, KeyValue, Track } from './types';
+import { type ApplyContext } from './appliers';
+import { type ClipLookup, type ScheduledClip } from './sequenceUtils';
+/** A driven sequence as the input layer sees it. */
+export interface DrivenSequence {
+    id: string;
+    driver: AnimationSequence['driver'];
+    settings: AnimationSequence['driverSettings'];
+    /** 0–1 along the sequence's own direction (reverse flips it). */
+    progress: number;
+}
+export type RuntimeEventType = 'start' | 'end' | 'loop';
+export interface RuntimeEvent {
+    type: RuntimeEventType;
+    kind: 'clip' | 'sequence';
+    id: string;
+}
+/** @deprecated name kept for existing imports */
+export type ClipEvent = RuntimeEvent;
+declare class ClipsRuntime {
+    private clips;
+    private sequences;
+    private ctx;
+    private order;
+    private version;
+    private listeners;
+    private eventListeners;
+    /** tracks whose authored value must be written back on the next tick */
+    private pendingRestore;
+    /** last written value per property (targetKey -> JSON) */
+    private written;
+    setContext(ctx: ApplyContext | null): void;
+    subscribe(listener: () => void): () => void;
+    getVersion(): number;
+    on(listener: (e: RuntimeEvent) => void): () => void;
+    play(clip: AnimationClip, opts?: {
+        from?: number;
+        speed?: number;
+        reverse?: boolean;
+    }): void;
+    pause(clipId: string): void;
+    resume(clipId: string): void;
+    /** Stop and put the clip's properties back to their authored values. */
+    stop(clipId: string): void;
+    /** Hold the clip at t (seconds) — the editor playhead, or seek() from outside. */
+    pose(clip: AnimationClip, t: number): void;
+    /** The clip data changed (editor edit): keep time and play state, use the new tracks. */
+    updateClip(clip: AnimationClip): void;
+    getTime(clipId: string): number;
+    isPlaying(clipId: string): boolean;
+    isActive(clipId: string): boolean;
+    /** Value of a track at the clip's current time (the panel's value column). */
+    sampleAt(clip: AnimationClip, track: Track): KeyValue | undefined;
+    /**
+     * Play a sequence. `reverse` defaults to the sequence's own; `from` is sequence
+     * seconds (defaults to the current time, or the start edge of the run).
+     */
+    playSequence(seq: AnimationSequence, clips: ClipLookup, opts?: {
+        from?: number;
+        speed?: number;
+        reverse?: boolean;
+    }): void;
+    /** Driven sequences that are running — what the input layer (ClipPlayer) feeds. */
+    getDrivenSequences(): DrivenSequence[];
+    /**
+     * Set a sequence's position, 0–1 along its own direction (reverse flips it). A
+     * driven sequence eases there (its smoothing); any other is posed there at once.
+     */
+    setSequenceProgress(seqId: string, progress: number): boolean;
+    /**
+     * Move a driven sequence's target by `delta` of its length (the wheel). Returns
+     * false when it is already at that end — the caller then lets the event through
+     * (page scroll), so a visitor is never trapped inside the canvas.
+     */
+    nudgeSequenceProgress(seqId: string, delta: number): boolean;
+    getSequenceProgress(seqId: string): number;
+    private progressOf;
+    private timeOf;
+    pauseSequence(seqId: string): void;
+    resumeSequence(seqId: string): void;
+    /** Stop and put every property the sequence drove back to its authored value. */
+    stopSequence(seqId: string): void;
+    /** Hold the sequence at T (sequence seconds) — the panel's scrub, or seek(). */
+    poseSequence(seq: AnimationSequence, clips: ClipLookup, T: number): void;
+    /** The sequence or one of its clips changed: re-resolve, keep time and play state. */
+    updateSequence(seq: AnimationSequence, clips: ClipLookup): void;
+    getSequenceTime(seqId: string): number;
+    getSequenceDuration(seqId: string): number;
+    isSequencePlaying(seqId: string): boolean;
+    isSequenceActive(seqId: string): boolean;
+    tick(delta: number): void;
+    /** Every driver's values for this frame, lowest priority first. */
+    private proposals;
+    private runRestores;
+    /** Whether any active driver still has a track on (state, node, path). */
+    private isDriven;
+    private advanceClip;
+    private finishClip;
+    /**
+     * Same edge rules as a clip, on the sequence clock. "Forward" is the run's base
+     * direction: a reversed run starts at the end and finishes at 0.
+     */
+    private advanceSequence;
+    private finishSequence;
+    private emit;
+    private bump;
+}
+export type { ScheduledClip };
+declare const clipsRuntime: ClipsRuntime;
+export default clipsRuntime;
+//# sourceMappingURL=ClipsRuntime.d.ts.map

package/dist/animationsV2/ClipsRuntime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClipsRuntime.d.ts","sourceRoot":"","sources":["../../src/animationsV2/ClipsRuntime.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEjF,OAAO,EAAkC,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/E,OAAO,EAEL,KAAK,UAAU,EAAE,KAAK,aAAa,EACpC,MAAM,iBAAiB,CAAC;AA+BzB,oDAAoD;AACpD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACpC,QAAQ,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAC9C,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;AACxD,MAAM,WAAW,YAAY;IAAG,IAAI,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE;AAC/F,iDAAiD;AACjD,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC;AAMrC,cAAM,YAAY;IAChB,OAAO,CAAC,KAAK,CAAmC;IAChD,OAAO,CAAC,SAAS,CAAuC;IACxD,OAAO,CAAC,GAAG,CAA6B;IACxC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,OAAO,CAAK;IACpB,OAAO,CAAC,SAAS,CAAyB;IAC1C,OAAO,CAAC,cAAc,CAAwC;IAC9D,wEAAwE;IACxE,OAAO,CAAC,cAAc,CAAe;IACrC,0DAA0D;IAC1D,OAAO,CAAC,OAAO,CAA6B;IAI5C,UAAU,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,GAAG,IAAI;IAM1C,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAI3C,UAAU,IAAI,MAAM;IACpB,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI;IAOnD,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IAYhG,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO5B,wEAAwE;IACxE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQ1B,kFAAkF;IAClF,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAY1C,yFAAyF;IACzF,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAWrC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAC/B,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAEjC,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,GAAG,QAAQ,GAAG,SAAS;IAMjE;;;OAGG;IACH,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IA4B9H,mFAAmF;IACnF,kBAAkB,IAAI,cAAc,EAAE;IAStC;;;OAGG;IACH,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAU7D;;;;OAIG;IACH,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAW5D,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAK1C,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,MAAM;IAKd,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOlC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOnC,iFAAiF;IACjF,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQjC,gFAAgF;IAChF,YAAY,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAkBxE,sFAAsF;IACtF,cAAc,CAAC,GAAG,EAAE,iBAAiB,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IAe/D,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IACtC,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAC1C,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IACzC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIxC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IA+CzB,mEAAmE;IACnE,OAAO,CAAE,SAAS;IAqBlB,OAAO,CAAC,WAAW;IAqBnB,0EAA0E;IAC1E,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,WAAW;IAwBnB,OAAO,CAAC,UAAU;IAMlB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAuCvB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,IAAI;CAIb;AAaD,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B,QAAA,MAAM,YAAY,cAAqB,CAAC;AACxC,eAAe,YAAY,CAAC"}