@design-core/core 0.0.1 → 0.0.3

package/.eslintrc.json

@@ -4,16 +4,23 @@
         "es2021": true
     },
     "extends": "google",
-    "overrides": [
-    ],
+    "overrides": [],
     "parserOptions": {
         "ecmaVersion": "latest",
         "sourceType": "module"
     },
     "rules": {
-        "require-jsdoc" : 0,
-        "valid-jsdoc" : 0,
-        "max-len" : 0
+        "require-jsdoc": 2,
+        "valid-jsdoc": 2,
+        "max-len": 0,
+        "function-paren-newline": "warn",
+        "object-curly-spacing": [
+            "error",
+            "always"
+        ],
+        "space-in-parens": [
+            "error",
+            "never"
+        ]
     }
-    //"eslintIgnore": ["canvas.js"]
-}
+}

package/.github/workflows/DesignCoreQA.yml

@@ -38,4 +38,6 @@ jobs:
       run: npx eslint . --ext .js
 
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

package/README.md

@@ -1,11 +1,12 @@
-# Design-Core [![Design-Core QA](https://github.com/dubstar-04/Design-Core/actions/workflows/DesignCoreQA.yml/badge.svg)](https://github.com/dubstar-04/Design-Core/actions/workflows/DesignCoreQA.yml)    [![codecov](https://codecov.io/gh/dubstar-04/Design-Core/branch/main/graph/badge.svg?token=SH2E690AT0)](https://codecov.io/gh/dubstar-04/Design-Core)
+# Design-Core [![Design-Core QA](https://github.com/dubstar-04/Design-Core/actions/workflows/DesignCoreQA.yml/badge.svg)](https://github.com/dubstar-04/Design-Core/actions/workflows/DesignCoreQA.yml)    [![codecov](https://codecov.io/gh/dubstar-04/Design-Core/branch/main/graph/badge.svg?token=SH2E690AT0)](https://codecov.io/gh/dubstar-04/Design-Core) ![NPM Version](https://img.shields.io/npm/v/%40design-core%2Fcore?logo=npm)
 
 
-Design-Core is a dependancy free opensource javascript library for two dimensional computer aided design (CAD).
 
-Design-Core uses the industry standard Drawing Exchange Format (DXF) to read and write CAD data and impliments drawing visualisation functionality and can be used with HTML canvas elements or Cairo graphics.
+Design-Core is a dependency free open source JavaScript library for two-dimensional computer-aided design (CAD).
 
-| :warning: WARNING: Design Core is currently experimental / Proof of concept and only suitable for testing. |
+Design-Core uses the industry standard Drawing Exchange Format (DXF) to read and write CAD data and implements drawing visualization functionality. It can be used with HTML canvas elements or Cairo graphics.
+
+| :warning: WARNING: Design-Core is currently experimental / proof of concept and only suitable for testing. |
 
 ## Links
 * Docs: https://design-app.readthedocs.io/en/latest/index.html
@@ -14,3 +15,9 @@ Design-Core uses the industry standard Drawing Exchange Format (DXF) to read and
 * HTML Canvas: https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API
 * Cairo: https://www.cairographics.org/
 
+
+## Publishing
+
+npm login
+
+npm publish --access public

package/TODO.md

@@ -0,0 +1,19 @@
+# Design-Core TODO list
+
+## Beta
+### UNDO / REDO
+
+### Printing
+
+### Export PDF
+
+### Paperspace
+
+### Entity Editing
+
+### Dimensions
+- Linear dimension
+- Angular Dimension
+- Radial Dimension
+- Diametric Dimension
+

package/core/core/core.js

@@ -1,49 +1,65 @@
-import {Scene} from '../lib/scene.js';
-import {CommandManager} from '../lib/commandManager.js';
-import {Mouse} from '../lib/mouse.js';
-import {Canvas} from '../lib/canvas.js';
-import {CommandLine} from '../lib/commandLine.js';
-import {LayerManager} from '../styles/layerManager.js';
-import {LTypeManager} from '../styles/ltypeManager.js';
-import {StyleManager} from '../styles/styleManager.js';
-import {DimStyleManager} from '../styles/dimStyleManager.js';
-import {PropertyManager} from '../properties/propertyManager.js';
-
-import {FileIO} from '../lib/fileio.js';
-import {Settings} from '../lib/settings.js';
-import {DXFFile} from '../lib/dxf/dxfFile.js';
-import {Logging} from '../lib/logging.js';
-
-import {DesignCore} from '../designCore.js';
+import { Scene } from '../lib/scene.js';
+import { CommandManager } from '../lib/commandManager.js';
+import { Mouse } from '../lib/mouse.js';
+import { Canvas } from '../lib/canvas.js';
+import { CommandLine } from '../lib/commandLine.js';
+import { LayerManager } from '../tables/layerManager.js';
+import { LTypeManager } from '../tables/ltypeManager.js';
+import { StyleManager } from '../tables/styleManager.js';
+import { DimStyleManager } from '../tables/dimStyleManager.js';
+import { ViewManager } from '../tables/viewManager.js';
+import { VPortManager } from '../tables/vportManager.js';
+import { UCSManager } from '../tables/ucsManager.js';
+import { AppIDManager } from '../tables/appIdManager.js';
+import { BlockRecordManager } from '../tables/blockRecordManager.js';
+import { DictionaryManager } from '../objects/dictionaryManager.js';
+import { PropertyManager } from '../properties/propertyManager.js';
+import { Clipboard } from '../lib/clipboard.js';
+
+import { FileIO } from '../lib/fileio.js';
+import { Settings } from '../lib/settings.js';
+import { DXFFile } from '../lib/dxf/dxfFile.js';
+import { HandleManager } from '../lib/dxf/handleManager.js';
+import { Logging } from '../lib/logging.js';
+
+import { DesignCore } from '../designCore.js';
 
 /** Class representing design core. This is the primary entry point */
 export class Core {
   /** Create a core object */
   constructor() {
+    // Create handle manager and activate to enable handle assignment during construction
+    this.handleManager = new HandleManager();
+    this.activate();
+
+    // Create core components
     this.scene = new Scene();
     this.commandManager = new CommandManager();
     this.canvas = new Canvas();
-
     this.mouse = new Mouse();
     this.commandLine = new CommandLine();
 
-    this.layerManager = new LayerManager();
+    // Create table managers
     this.ltypeManager = new LTypeManager();
+    this.layerManager = new LayerManager();
     this.styleManager = new StyleManager();
     this.dimStyleManager = new DimStyleManager();
+    this.viewManager = new ViewManager();
+    this.vportManager = new VPortManager();
+    this.ucsManager = new UCSManager();
+    this.appIdManager = new AppIDManager();
+    this.blockRecordManager = new BlockRecordManager();
+
+    // Create dictionary manager and property manager
+    this.dictionaryManager = new DictionaryManager();
     this.propertyManager = new PropertyManager();
-
+    // Create clipboard manager
+    this.clipboard = new Clipboard();
+    // Create settings manager
     this.settings = new Settings();
 
     // function to call external notification command for the ui
     this.externalNotifyCallbackFunction;
-
-    // create a static reference to the instantiated core object
-    // DesignCore._instance = this;
-    // Design.Core = this;
-
-    // return Design;
-    this.activate();
   }
 
   /**
@@ -59,30 +75,20 @@ export class Core {
    * Get the current dxf version
    */
   get dxfVersion() {
-    return this.scene.dxfVersion;
+    return this.scene.headers.dxfVersion;
   }
 
   /**
    * Set the current dxf version
+   * @param {string} version
    */
   set dxfVersion(version) {
-    // version should be the RXXXX format for the dxf version
-
-    // Check if we have the ACXXXX value
-    if (DXFFile.validDxfVersion(version)) {
-      // convert the ACXXXX value to the key RXXXX value
-      version = DXFFile.getVersionKey(version);
-    }
-
-    // Check if we have the RXXXX value
-    if (DXFFile.validDxfKey(version)) {
-      this.scene.dxfVersion = version;
-    }
+    this.scene.headers.dxfVersion = version;
   }
 
   /**
    * Set the external notification callback
-   * @param  {object} function
+   * @param  {Object} callback
    */
   setExternalNotifyCallbackFunction(callback) {
     // set the callback
@@ -112,6 +118,7 @@ export class Core {
 
   /**
    * Save the current scene to a dxf string
+   * @param {string} version
    * @return {string} The dxf file as a string.
    */
   saveFile(version) {
@@ -120,7 +127,7 @@ export class Core {
 
   /**
    * Return the supported dxf versions
-   * @returns array js object containing the version
+   * @return {string} array js object containing the version
    */
   supportedDXFVersions() {
     return DXFFile.Version;

package/core/designCore.js

@@ -23,10 +23,12 @@
 
    ***** End Usage *****/
 
-
+/**
+ * Design Core Class
+ */
 export class DesignCore {
   static _core;
-
+  /** Create a Design Core */
   constructor() {
     const msg = 'DesignCore is a static class and cannot be instantiated';
     const err = (`${this.type} - ${msg}`);
@@ -35,6 +37,7 @@ export class DesignCore {
 
   /**
    * Set the Core Instance
+   * @param {Object} core
    */
   static set Core(core) {
     this._core = core;
@@ -58,6 +61,13 @@ export class DesignCore {
     return DesignCore.Core.scene;
   }
 
+  /**
+   * Get the Clipboard
+   */
+  static get Clipboard() {
+    return DesignCore.Core.clipboard;
+  }
+
   /**
    * Get the CommandManager
    */
@@ -114,6 +124,48 @@ export class DesignCore {
     return DesignCore.Core.dimStyleManager;
   }
 
+  /**
+   * Get the ViewManager
+   */
+  static get ViewManager() {
+    return DesignCore.Core.viewManager;
+  }
+
+  /**
+   * Get the VPortManager
+   */
+  static get VPortManager() {
+    return DesignCore.Core.vportManager;
+  }
+
+  /**
+   * Get the UCSManager
+   */
+  static get UCSManager() {
+    return DesignCore.Core.ucsManager;
+  }
+
+  /**
+   * Get the AppIDManager
+   */
+  static get AppIDManager() {
+    return DesignCore.Core.appIdManager;
+  }
+
+  /**
+   * Get the BlockRecordManager
+   */
+  static get BlockRecordManager() {
+    return DesignCore.Core.blockRecordManager;
+  }
+
+  /**
+   * Get the DictionaryManager
+   */
+  static get DictionaryManager() {
+    return DesignCore.Core.dictionaryManager;
+  }
+
   /**
    * Get the property manager
    */
@@ -121,6 +173,13 @@ export class DesignCore {
     return DesignCore.Core.propertyManager;
   }
 
+  /**
+   * Get the Handle
+   */
+  static get HandleManager() {
+    return DesignCore.Core.handleManager;
+  }
+
   /**
    * Get the property manager
    */

package/core/dimensions/alignedDimension.js

@@ -0,0 +1,142 @@
+import { Strings } from '../lib/strings.js';
+import { Line } from '../entities/line.js';
+import { Input, PromptOptions } from '../lib/inputManager.js';
+import { Logging } from '../lib/logging.js';
+import { DXFFile } from '../lib/dxf/dxfFile.js';
+import { Point } from '../entities/point.js';
+import { BaseLinearDimension } from './baseLinearDimension.js';
+
+import { DesignCore } from '../designCore.js';
+
+
+/**
+ * Aligned Dimension Entity Class
+ * @extends LinearDimension
+ */
+export class AlignedDimension extends BaseLinearDimension {
+  /**
+   * Create an Aligned Dimension
+   * @param {Array} data
+   */
+  constructor(data) {
+    super(data);
+    this.dimType.setDimType(1); // Aligned dimension
+  }
+
+  /**
+   * Register the command
+   * @return {Object}
+   * command = name of the command
+   * shortcut = shortcut for the command
+   * type = type to group command in toolbars (omitted if not shown)
+   */
+  static register() {
+    const command = { command: 'AlignedDimension', shortcut: 'DIMALI' };
+    return command;
+  }
+
+  /**
+   * Execute method
+   * executes the workflow, requesting input required to create an entity
+   */
+  async execute() {
+    try {
+      DesignCore.Scene.selectionManager.reset();
+      this.dimensionStyle = DesignCore.DimStyleManager.getCstyle();
+      this.dimType.setDimType(1); // Aligned dimension
+
+      const op = new PromptOptions(Strings.Input.START, [Input.Type.POINT]);
+      const pt13 = await DesignCore.Scene.inputManager.requestInput(op);
+      pt13.sequence = 13;
+      this.points.push(pt13);
+
+      const op1 = new PromptOptions(Strings.Input.END, [Input.Type.POINT]);
+      const pt14 = await DesignCore.Scene.inputManager.requestInput(op1);
+      pt14.sequence = 14;
+      this.points.push(pt14);
+
+      const op2 = new PromptOptions(Strings.Input.DIMENSION, [Input.Type.POINT]);
+      const pt11 = await DesignCore.Scene.inputManager.requestInput(op2);
+      pt11.sequence = 11;
+      this.points.push(pt11);
+
+      const tempLine = new Line({ points: [pt13, pt14] });
+      this.points = AlignedDimension.getPointsFromSelection([tempLine], pt11);
+
+      DesignCore.Scene.inputManager.executeCommand(this);
+    } catch (err) {
+      Logging.instance.error(`${this.type} - ${err}`);
+    }
+  }
+
+  /**
+     * Get sequenced points from user selection
+     * @param {any} items
+     * @param {Point} textPos
+     * @return {Array} array of points
+     */
+  static getPointsFromSelection(items, textPos) {
+    const points = [];
+    const item = items[0];
+
+    const Pt13 = item.points[0];
+    Pt13.sequence = 13;
+    points.push(Pt13);
+
+    const Pt14 = item.points[1];
+    Pt14.sequence = 14;
+    points.push(Pt14);
+
+    const Pt10 = new Point();
+    Pt10.sequence = 10;
+
+    const Pt11 = textPos;
+    Pt11.sequence = 11;
+    points.push(Pt11);
+
+    // Perpendicular to the selected line or line is vertical or horizontal
+    const pntPerp = Pt11.perpendicular(Pt13, Pt14);
+    const projectionAngle = pntPerp.angle(Pt11);
+    const distance = Pt11.distance(pntPerp);
+    const projectedPoint = Pt14.project(projectionAngle, distance);
+
+    Pt10.x = projectedPoint.x;
+    Pt10.y = projectedPoint.y;
+
+    points.push(Pt10);
+    return points;
+  }
+
+  /**
+   * Write the entity to file in the dxf format
+   * @param {DXFFile} file
+   */
+  dxf(file) {
+    const Pt10 = this.getPointBySequence(this.points, 10);
+    const Pt11 = this.getPointBySequence(this.points, 11);
+    const Pt13 = this.getPointBySequence(this.points, 13);
+    const Pt14 = this.getPointBySequence(this.points, 14);
+
+    file.writeGroupCode('0', 'DIMENSION');
+    file.writeGroupCode('5', this.handle, DXFFile.Version.R2000); // Handle
+    file.writeGroupCode('100', 'AcDbEntity', DXFFile.Version.R2000);
+    file.writeGroupCode('100', 'AcDbDimension', DXFFile.Version.R2000);
+    file.writeGroupCode('8', this.layer);
+    // file.writeGroupCode('2', this.blockName);  // Block not required
+    file.writeGroupCode('10', Pt10.x); // X - definition / arrow point
+    file.writeGroupCode('20', Pt10.y); // Y
+    file.writeGroupCode('30', '0.0'); // Z
+    file.writeGroupCode('11', Pt11.x); // X - text midpoint
+    file.writeGroupCode('21', Pt11.y); // Y
+    file.writeGroupCode('31', '0.0'); // Z
+    file.writeGroupCode('70', this.dimType.getDimType()); // DIMENSION TYPE
+    file.writeGroupCode('3', this.dimensionStyle); // DIMENSION STYLE
+    file.writeGroupCode('100', 'AcDbAlignedDimension', DXFFile.Version.R2000);
+    file.writeGroupCode('13', Pt13.x); // X - start point of first extension line
+    file.writeGroupCode('23', Pt13.y); // Y
+    file.writeGroupCode('33', '0.0'); // Z
+    file.writeGroupCode('14', Pt14.x); // X - start point of second extension line
+    file.writeGroupCode('24', Pt14.y); // Y
+    file.writeGroupCode('34', '0.0'); // Z
+  }
+}