@3driseai/3drise-viewer 0.1.24 → 0.1.26

package/dist/operations/runtime.js

@@ -0,0 +1,161 @@
+import { SceneActions, findNodesByName } from '@3driseai/3drise-core';
+import { findById } from '../utils/sceneQuery.js';
+import { getOperation, resolveParams } from './registry.js';
+const active = new Map(); // `${op}:${uuid}`
+const slots = new Map(); // exclusive group → active key
+const toolsStack = [];
+let cameraHome = null;
+const keyOf = (op, target) => `${op}:${target.uuid}`;
+const tools = () => toolsStack[toolsStack.length - 1];
+function context(self) {
+    const t = tools();
+    if (!t)
+        return null;
+    return {
+        tools: t,
+        self,
+        saveCameraHome: () => { if (!cameraHome)
+            cameraHome = t.cameraPose(); },
+        restoreCameraHome: (duration, ease) => {
+            const home = cameraHome;
+            cameraHome = null;
+            if (home)
+                void t.animateCamera({ position: home.position }, duration, ease, home.target);
+        },
+    };
+}
+/** Register the mounted scene's tools. Returns the unregister. */
+export function registerOperationTools(t) {
+    toolsStack.push(t);
+    ensureActionsSubscription();
+    return () => {
+        const i = toolsStack.lastIndexOf(t);
+        if (i >= 0)
+            toolsStack.splice(i, 1);
+        if (toolsStack.length === 0) {
+            active.clear();
+            slots.clear();
+            cameraHome = null;
+        }
+    };
+}
+export function isOperationOn(op, target) {
+    return active.has(keyOf(op, target));
+}
+export function applyOperation(def, target, params, self) {
+    const ctx = context(self);
+    if (!ctx)
+        return false;
+    const key = keyOf(def.value, target);
+    if (def.exclusive) {
+        const prevKey = slots.get(def.exclusive.group);
+        if (prevKey && prevKey !== key) {
+            const prev = active.get(prevKey);
+            active.delete(prevKey);
+            const prevDef = prev && getOperation(prev.op);
+            // `revert` puts the previous one back; `handover` leaves it to the new one.
+            if (prev && prevDef?.revert && def.exclusive.release === 'revert')
+                prevDef.revert(prev.target, prev.params, ctx);
+        }
+        slots.set(def.exclusive.group, key);
+    }
+    void def.apply(target, params, ctx);
+    if (def.revert)
+        active.set(key, { op: def.value, target, params });
+    return true;
+}
+export function revertOperation(def, target) {
+    const key = keyOf(def.value, target);
+    const entry = active.get(key);
+    const ctx = context();
+    if (!entry || !ctx || !def.revert)
+        return false;
+    active.delete(key);
+    if (def.exclusive && slots.get(def.exclusive.group) === key)
+        slots.delete(def.exclusive.group);
+    def.revert(target, entry.params, ctx);
+    return true;
+}
+/** The objects an effect acts on: 'self', object ids, narrowed to model nodes. */
+export function resolveEffectTargets(effect, self) {
+    const out = [];
+    for (const t of effect.targets ?? []) {
+        const root = t === 'self' ? self : findById(t);
+        if (!root)
+            continue;
+        const names = t === 'self' ? undefined : effect.meshNames?.[t];
+        if (names?.length) {
+            for (const name of names)
+                out.push(...findNodesByName(root, name).filter(n => n !== root));
+        }
+        else {
+            out.push(root);
+        }
+    }
+    return out;
+}
+/**
+ * Run one effect.
+ *   trigger  interactions: toggle when the operation toggles, else apply
+ *   apply / revert / toggle  explicit
+ */
+export function runEffect(effect, mode, self) {
+    const def = getOperation(effect.operation);
+    if (!def)
+        return;
+    const targets = resolveEffectTargets(effect, self);
+    const params = resolveParams(def, effect.params);
+    for (const target of def.multi ? targets : targets.slice(0, 1)) {
+        const on = isOperationOn(def.value, target);
+        const m = mode === 'trigger' ? (def.toggles ? 'toggle' : 'apply') : mode;
+        if (m === 'revert' || (m === 'toggle' && on))
+            revertOperation(def, target);
+        else if (m === 'apply' || m === 'toggle')
+            applyOperation(def, target, params, self);
+    }
+}
+// ---------------------------------------------------------------- actions
+const actionEffectsOn = new Set();
+const listeners = new Set();
+const notify = () => listeners.forEach(l => { try {
+    l();
+}
+catch { /* listener error */ } });
+/** Apply or undo an action's effects directly (the editor's "Try it"). */
+export function runActionEffects(action, mode) {
+    const on = actionEffectsOn.has(action.id);
+    if (mode === 'apply' && on)
+        return;
+    if (mode === 'revert' && !on)
+        return;
+    for (const effect of action.effects ?? [])
+        runEffect(effect, mode);
+    if (mode === 'apply')
+        actionEffectsOn.add(action.id);
+    else
+        actionEffectsOn.delete(action.id);
+    notify();
+}
+export const areActionEffectsOn = (actionId) => actionEffectsOn.has(actionId);
+/** Subscribe to action-effects on/off changes (studio badges). */
+export function subscribeActionEffects(fn) {
+    listeners.add(fn);
+    return () => { listeners.delete(fn); };
+}
+let unsubscribeActions = null;
+function ensureActionsSubscription() {
+    if (unsubscribeActions)
+        return;
+    unsubscribeActions = SceneActions.onEvent((e) => {
+        if (e.type === 'applied') {
+            if (e.runEffects)
+                runActionEffects(e.action, 'apply');
+        }
+        else if (e.type === 'reverted') {
+            runActionEffects(e.action, 'revert');
+        }
+        else if (e.type === 'reset') {
+            e.actions.forEach(a => runActionEffects(a, 'revert'));
+        }
+    });
+}

package/dist/operations/types.d.ts

@@ -0,0 +1,96 @@
+import type { Object3D } from 'three';
+import type { OperationName, OperationParamValue, Vector3Array } from '@3driseai/3drise-core';
+/** A parameter the studio shows under the effect, with its default. */
+export type OperationParamSpec = {
+    type: 'number';
+    label: string;
+    default: number;
+    min?: number;
+    max?: number;
+    step?: number;
+    unit?: string;
+    hint?: string;
+} | {
+    type: 'color';
+    label: string;
+    default: string;
+    hint?: string;
+} | {
+    type: 'select';
+    label: string;
+    default: string;
+    options: Array<{
+        value: string;
+        label: string;
+    }>;
+    hint?: string;
+} | {
+    type: 'boolean';
+    label: string;
+    default: boolean;
+    hint?: string;
+};
+export type OperationParams = Record<string, OperationParamValue>;
+export type OperationSource = 'interaction' | 'action';
+/** Scene tools the runtime hands an operation (built from the viewer's hooks). */
+export interface OperationTools {
+    /** Animate the camera; `lookAt` moves the orbit target. */
+    animateCamera: (to: {
+        position?: Vector3Array;
+    }, duration: number, ease: string, lookAt?: Vector3Array) => Promise<void>;
+    /** Where the camera is and looks right now. */
+    cameraPose: () => {
+        position: Vector3Array;
+        target: Vector3Array;
+    } | null;
+    moveToFront: (object: Object3D, options: {
+        distance: number;
+        scale: [number, number];
+        duration: number;
+        ease: string;
+    }) => void;
+    restoreTransform: (object: Object3D, options: {
+        duration: number;
+        ease: string;
+    }) => void;
+}
+export interface OperationContext {
+    tools: OperationTools;
+    /** The object an interaction is on (interactions only). */
+    self?: Object3D | null;
+    /** Remember the camera pose once, before the first camera operation. */
+    saveCameraHome: () => void;
+    /** Fly back to the remembered pose and forget it. */
+    restoreCameraHome: (duration: number, ease: string) => void;
+}
+export interface OperationDefinition {
+    value: OperationName;
+    label: string;
+    /** One line for the studio (tooltip). */
+    description: string;
+    /** More than one target allowed. */
+    multi: boolean;
+    /** An interaction triggered again undoes it. */
+    toggles: boolean;
+    /** Where the operation can be used. */
+    usableIn: OperationSource[];
+    /** Only on gallery objects. */
+    galleryOnly?: boolean;
+    /**
+     * One target of this group is "on" at a time, scene-wide. Applying another:
+     * `revert` undoes the previous one first (bring to front), `handover` just
+     * takes over (camera moves — the remembered home pose stays).
+     */
+    exclusive?: {
+        group: string;
+        release: 'revert' | 'handover';
+    };
+    params?: Record<string, OperationParamSpec>;
+    apply: (target: Object3D, params: OperationParams, ctx: OperationContext) => void | Promise<void>;
+    /** No revert = one-way (applies only). */
+    revert?: (target: Object3D, params: OperationParams, ctx: OperationContext) => void;
+}
+/** Type helper for catalogue files. */
+export declare const defineOperation: (def: OperationDefinition) => OperationDefinition;
+export declare const DEFAULT_EASE = "power2.out";
+//# sourceMappingURL=types.d.ts.map

package/dist/operations/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/operations/types.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE9F,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GACxB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3H;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAChE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACnH;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1E,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAElE,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,QAAQ,CAAC;AAEvD,kFAAkF;AAClF,MAAM,WAAW,cAAc;IAC3B,2DAA2D;IAC3D,aAAa,EAAE,CAAC,EAAE,EAAE;QAAE,QAAQ,CAAC,EAAE,YAAY,CAAA;KAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzH,+CAA+C;IAC/C,UAAU,EAAE,MAAM;QAAE,QAAQ,EAAE,YAAY,CAAC;QAAC,MAAM,EAAE,YAAY,CAAA;KAAE,GAAG,IAAI,CAAC;IAC1E,WAAW,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAChI,gBAAgB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC7F;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,cAAc,CAAC;IACtB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,wEAAwE;IACxE,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,qDAAqD;IACrD,iBAAiB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC/D;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,aAAa,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,KAAK,EAAE,OAAO,CAAC;IACf,gDAAgD;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,uCAAuC;IACvC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,+BAA+B;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,QAAQ,GAAG,UAAU,CAAA;KAAE,CAAC;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC5C,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClG,0CAA0C;IAC1C,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;CACvF;AAED,uCAAuC;AACvC,eAAO,MAAM,eAAe,GAAI,KAAK,mBAAmB,KAAG,mBAA0B,CAAC;AAEtF,eAAO,MAAM,YAAY,eAAe,CAAC"}

package/dist/operations/types.js

@@ -0,0 +1,3 @@
+/** Type helper for catalogue files. */
+export const defineOperation = (def) => def;
+export const DEFAULT_EASE = 'power2.out';

package/dist/operations/useOperationsRuntime.d.ts

@@ -0,0 +1,3 @@
+import type { CameraState } from '@3driseai/3drise-core';
+export declare function useOperationsRuntime(cameraSettings: CameraState): void;
+//# sourceMappingURL=useOperationsRuntime.d.ts.map

package/dist/operations/useOperationsRuntime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOperationsRuntime.d.ts","sourceRoot":"","sources":["../../src/operations/useOperationsRuntime.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAgB,MAAM,uBAAuB,CAAC;AAQvE,wBAAgB,oBAAoB,CAAC,cAAc,EAAE,WAAW,QAuB/D"}

package/dist/operations/useOperationsRuntime.js

@@ -0,0 +1,31 @@
+// Mounts the operations runtime on the scene: builds the scene tools from the
+// viewer's hooks and registers them. Called once, in ObjectsRenderer.
+import { useEffect, useRef } from 'react';
+import cameraManager from '../utils/CameraSingleton.js';
+import useCameraAnimation from '../hooks/useCameraAnimation.js';
+import { useFrameAnimations } from '../hooks/useFrameAnimations.js';
+import { useOrbitControls } from '../hooks/useOrbitControls.js';
+import { registerOperationTools } from './runtime.js';
+export function useOperationsRuntime(cameraSettings) {
+    const { animateCamera } = useCameraAnimation({ autoAnimate: false, defaultDuration: 1, defaultEase: 'power2.out' });
+    const { moveToFront, restoreOriginalTransform } = useFrameAnimations(cameraSettings);
+    const controls = useOrbitControls();
+    // Latest hook functions, read at call time (the registration itself is stable).
+    const latest = useRef({ animateCamera, moveToFront, restoreOriginalTransform, controls, cameraSettings });
+    latest.current = { animateCamera, moveToFront, restoreOriginalTransform, controls, cameraSettings };
+    useEffect(() => registerOperationTools({
+        animateCamera: (to, duration, ease, lookAt) => latest.current.animateCamera(to, duration, ease, lookAt),
+        cameraPose: () => {
+            const pos = cameraManager.getPosition();
+            if (!pos)
+                return null;
+            const t = latest.current.controls?.target;
+            const target = t
+                ? [t.x, t.y, t.z]
+                : latest.current.cameraSettings?.controls?.target ?? [0, 0, 0];
+            return { position: [pos.x, pos.y, pos.z], target };
+        },
+        moveToFront: (object, o) => latest.current.moveToFront(object, o),
+        restoreTransform: (object, o) => latest.current.restoreOriginalTransform(object, o),
+    }), []);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@3driseai/3drise-viewer",
-  "version": "0.1.24",
+  "version": "0.1.26",
   "private": false,
   "type": "module",
   "main": "./dist/index.js",
@@ -39,6 +39,6 @@
   },
   "dependencies": {
     "@3driseai/3drise-common": "^1.0.1",
-    "@3driseai/3drise-core": "^1.0.17"
+    "@3driseai/3drise-core": "^1.0.19"
   }
 }