@imfusion/sdk-react 1.2.2-dev.4.g7a1b1c20 → 1.2.2-dev.5.g9f4fc80b

package/dist/index.d.ts

@@ -15,4 +15,5 @@ export { useViewVisibility } from './useViewVisibility.js';
 export { useDisplayOptions2d, useDisplayOptions3d } from './useDisplayOptions.js';
 export { useFrameSelection } from './useFrameSelection.js';
 export { useContextMenu } from './useContextMenu.js';
+export { useLabelConfig } from './useLabelConfig.js';
 export { useThumbnail } from './useThumbnail.js';

package/dist/index.js

@@ -15,4 +15,5 @@ export { useViewVisibility } from './useViewVisibility.js';
 export { useDisplayOptions2d, useDisplayOptions3d } from './useDisplayOptions.js';
 export { useFrameSelection } from './useFrameSelection.js';
 export { useContextMenu } from './useContextMenu.js';
+export { useLabelConfig } from './useLabelConfig.js';
 export { useThumbnail } from './useThumbnail.js';

package/dist/useLabelConfig.d.ts

@@ -0,0 +1,46 @@
+import { LabelConfig, SharedImageSet } from '@imfusion/sdk';
+/**
+ * Returns the reactive `LabelConfigMap` state of a label map.
+ *
+ * Subscribes to {@link @imfusion/sdk!EmbindModule.onLabelConfigChanged | onLabelConfigChanged}
+ *
+ * @param labelMap - The label map to observe
+ * @returns The current label config state as a `Map<number, LabelConfig>`, a function to change the whole map and a function to change individual entries
+ * @throws If called outside of an {@link ImFusionProvider}
+ * @throws If called before the SDK has finished initializing
+ *
+ * @example
+ * ```tsx
+ * function ToggleLabelVisibility({ labelMap }: { labelMap: SharedImageSet }) {
+ *   const { labelConfigs, setLabelConfigs, setLabelConfig } = useLabelConfig(labelMap);
+ *
+ *   if (!labelConfigs) return;
+ *
+ *   const keys = [...labelConfigs.keys()];
+ *   const toggleVisibility = (labelValue: number, config: LabelConfig) => {
+ *     let next = config;
+ *     next.isVisible2d = !next.isVisible2d;
+ *     setLabelConfig(labelValue, next);
+ *   };
+ *
+ *   return (
+ *     <ul>
+ *       {keys.map((labelValue) => {
+ *         const config = labelConfigs.get(labelValue)!;
+ *         return (
+ *           <li onClick={() => toggleVisibility(labelValue, config)}>
+ *             {config.isVisible2d ? 'visible' : 'invisible'}
+ *           </li>
+ *         );
+ *       })}
+ *     </ul>
+ *   );
+ * }
+ * }
+ * ```
+ */
+export declare function useLabelConfig(labelMap: SharedImageSet | null): {
+    labelConfigs: Map<number, LabelConfig> | undefined;
+    setLabelConfigs: (labelConfigMap: Map<number, LabelConfig>) => void;
+    setLabelConfig: (labelValue: number, labelConfig: LabelConfig) => void;
+};

package/dist/useLabelConfig.js

@@ -0,0 +1,68 @@
+import { useState, useEffect, useCallback } from 'react';
+import { useImFusion } from './useImFusion.js';
+import { useStableHandle } from './useStableHandle.js';
+/**
+ * Returns the reactive `LabelConfigMap` state of a label map.
+ *
+ * Subscribes to {@link @imfusion/sdk!EmbindModule.onLabelConfigChanged | onLabelConfigChanged}
+ *
+ * @param labelMap - The label map to observe
+ * @returns The current label config state as a `Map<number, LabelConfig>`, a function to change the whole map and a function to change individual entries
+ * @throws If called outside of an {@link ImFusionProvider}
+ * @throws If called before the SDK has finished initializing
+ *
+ * @example
+ * ```tsx
+ * function ToggleLabelVisibility({ labelMap }: { labelMap: SharedImageSet }) {
+ *   const { labelConfigs, setLabelConfigs, setLabelConfig } = useLabelConfig(labelMap);
+ *
+ *   if (!labelConfigs) return;
+ *
+ *   const keys = [...labelConfigs.keys()];
+ *   const toggleVisibility = (labelValue: number, config: LabelConfig) => {
+ *     let next = config;
+ *     next.isVisible2d = !next.isVisible2d;
+ *     setLabelConfig(labelValue, next);
+ *   };
+ *
+ *   return (
+ *     <ul>
+ *       {keys.map((labelValue) => {
+ *         const config = labelConfigs.get(labelValue)!;
+ *         return (
+ *           <li onClick={() => toggleVisibility(labelValue, config)}>
+ *             {config.isVisible2d ? 'visible' : 'invisible'}
+ *           </li>
+ *         );
+ *       })}
+ *     </ul>
+ *   );
+ * }
+ * }
+ * ```
+ */
+export function useLabelConfig(labelMap) {
+    const imf = useImFusion();
+    const stableLabelMap = useStableHandle(labelMap ?? undefined);
+    const [labelConfigs, setLabelConfigsState] = useState(() => stableLabelMap ? imf.bindings.getLabelConfigs(stableLabelMap) : undefined);
+    useEffect(() => {
+        if (!stableLabelMap) {
+            setLabelConfigsState(undefined);
+            return;
+        }
+        setLabelConfigsState(imf.bindings.getLabelConfigs(stableLabelMap));
+        const off = imf.bindings.onLabelConfigChanged(stableLabelMap, () => {
+            setLabelConfigsState(imf.bindings.getLabelConfigs(stableLabelMap));
+        });
+        return off;
+    }, [imf, stableLabelMap]);
+    const setLabelConfigs = useCallback((labelConfigMap) => {
+        if (stableLabelMap)
+            imf.bindings.setLabelConfigs(stableLabelMap, labelConfigMap);
+    }, [imf, stableLabelMap]);
+    const setLabelConfig = useCallback((labelValue, labelConfig) => {
+        if (stableLabelMap)
+            imf.bindings.setLabelConfig(stableLabelMap, labelValue, labelConfig);
+    }, [imf, stableLabelMap]);
+    return { labelConfigs, setLabelConfigs, setLabelConfig };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imfusion/sdk-react",
-  "version": "1.2.2-dev.4.g7a1b1c20",
+  "version": "1.2.2-dev.5.g9f4fc80b",
   "description": "React bindings for ImFusion Web SDK",
   "homepage": "https://docs.imfusion.com/websdk",
   "author": "ImFusion GmbH",
@@ -30,7 +30,7 @@
     "LICENSE.txt"
   ],
   "peerDependencies": {
-    "@imfusion/sdk": "1.2.2-dev.4.g7a1b1c20",
+    "@imfusion/sdk": "1.2.2-dev.5.g9f4fc80b",
     "react": ">=18"
   },
   "devDependencies": {