feat: history labelmap

common/reviews/api/core.api.md

@@ -699,6 +699,9 @@ function decimate(list: Array<unknown>, interleave: number, offset?: number): nu
 // @public (undocumented)
 const deepMerge: (target?: {}, source?: {}, optionsArgument?: any) => any;
 
+// @public (undocumented)
+const DefaultHistoryMemo: HistoryMemo;
+
 // @public (undocumented)
 type DisplayArea = {
     imageArea?: [number, number];
@@ -767,7 +770,8 @@ declare namespace Enums {
         ViewportStatus,
         VideoEnums,
         MetadataModules,
-        ImageQualityStatus
+        ImageQualityStatus,
+        VoxelManagerEnum
     }
 }
 export { Enums }
@@ -1096,6 +1100,30 @@ export function getWebWorkerManager(): any;
 // @public (undocumented)
 function hasNaNValues(input: number[] | number): boolean;
 
+// @public (undocumented)
+class HistoryMemo {
+    constructor(label?: string, size?: number);
+    // (undocumented)
+    readonly label: any;
+    // (undocumented)
+    push(item: Memo | Memoable): Memo;
+    // (undocumented)
+    redo(items?: number): void;
+    // (undocumented)
+    get size(): any;
+    // (undocumented)
+    undo(items?: number): void;
+}
+
+declare namespace HistoryMemo_2 {
+    export {
+        Memo,
+        Memoable,
+        HistoryMemo,
+        DefaultHistoryMemo
+    }
+}
+
 // @public (undocumented)
 interface ICache {
     // (undocumented)
@@ -1872,6 +1900,8 @@ export class ImageVolume implements IImageVolume {
     // (undocumented)
     readonly volumeId: string;
     // (undocumented)
+    voxelManager?: VoxelManager<number> | VoxelManager<RGB>;
+    // (undocumented)
     vtkOpenGLTexture: any;
 }
 
@@ -1899,6 +1929,8 @@ interface ImageVolumeProps extends VolumeProps {
     imageIds: Array<string>;
     // (undocumented)
     referencedImageIds?: Array<string>;
+    // (undocumented)
+    voxelManager?: VoxelManager<number> | VoxelManager<Point3>;
 }
 
 // @public (undocumented)
@@ -2401,6 +2433,17 @@ function makeVolumeMetadata(imageIds: Array<string>): Metadata;
 // @public (undocumented)
 type Mat3 = [number, number, number, number, number, number, number, number, number] | Float32Array;
 
+// @public (undocumented)
+type Memo = {
+    restoreMemo: (undo?: boolean) => void;
+    commitMemo?: () => boolean;
+};
+
+// @public (undocumented)
+type Memoable = {
+    createMemo: () => Memo;
+};
+
 // @public (undocumented)
 type Metadata = {
     BitsAllocated: number;
@@ -2517,7 +2560,7 @@ function performCacheOptimizationForVolume(volume: any): void;
 type PixelDataTypedArray = Float32Array | Int16Array | Uint16Array | Uint8Array | Int8Array | Uint8ClampedArray;
 
 // @public (undocumented)
-type PixelDataTypedArrayString = 'Float32Array' | 'Int16Array' | 'Uint16Array' | 'Uint8Array' | 'Int8Array' | 'Uint8ClampedArray';
+type PixelDataTypedArrayString = 'Float32Array' | 'Int16Array' | 'Uint16Array' | 'Uint8Array' | 'Int8Array' | 'Uint8ClampedArray' | 'none';
 
 declare namespace planar {
     export {
@@ -2556,7 +2599,7 @@ class PointsManager<T> {
     // (undocumented)
     static create2(initialSize?: number): PointsManager<Point2>;
     // (undocumented)
-    static create3(initialSize?: number): PointsManager<Point3>;
+    static create3(initialSize?: number, points?: Point3[]): PointsManager<Point3>;
     // (undocumented)
     data: Float32Array;
     // (undocumented)
@@ -2574,6 +2617,8 @@ class PointsManager<T> {
     // (undocumented)
     getPointArray(index: number): T;
     // (undocumented)
+    getTypedArray(): Float32Array;
+    // (undocumented)
     protected grow(additionalSize?: number, growSize?: number): void;
     // (undocumented)
     growSize: number;
@@ -2845,6 +2890,77 @@ export interface RetrieveStage {
 // @public (undocumented)
 type RGB = [number, number, number];
 
+// @public (undocumented)
+class RLEVoxelMap<T> {
+    constructor(width: number, height: number, depth?: number);
+    // (undocumented)
+    clear(): void;
+    // (undocumented)
+    static copyMap<T>(destination: RLEVoxelMap<T>, source: RLEVoxelMap<T>): void;
+    // (undocumented)
+    defaultValue: T;
+    // (undocumented)
+    delete(index: number): void;
+    // (undocumented)
+    protected depth: number;
+    // (undocumented)
+    fillFrom(getter: (i: number, j: number, k: number) => T, boundsIJK: BoundsIJK): void;
+    // (undocumented)
+    findAdjacents(item: [RLERun<T>, number, number, Point3[]?], { diagonals, planar, singlePlane }: {
+        diagonals?: boolean;
+        planar?: boolean;
+        singlePlane?: boolean;
+    }): any[];
+    // (undocumented)
+    protected findIndex(row: RLERun<T>[], i: number): number;
+    // (undocumented)
+    floodFill(i: number, j: number, k: number, value: T, options?: {
+        planar?: boolean;
+        diagonals?: boolean;
+        singlePlane?: boolean;
+    }): number;
+    // (undocumented)
+    forEach(callback: any, options?: {
+        rowModified?: boolean;
+    }): void;
+    // (undocumented)
+    forEachRow(callback: any): void;
+    // (undocumented)
+    get: (index: number) => T;
+    // (undocumented)
+    getPixelData(k?: number, pixelData?: PixelDataTypedArray): PixelDataTypedArray;
+    // (undocumented)
+    protected getRLE(i: number, j: number, k?: number): RLERun<T>;
+    // (undocumented)
+    getRun: (j: number, k: number) => RLERun<T>[];
+    // (undocumented)
+    has(index: number): boolean;
+    // (undocumented)
+    protected height: number;
+    // (undocumented)
+    protected jMultiple: number;
+    // (undocumented)
+    keys(): number[];
+    // (undocumented)
+    protected kMultiple: number;
+    // (undocumented)
+    normalizer: PlaneNormalizer;
+    // (undocumented)
+    protected numComps: number;
+    // (undocumented)
+    pixelDataConstructor: Uint8ArrayConstructor;
+    // (undocumented)
+    protected rows: Map<number, RLERun<T>[]>;
+    // (undocumented)
+    set: (index: number, value: T) => void;
+    // (undocumented)
+    toIJK(index: number): Point3;
+    // (undocumented)
+    toIndex([i, j, k]: Point3): number;
+    // (undocumented)
+    protected width: number;
+}
+
 // @public (undocumented)
 function roundNumber(value: string | number | (string | number)[], precision?: number): string;
 
@@ -3259,6 +3375,10 @@ declare namespace Types {
         IImage,
         IImageData,
         IImageCalibration,
+        Memo,
+        HistoryMemo,
+        VoxelManager,
+        RLEVoxelMap,
         CPUIImageData,
         CPUImageData,
         EventTypes,
@@ -3426,9 +3546,11 @@ declare namespace utilities {
         isValidVolume,
         metadataProvider_2 as genericMetadataProvider,
         isVideoTransferSyntax,
+        HistoryMemo_2 as HistoryMemo,
+        generateVolumePropsFromImageIds,
         getBufferConfiguration,
         VoxelManager,
-        generateVolumePropsFromImageIds,
+        RLEVoxelMap,
         convertStackToVolumeViewport,
         convertVolumeToStackViewport,
         cacheUtils,
@@ -4106,7 +4228,7 @@ class VoxelManager<T> {
     // (undocumented)
     boundsIJK: BoundsIJK;
     // (undocumented)
-    clear(): void;
+    clear(clearScalar?: boolean): void;
     // (undocumented)
     static createHistoryVoxelManager<T>(sourceVoxelManager: VoxelManager<T>): VoxelManager<T>;
     // (undocumented)
@@ -4118,6 +4240,8 @@ class VoxelManager<T> {
     // (undocumented)
     static createRGBVolumeVoxelManager(dimensions: Point3, scalarData: any, numComponents: any): VoxelManager<RGB>;
     // (undocumented)
+    static createRLEHistoryVoxelManager<T>(sourceVoxelManager: VoxelManager<T>): VoxelManager<T>;
+    // (undocumented)
     static createRLEVoxelManager<T>(dimensions: Point3): VoxelManager<T>;
     // (undocumented)
     static createVolumeVoxelManager(dimensions: Point3, scalarData: any, numComponents?: number): VoxelManager<number> | VoxelManager<RGB>;
@@ -4150,12 +4274,16 @@ class VoxelManager<T> {
     // (undocumented)
     map: Map<number, T> | RLEVoxelMap<T>;
     // (undocumented)
+    mapForEach(callback: any, options?: any): void;
+    // (undocumented)
     modifiedSlices: Set<number>;
     // (undocumented)
     numComps: number;
     // (undocumented)
     points: Set<number>;
     // (undocumented)
+    rleForEach(callback: any, options?: any): void;
+    // (undocumented)
     scalarData: PixelDataTypedArray;
     // (undocumented)
     _set: (index: number, v: T) => boolean | void;
@@ -4175,6 +4303,14 @@ class VoxelManager<T> {
     width: number;
 }
 
+// @public (undocumented)
+enum VoxelManagerEnum {
+    // (undocumented)
+    RLE = "RLE",
+    // (undocumented)
+    Volume = "Volume"
+}
+
 declare namespace windowLevel {
     export {
         toWindowLevel,