Merge pull request #111 from Kitware/ondataavailable-callback

feat: onDataAvailable representation callback

Author: floryst

src/core/Geometry2DRepresentation.tsx

@@ -65,6 +65,16 @@ export interface Geometry2DRepresentationProps extends PropsWithChildren {
    * The coordinate system in which the input dataset resides.
    */
   transformCoordinate?: ICoordinateInitialValues;
+
+  /**
+   * Event callback for when data is made available.
+   *
+   * By the time this callback is invoked, you can be sure that:
+   * - the mapper has the input data
+   * - the actor is visible (unless explicitly marked as not visible)
+   * - initial properties are set
+   */
+  onDataAvailable?: () => void;
 }
 
 const DefaultProps = {
@@ -141,6 +151,16 @@ export default forwardRef(function Geometry2DRepresentation(
     ([cur], [prev]) => compareShallowObject(cur, prev)
   );
 
+  // --- events --- //
+
+  const { onDataAvailable } = props;
+  useEffect(() => {
+    if (dataAvailable) {
+      // trigger onDataAvailable after making updates to the actor and mapper
+      onDataAvailable?.();
+    }
+  }, [dataAvailable, onDataAvailable]);
+
   // --- //
 
   const renderer = useRendererContext();

src/core/GeometryRepresentation.tsx

@@ -88,6 +88,16 @@ export interface GeometryRepresentationProps extends PropsWithChildren {
    * TODO fix type
    */
   scalarBarStyle?: Record<string, unknown>;
+
+  /**
+   * Event callback for when data is made available.
+   *
+   * By the time this callback is invoked, you can be sure that:
+   * - the mapper has the input data
+   * - the actor is visible (unless explicitly marked as not visible)
+   * - initial properties are set
+   */
+  onDataAvailable?: () => void;
 }
 
 const DefaultProps = {
@@ -154,6 +164,16 @@ export default forwardRef(function GeometryRepresentation(
     ([cur], [prev]) => compareShallowObject(cur, prev)
   );
 
+  // --- events --- //
+
+  const { onDataAvailable } = props;
+  useEffect(() => {
+    if (dataAvailable) {
+      // trigger onDataAvailable after making updates to the actor and mapper
+      onDataAvailable?.();
+    }
+  }, [dataAvailable, onDataAvailable]);
+
   // --- //
 
   const renderer = useRendererContext();

src/core/SliceRepresentation.tsx

@@ -97,6 +97,16 @@ export interface SliceRepresentationProps extends PropsWithChildren {
    * index of the slice along z
    */
   zSlice?: number;
+
+  /**
+   * Event callback for when data is made available.
+   *
+   * By the time this callback is invoked, you can be sure that:
+   * - the mapper has the input data
+   * - the actor is visible (unless explicitly marked as not visible)
+   * - initial properties are set
+   */
+  onDataAvailable?: () => void;
 }
 
 const DefaultProps = {
@@ -135,8 +145,6 @@ export default forwardRef(function SliceRepresentation(
     trackModified
   );
 
-  // --- PWF --- //
-
   // --- mapper --- //
 
   const getInternalMapper = useMapper(
@@ -243,6 +251,16 @@ export default forwardRef(function SliceRepresentation(
     }
   }, [kSlice, getMapper, trackModified]);
 
+  // --- events --- //
+
+  const { onDataAvailable } = props;
+  useEffect(() => {
+    if (dataAvailable) {
+      // trigger onDataAvailable after making updates to the actor and mapper
+      onDataAvailable?.();
+    }
+  }, [dataAvailable, onDataAvailable]);
+
   // --- //
 
   const renderer = useRendererContext();