@buerli.io/headless 0.4.0-beta.2 → 0.4.0-beta.3

package/build/history.d.ts

@@ -1,4 +1,4 @@
-import { BooleanOperationType, ChamferType, FlipType, ReorientedType, WorkAxisType, WorkCoordSystemType, WorkPlaneType, WorkPointType, ViewType, OrientationType, ExtrusionType, BrepElemType } from '@buerli.io/classcad';
+import { BooleanOperationType, ChamferType, FlipType, ReorientedType, WorkAxisType, WorkCoordSystemType, WorkPlaneType, WorkPointType, ViewType, OrientationType, ExtrusionType, BrepElemType, SVGModusType } from '@buerli.io/classcad';
 import { ObjectID, PointMemValue } from '@buerli.io/core';
 import { BufferGeometry, Scene } from 'three';
 /**
@@ -154,16 +154,20 @@ export declare type ApiHistory = {
     /**
      * Creates different 2D views, depending on the given view types, in the given product.
      * @param productId id of the product where the view will be created in
-     * @param viewTypes array of view types. E.g. 'Top', 'Front', 'Iso', ...
+     * @param viewTypes array of view types. E.g. [ViewType.TOP, ViewType.RIGHT_90, ViewType.ISO, ...
+     * @param viewOptions optional object of options (currently color and layer) to set for the views.
+     *  - color: number value 0 - 256, see AutoCAD Color Index (ACI). 256 = color defined by layer
+     *  - layer: string value, defines the view's layer
+     *  - Default = { color: 256, layer: '0'}
      * @example
      * // Optionally add dimensions to the product, see addDimension() or addDimensions()
      * await api.addDimensions(...)
      *
      * // Create the wanted views
-     * await api.create2DViews(productId, ['Top', 'Right_90°', 'Iso'])
+     * await api.create2DViews(productId, [ViewType.TOP, ViewType.RIGHT_90, ViewType.ISO], { color: 2, layer: '6'})
      * @image // tbd
      */
-    create2DViews: (productId: VID, viewTypes: ViewType[]) => IDs;
+    create2DViews: (productId: VID, viewTypes: ViewType[], viewOptions?: ViewOptionsType) => IDs;
     /**
      * This method returns the boundary box of the given views.
      * @param productId id of the product from where the boundary box will returned
@@ -196,23 +200,35 @@ export declare type ApiHistory = {
     /**
      * Export the placed views as dxf file.
      * @param productId id of the product where the views exist for export
+     * @param dxfTemplateFilename optional filename to load different dxf template. E.g. 'StandardTemplate.dxf'
      * @example
      * // After creating and placing the views, see place2DViews(), you can export them
      * // You will get the dxf stream back
      * await api.exportDXF(productId)
      * @image // tbd
      */
-    exportDXF: (productId: VID) => Promise<Uint8Array | null>;
+    exportDXF: (productId: VID, dxfTemplateFilename?: string) => Promise<Uint8Array | null>;
     /**
-     * Export the placed views as svg file.
+     * Exports the placed views as dxf and converts it into svg stream.
      * @param productId id of the product where the views exist for export
+     * @param modus optional modus to define how drawing will fit into svg file,
+     *  - SVGModusType.WHOLE_DRAWING or SVGModusType.FIT_WHOLE_DRAWING
+     *  - Default = SVGModusType.FIT_WHOLE_DRAWING
+     * @param renderSize optional rendered size [x, y] of the drawing.
+     *  - x = horizontal size, y = vertical size
+     *  - Default = 1024 x 768
+     *  - Effects only if modus = SVGModusType.WHOLE_DRAWING
+     * @param dxfTemplateFilename optional filename to load different dxf template. E.g. 'StandardTemplate.dxf'
      * @example
      * // After creating and placing the views, see place2DViews(), you can export them
      * // You will get the svg stream back
      * await api.exportSVG(productId)
      * @image // tbd
      */
-    exportSVG: (productId: VID) => Promise<Uint8Array | null>;
+    exportSVG: (productId: VID, modus?: SVGModusType, renderSize?: {
+        x: number;
+        y: number;
+    }, dxfTemplateFilename?: string) => Promise<Uint8Array | null>;
     /**
      * Remove existing dimensions from the view.
      * @param dimensionsIds ids of the dimensions to be removed
@@ -1166,6 +1182,10 @@ export declare type DimensionType = {
     };
     dxfView: ViewType;
 };
+export declare type ViewOptionsType = {
+    color?: number;
+    layer?: string;
+};
 /**
  * Information about constraint.
  * [

package/build/history.js

@@ -6,7 +6,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 /* eslint-disable max-lines */
-import { ccAPI, CCClasses, ccUtils, DataType, } from '@buerli.io/classcad';
+import { ccAPI, CCClasses, ccUtils, DataType, SVGModusType, } from '@buerli.io/classcad';
 import { api, getDrawing, lineSegmentsFilter, loopFilter, MathUtils, planeFilter, pointFilter, } from '@buerli.io/core';
 import { Group, Mesh, MeshStandardMaterial, Scene, Vector3 } from 'three';
 import * as BufferGeometryUtils_ from 'three/examples/jsm/utils/BufferGeometryUtils';
@@ -310,7 +310,7 @@ export default class CAD {
                                     dim.dimParam.dimTextAngle,
                                     dim.dimParam.dimOrientation,
                                     dim.dimParam.dimColor || 256,
-                                    dim.dimParam.dimLayer || '2',
+                                    dim.dimParam.dimLayer || '1',
                                 ],
                                 dim.dxfView,
                             ];
@@ -337,7 +337,7 @@ export default class CAD {
                                         dim.dimParam.dimTextAngle,
                                         dim.dimParam.dimOrientation,
                                         dim.dimParam.dimColor || 256,
-                                        dim.dimParam.dimLayer || '2',
+                                        dim.dimParam.dimLayer || '1',
                                     ],
                                     dim.dxfView,
                                 ]);
@@ -346,9 +346,11 @@ export default class CAD {
                         return ccAPI.drawing2D.addDimensions(drawingId, dimsToAdd);
                     }, ...dimensions);
                 },
-                create2DViews: (productId, viewTypes) => {
+                create2DViews: (productId, viewTypes, viewOptions) => {
                     return this.resolve(async ([rProductId]) => {
-                        const viewIds = await ccAPI.drawing2D.create2DViews(drawingId, rProductId, viewTypes);
+                        const color = (viewOptions === null || viewOptions === void 0 ? void 0 : viewOptions.color) ? viewOptions.color : 256;
+                        const layer = (viewOptions === null || viewOptions === void 0 ? void 0 : viewOptions.layer) ? viewOptions.layer : '0';
+                        const viewIds = await ccAPI.drawing2D.create2DViews(drawingId, rProductId, viewTypes, [color, layer]);
                         if (viewIds !== null) {
                             await ccAPI.drawing2D.centerAllViews(drawingId, rProductId, viewTypes);
                             return viewIds;
@@ -373,14 +375,16 @@ export default class CAD {
                         return ccAPI.drawing2D.place2DViews(drawingId, rProductId, viewPositionParams);
                     }, productId);
                 },
-                exportDXF: (productId) => {
+                exportDXF: (productId, dxfTemplateFilename) => {
                     return this.resolve(async ([rProductId]) => {
-                        return ccAPI.drawing2D.exportDXF(drawingId, rProductId);
+                        return ccAPI.drawing2D.exportDXF(drawingId, rProductId, dxfTemplateFilename);
                     }, productId);
                 },
-                exportSVG: (productId) => {
+                exportSVG: (productId, modus, renderSize, dxfTemplateFilename) => {
                     return this.resolve(async ([rProductId]) => {
-                        return ccAPI.drawing2D.exportSVG(drawingId, rProductId);
+                        modus = modus ? modus : SVGModusType.FIT_WHOLE_DRAWING;
+                        const renderSizeParam = (renderSize === null || renderSize === void 0 ? void 0 : renderSize.x) && (renderSize === null || renderSize === void 0 ? void 0 : renderSize.y) ? [renderSize.x, renderSize.y] : undefined;
+                        return ccAPI.drawing2D.exportSVG(drawingId, rProductId, modus, renderSizeParam, dxfTemplateFilename);
                     }, productId);
                 },
                 removeDimensions: (dimensionIds) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buerli.io/headless",
-  "version": "0.4.0-beta.2",
+  "version": "0.4.0-beta.3",
   "description": "A non-manifold CAD workflow for the web",
   "author": "AWV Informatik AG <info@awv-informatik.ch>",
   "license": "ISC",
@@ -30,7 +30,7 @@
     "three": ">=0.138"
   },
   "dependencies": {
-    "@buerli.io/classcad": "0.4.0-beta.2",
+    "@buerli.io/classcad": "0.4.0-beta.3",
     "flat-promise": "^1.0.3"
   }
 }