feat: support hatch gradient fill (#12)

Author: mlightcad

bindings/javascript/embind/binding_common.cpp

@@ -466,6 +466,20 @@ emscripten::val dwg_ptr_to_hatch_path_array_wrapper(uintptr_t array_ptr, size_t
   return pathes;
 }
 
+emscripten::val dwg_ptr_to_hatch_gradient_color_array_wrapper(uintptr_t array_ptr, size_t size) {
+  Dwg_HATCH_Color* array = reinterpret_cast<Dwg_HATCH_Color*>(array_ptr);
+  emscripten::val colors = emscripten::val::array();
+  for (int i = 0; i < size; ++i) {
+    auto gradient_color = array[i];
+    emscripten::val gradient_color_obj = emscripten::val::object();
+    gradient_color_obj.set("reservedData", gradient_color.shift_value);
+    gradient_color_obj.set("rgb", gradient_color.color.rgb);
+    gradient_color_obj.set("colorIndex", gradient_color.color.index);
+    colors.call<void>("push", gradient_color_obj);
+  }
+  return colors;
+}
+
 emscripten::val dwg_ptr_to_mline_vertex_array_wrapper(uintptr_t array_ptr, size_t size) {
   Dwg_MLINE_vertex* array = reinterpret_cast<Dwg_MLINE_vertex*>(array_ptr);
   emscripten::val vertices = emscripten::val::array();
@@ -532,6 +546,7 @@ EMSCRIPTEN_BINDINGS(libredwg_array) {
   DEFINE_FUNC(dwg_ptr_to_table_cell_array);
   DEFINE_FUNC(dwg_ptr_to_hatch_defline_array);
   DEFINE_FUNC(dwg_ptr_to_hatch_path_array);
+  DEFINE_FUNC(dwg_ptr_to_hatch_gradient_color_array);
   DEFINE_FUNC(dwg_ptr_to_mline_vertex_array);
 }
 

bindings/javascript/package.json

@@ -3,7 +3,7 @@
   "description": "A DWG/DXF JavaScript parser based on libredwg",
   "license": "GPL-3.0",
   "private": false,
-  "version": "0.7.0",
+  "version": "0.7.1",
   "author": "MLight Lee <mlight.lee@outlook.com>",
   "type": "module",
   "repository": {

bindings/javascript/src/converter/entityConverter.ts

@@ -21,7 +21,9 @@ import {
   DwgEmbeddedMText,
   DwgEntity,
   DwgHatchAssociativity,
-  DwgHatchEntityBase,
+  DwgHatchEntity,
+  DwgHatchGradientColorFlag,
+  DwgHatchGradientFlag,
   DwgHatchPatternType,
   DwgHatchSolidFill,
   DwgHatchStyle,
@@ -676,7 +678,7 @@ export class LibreEntityConverter {
   private convertHatch(
     entity: Dwg_Object_Entity_Ptr,
     commonAttrs: DwgCommonAttributes
-  ): DwgHatchEntityBase {
+  ): DwgHatchEntity  {
     const libredwg = this.libredwg
     const extrusionDirection = libredwg.dwg_dynapi_entity_value(
       entity,
@@ -737,8 +739,7 @@ export class LibreEntityConverter {
       numberOfSeedPoints
     )
 
-    return {
-      type: 'HATCH',
+    const result = {
       ...commonAttrs,
       // elevationPoint: DwgPoint3D
       extrusionDirection: extrusionDirection,
@@ -772,6 +773,43 @@ export class LibreEntityConverter {
       seedPoints: seedPoints
       // gradientFlag?: DwgHatchGradientFlag
     }
+
+    const gradientFlag = libredwg.dwg_dynapi_entity_value(entity, 'is_gradient_fill')
+      .data as number
+    if (gradientFlag > 0) {
+      const gradientName = libredwg.dwg_dynapi_entity_value(entity, 'gradient_name')
+        .data as string
+      const gradientRotation = libredwg.dwg_dynapi_entity_value(entity, 'gradient_angle')
+        .data as number
+      const gradientDefinition = libredwg.dwg_dynapi_entity_value(entity, 'gradient_shift')
+        .data as number
+      const colorTint = libredwg.dwg_dynapi_entity_value(entity, 'gradient_tint')
+        .data as number
+      const gradientColorFlag = libredwg.dwg_dynapi_entity_value(entity, 'single_color_gradient')
+        .data as number
+      // const numberOfColors = libredwg.dwg_dynapi_entity_value(entity, 'num_colors')
+      //   .data as number
+      const gradientColors_ptr = libredwg.dwg_dynapi_entity_value(entity, 'colors')
+        .data as number
+      const gradientColors = libredwg.dwg_ptr_to_hatch_gradient_color_array(gradientColors_ptr, (gradientColorFlag == 1) ? 1 : 2)
+
+      return {
+        type: 'HATCH',
+        ...result,
+        gradientFlag: DwgHatchGradientFlag.Gradient,
+        gradientColorFlag: gradientColorFlag == 1 ? DwgHatchGradientColorFlag.OneColor : DwgHatchGradientColorFlag.TwoColor,
+        gradientName,
+        gradientRotation,
+        gradientDefinition,
+        colorTint,
+        gradientColors
+      }
+    } else {
+      return {
+        type: 'HATCH',
+        ...result
+      }
+    }
   }
 
   private convertHatchBoundaryPaths(paths: Dwg_HATCH_Path[]) {

bindings/javascript/src/database/entities/hatch.ts

@@ -157,13 +157,21 @@ export interface DwgHatchEntityBase extends DwgEntity {
   gradientFlag?: DwgHatchGradientFlag
 }
 
+export interface DwgGradientColor {
+  reservedData: number
+  rgb: number
+  colorIndex?: number
+}
+
 export interface DwgGradientHatchEntity extends DwgHatchEntityBase {
+  gradientName: string
   gradientFlag: DwgHatchGradientFlag.Gradient
   gradientColorFlag: DwgHatchGradientColorFlag
   numberOfColors: 0 | 2
   gradientRotation?: number
   gradientDefinition: number
   colorTint?: number
+  gradientColors?: Array<DwgGradientColor>
 }
 
 export type DwgHatchEntity = DwgGradientHatchEntity | DwgHatchEntityBase

bindings/javascript/src/libredwg.ts

@@ -5,6 +5,7 @@ import {
   DwgCodePage,
   dwgCodePageToEncoding,
   DwgDatabase,
+  DwgGradientColor,
   DwgPoint2D,
   DwgPoint3D,
   DwgPoint4D,
@@ -89,25 +90,25 @@ export class LibreDwg {
     })
   }
 
-  dwg_read_data(fileContent: string | ArrayBuffer, fileType: number) {
-    if (fileType == Dwg_File_Type.DWG) {
-      const fileName = 'tmp.dwg'
-      try {
-        this.wasmInstance.FS.writeFile(
-          fileName,
-          new Uint8Array(fileContent as ArrayBuffer)
-        )
-        const result = this.wasmInstance.dwg_read_file(fileName)
-        if (result.error != 0) {
-          console.log('Open dwg file with error code: ', result.error)
-        }
-        return result.data as Dwg_Data_Ptr
-      } finally {
-        if (this.wasmInstance.FS.analyzePath(fileName, false).exists) {
-          this.wasmInstance.FS.unlink(fileName)
-        }
-      }
-    }
+  dwg_read_data(fileContent: string | ArrayBuffer, fileType: number) {
+    if (fileType == Dwg_File_Type.DWG) {
+      const fileName = 'tmp.dwg'
+      try {
+        this.wasmInstance.FS.writeFile(
+          fileName,
+          new Uint8Array(fileContent as ArrayBuffer)
+        )
+        const result = this.wasmInstance.dwg_read_file(fileName)
+        if (result.error != 0) {
+          console.log('Open dwg file with error code: ', result.error)
+        }
+        return result.data as Dwg_Data_Ptr
+      } finally {
+        if (this.wasmInstance.FS.analyzePath(fileName, false).exists) {
+          this.wasmInstance.FS.unlink(fileName)
+        }
+      }
+    }
     // else if (fileType == Dwg_File_Type.DXF) {
     //   const fileName = "tmp.dxf";
     //   this.wasmInstance.FS.writeFile(fileName, new Uint8Array(fileContent as ArrayBuffer));
@@ -144,12 +145,12 @@ export class LibreDwg {
       }
       return this.wasmInstance.FS.readFile(outputFileName) as Uint8Array
     } finally {
-      if (this.wasmInstance.FS.analyzePath(inputFileName, false).exists) {
-        this.wasmInstance.FS.unlink(inputFileName)
-      }
-      if (this.wasmInstance.FS.analyzePath(outputFileName, false).exists) {
-        this.wasmInstance.FS.unlink(outputFileName)
-      }
+      if (this.wasmInstance.FS.analyzePath(inputFileName, false).exists) {
+        this.wasmInstance.FS.unlink(inputFileName)
+      }
+      if (this.wasmInstance.FS.analyzePath(outputFileName, false).exists) {
+        this.wasmInstance.FS.unlink(outputFileName)
+      }
     }
   }
 
@@ -896,6 +897,21 @@ export class LibreDwg {
     return this.wasmInstance.dwg_ptr_to_hatch_path_array(ptr, size)
   }
 
+  /**
+   * Converts one C++ hatch gradient color array to one JavaScript hatch gradient color array.
+   * @group Array Methods
+   * @group Dwg_Entity_HATCH Methods
+   * @param ptr Pointer to C++ hatch gradient color array.
+   * @param size The size of C++ hatch gradient color array.
+   * @returns Returns one JavaScript hatch gradient color array from the specified C++ hatch gradient color array.
+   */
+  dwg_ptr_to_hatch_gradient_color_array(
+    ptr: Dwg_Array_Ptr,
+    size: number
+  ): DwgGradientColor[] {
+    return this.wasmInstance.dwg_ptr_to_hatch_gradient_color_array(ptr, size)
+  }
+
   /**
    * Converts one C++ mline vertex array to one JavaScript mline vertex array.
    * @group Array Methods

bindings/javascript/wasm/libredwg-web.d.ts

@@ -495,6 +495,7 @@ interface EmbindModule {
   dwg_ptr_to_table_cell_array(_0: number, _1: number): any;
   dwg_ptr_to_hatch_defline_array(_0: number, _1: number): any;
   dwg_ptr_to_hatch_path_array(_0: number, _1: number): any;
+  dwg_ptr_to_hatch_gradient_color_array(_0: number, _1: number): any;
   dwg_ptr_to_mline_vertex_array(_0: number, _1: number): any;
   dwg_object_get_name(_0: number): any;
   dwg_object_get_handle_object(_0: number): any;