@shapediver/viewer.features.drawing-tools 3.3.3 → 3.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapediver/viewer.features.drawing-tools",
-  "version": "3.3.3",
+  "version": "3.3.6",
   "description": "",
   "keywords": [],
   "author": "Michael Oppitz <michael@shapediver.com>",
@@ -10,11 +10,10 @@
     "test": "__tests__"
   },
   "files": [
-    "dist",
-    "src",
     "package.json",
+    "dist/",
     "README.md",
-    "tsconfig.json"
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
@@ -28,7 +27,7 @@
     "build": "bash ../../scripts/building/build.sh",
     "build-watch": "bash ../../scripts/building/build-watch.sh",
     "build-dep": "bash ../../scripts/building/build-dep.sh",
-    "build-current": "npm run build",
+    "build-all": "npm run build",
     "doc": "typedoc"
   },
   "bugs": {
@@ -41,15 +40,15 @@
     "testEnvironment": "node"
   },
   "devDependencies": {
-    "@shapediver/viewer": "3.3.3",
-    "@shapediver/viewer.features.interaction": "3.3.3",
-    "@shapediver/viewer.rendering-engine.rendering-engine-threejs": "3.3.3",
-    "@shapediver/viewer.shared.math": "3.3.3",
-    "@shapediver/viewer.shared.node-tree": "3.3.3",
-    "@shapediver/viewer.shared.services": "3.3.3",
-    "@shapediver/viewer.shared.types": "3.3.3",
+    "@shapediver/viewer": "3.3.6",
+    "@shapediver/viewer.features.interaction": "3.3.6",
+    "@shapediver/viewer.rendering-engine.rendering-engine-threejs": "3.3.6",
+    "@shapediver/viewer.shared.math": "3.3.6",
+    "@shapediver/viewer.shared.node-tree": "3.3.6",
+    "@shapediver/viewer.shared.services": "3.3.6",
+    "@shapediver/viewer.shared.types": "3.3.6",
     "@types/three": "0.162.0",
     "three": "0.162.0"
   },
-  "gitHead": "6218af442a50a13c09c5f61f556792e0b0171437"
+  "gitHead": "13aea937b128a001e6e93be300674c4a04624c29"
 }

package/src/api/implementation/DrawingToolsApi.ts

@@ -1,130 +0,0 @@
-import {
-    Callbacks,
-    DefaultTextures,
-    IDrawingToolsManager,
-    PointsData,
-    SettingsOptional
-} from '../../business/interfaces/IDrawingToolsManager';
-import { DrawingToolsManager } from '../../business/implementation/DrawingToolsManager';
-import { GeometryRestriction } from '../../business/implementation/managers/interaction/restrictions/geometry/GeometryRestriction';
-import { GeometryRestrictionApi } from './restrictions/geometry/GeometryRestrictionApi';
-import { IDrawingToolsApi } from '../interfaces/IDrawingToolsApi';
-import { IRestrictionApi } from '../interfaces/IRestrictionApi';
-import { IViewportApi } from '@shapediver/viewer';
-import { PlaneRestriction } from '../../business/implementation/managers/interaction/restrictions/plane/PlaneRestriction';
-import { PlaneRestrictionApi } from './restrictions/plane/PlaneRestrictionApi';
-import { RestrictionProperties } from '../../business/interfaces/IRestriction';
-import { vec3 } from 'gl-matrix';
-
-export class DrawingToolsApi implements IDrawingToolsApi {
-    // #region Properties (2)
-
-    readonly #drawingToolsManager: IDrawingToolsManager;
-    readonly #restrictions: { [key: string]: IRestrictionApi; } = {};
-
-    // #endregion Properties (2)
-
-    // #region Constructors (1)
-
-    constructor(viewport: IViewportApi, callbacks: Callbacks, settings: SettingsOptional, defaultTextures?: DefaultTextures) {
-        this.#drawingToolsManager = new DrawingToolsManager(viewport, callbacks, settings, defaultTextures);
-
-        for (const token in this.#drawingToolsManager.restrictions) {
-            if (this.#drawingToolsManager.restrictions[token] instanceof PlaneRestriction)
-                this.#restrictions[token] = new PlaneRestrictionApi(this.#drawingToolsManager.restrictions[token] as PlaneRestriction);
-            if (this.#drawingToolsManager.restrictions[token] instanceof GeometryRestriction)
-                this.#restrictions[token] = new GeometryRestrictionApi(this.#drawingToolsManager.restrictions[token] as GeometryRestriction);
-        }
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (7)
-
-    public get closed(): boolean {
-        return this.#drawingToolsManager.closed;
-    }
-
-    public get pointsData(): PointsData {
-        return this.#drawingToolsManager.getPointsData();
-    }
-
-    public get restrictions(): { [key: string]: IRestrictionApi; } {
-        return this.#restrictions;
-    }
-
-    public get showDistanceLabels(): boolean {
-        return this.#drawingToolsManager.showDistanceLabels;
-    }
-
-    public set showDistanceLabels(value: boolean) {
-        this.#drawingToolsManager.showDistanceLabels = value;
-    }
-
-    public get showPointLabels(): boolean {
-        return this.#drawingToolsManager.showPointLabels;
-    }
-
-    public set showPointLabels(value: boolean) {
-        this.#drawingToolsManager.showPointLabels = value;
-    }
-
-    // #endregion Public Getters And Setters (7)
-
-    // #region Public Methods (11)
-
-    public addPoint(index: number, position?: vec3 | undefined): void {
-        this.#drawingToolsManager.addPoint(index, position);
-    }
-
-    public addRestriction(properties: RestrictionProperties, incomingToken?: string): IRestrictionApi | undefined {
-        const token = this.#drawingToolsManager.addRestriction(properties, incomingToken);
-        if (!token) return;
-
-        if (this.#drawingToolsManager.restrictions[token] instanceof PlaneRestriction)
-            this.#restrictions[token] = new PlaneRestrictionApi(this.#drawingToolsManager.restrictions[token] as PlaneRestriction);
-        if (this.#drawingToolsManager.restrictions[token] instanceof GeometryRestriction)
-            this.#restrictions[token] = new GeometryRestrictionApi(this.#drawingToolsManager.restrictions[token] as GeometryRestriction);
-
-        return this.#restrictions[token];
-    }
-
-    public canRedo(): boolean {
-        return this.#drawingToolsManager.canRedo();
-    }
-
-    public canUndo(): boolean {
-        return this.#drawingToolsManager.canUndo();
-    }
-
-    public cancel(): void {
-        this.#drawingToolsManager.cancel();
-    }
-
-    public close(): void {
-        this.#drawingToolsManager.close();
-    }
-
-    public redo(): void {
-        this.#drawingToolsManager.redo();
-    }
-
-    public removePoint(index: number): void {
-        this.#drawingToolsManager.removePoint(index);
-    }
-
-    public removeRestriction(token: string): void {
-        this.#drawingToolsManager.removeRestriction(token);
-        delete this.#restrictions[token];
-    }
-
-    public undo(): void {
-        this.#drawingToolsManager.undo();
-    }
-
-    public update(): PointsData | undefined {
-        return this.#drawingToolsManager.update();
-    }
-
-    // #endregion Public Methods (11)
-}

package/src/api/implementation/restrictions/AbstractRestrictionApi.ts

@@ -1,34 +0,0 @@
-import { IRestrictionApi } from '../../interfaces/IRestrictionApi';
-import { IRestrictionBase } from '../../../business/interfaces/IRestrictionBase';
-
-export abstract class AbstractRestrictionApi implements IRestrictionApi {
-    // #region Properties (1)
-
-    readonly #restriction: IRestrictionBase;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: IRestrictionBase) {
-        this.#restriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (5)
-
-    public get enabled(): boolean {
-        return this.#restriction.enabled;
-    }
-
-    public set enabled(value: boolean) {
-        this.#restriction.enabled = value;
-    }
-
-    public get id(): string {
-        return this.#restriction.id;
-    }
-
-    // #endregion Public Getters And Setters (5)
-}

package/src/api/implementation/restrictions/AbstractSnapRestrictionApi.ts

@@ -1,36 +0,0 @@
-import { ISnapRestriction } from '../../../business/interfaces/ISnapRestriction';
-import { ISnapRestrictionApi } from '../../interfaces/ISnapRestrictionApi';
-import { AbstractRestrictionApi } from './AbstractRestrictionApi';
-
-export abstract class AbstractSnapRestrictionApi extends AbstractRestrictionApi implements ISnapRestrictionApi {
-    // #region Properties (1)
-
-    readonly #restriction: ISnapRestriction;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: ISnapRestriction) {
-        super(restriction);
-        this.#restriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (3)
-
-    public get enabledEditable(): boolean {
-        return this.#restriction.enabledEditable;
-    }
-
-    public get priority(): number {
-        return this.#restriction.priority;
-    }
-
-    public set priority(value: number) {
-        this.#restriction.priority = value;
-    }
-
-    // #endregion Public Getters And Setters (3)
-}

package/src/api/implementation/restrictions/geometry/GeometryRestrictionApi.ts

@@ -1,56 +0,0 @@
-import { AbstractRestrictionApi } from '../AbstractRestrictionApi';
-import { GeometryRestriction } from '../../../../business/implementation/managers/interaction/restrictions/geometry/GeometryRestriction';
-import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
-
-export class GeometryRestrictionApi extends AbstractRestrictionApi {
-    // #region Properties (1)
-
-    readonly #geometryRestriction: GeometryRestriction;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: GeometryRestriction) {
-        super(restriction);
-        this.#geometryRestriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (6)
-
-    public get snapToEdges(): boolean {
-        return this.#geometryRestriction.snapToEdges;
-    }
-
-    public set snapToEdges(value: boolean) {
-        this.#geometryRestriction.snapToEdges = value;
-    }
-
-    public get snapToFaces(): boolean {
-        return this.#geometryRestriction.snapToFaces;
-    }
-
-    public set snapToFaces(value: boolean) {
-        this.#geometryRestriction.snapToFaces = value;
-    }
-
-    public get snapToVertices(): boolean {
-        return this.#geometryRestriction.snapToVertices;
-    }
-
-    public set snapToVertices(value: boolean) {
-        this.#geometryRestriction.snapToVertices = value;
-    }
-
-    // #endregion Public Getters And Setters (6)
-
-    // #region Public Methods (1)
-
-    public updateNodes(nodes: ITreeNode[]): void {
-        this.#geometryRestriction.updateNodes(nodes);
-    }
-
-    // #endregion Public Methods (1)
-}

package/src/api/implementation/restrictions/plane/PlaneRestrictionApi.ts

@@ -1,70 +0,0 @@
-import { AbstractRestrictionApi } from '../AbstractRestrictionApi';
-import { AngularRestrictionApi } from './snap/AngularRestrictionApi';
-import { AxisRestrictionApi } from './snap/AxisRestrictionApi';
-import { GridRestrictionApi } from './snap/GridRestrictionApi';
-import { PlaneRestriction } from '../../../../business/implementation/managers/interaction/restrictions/plane/PlaneRestriction';
-import { vec3 } from 'gl-matrix';
-
-export class PlaneRestrictionApi extends AbstractRestrictionApi {
-    // #region Properties (4)
-
-    readonly #angularRestrictionApi: AngularRestrictionApi;
-    readonly #axisRestrictionApi: AxisRestrictionApi;
-    readonly #gridRestrictionApi: GridRestrictionApi;
-    readonly #planeRestriction: PlaneRestriction;
-
-    // #endregion Properties (4)
-
-    // #region Constructors (1)
-
-    constructor(restriction: PlaneRestriction) {
-        super(restriction);
-        this.#planeRestriction = restriction;
-
-        this.#gridRestrictionApi = new GridRestrictionApi(restriction.gridRestriction);
-        this.#angularRestrictionApi = new AngularRestrictionApi(restriction.angularRestriction);
-        this.#axisRestrictionApi = new AxisRestrictionApi(restriction.axisRestriction);
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (9)
-
-    public get angularRestrictionApi(): AngularRestrictionApi {
-        return this.#angularRestrictionApi;
-    }
-
-    public get axisRestrictionApi(): AxisRestrictionApi {
-        return this.#axisRestrictionApi;
-    }
-
-    public get gridRestrictionApi(): GridRestrictionApi {
-        return this.#gridRestrictionApi;
-    }
-
-    public get origin(): vec3 {
-        return this.#planeRestriction.origin;
-    }
-
-    public set origin(value: vec3) {
-        this.#planeRestriction.origin = value;
-    }
-
-    public get vectorU(): vec3 {
-        return this.#planeRestriction.vectorU;
-    }
-
-    public set vectorU(value: vec3) {
-        this.#planeRestriction.vectorU = value;
-    }
-
-    public get vectorV(): vec3 {
-        return this.#planeRestriction.vectorV;
-    }
-
-    public set vectorV(value: vec3) {
-        this.#planeRestriction.vectorV = value;
-    }
-
-    // #endregion Public Getters And Setters (9)
-}

package/src/api/implementation/restrictions/plane/snap/AngularRestrictionApi.ts

@@ -1,35 +0,0 @@
-import { AbstractSnapRestrictionApi } from '../../AbstractSnapRestrictionApi';
-import { AngularRestriction } from '../../../../../business/implementation/managers/interaction/restrictions/plane/snap/AngularRestriction';
-
-export class AngularRestrictionApi extends AbstractSnapRestrictionApi {
-    // #region Properties (1)
-
-    readonly #angularRestriction: AngularRestriction;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: AngularRestriction) {
-        super(restriction);
-        this.#angularRestriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (2)
-
-    public get angleStep(): number {
-        return this.#angularRestriction.angleStep;
-    }
-
-    public set angleStep(value: number) {
-        this.#angularRestriction.angleStep = value;
-    }
-
-    public get angleStepEditable(): boolean {
-        return this.#angularRestriction.angleStepEditable;
-    }
-
-    // #endregion Public Getters And Setters (2)
-}

package/src/api/implementation/restrictions/plane/snap/AxisRestrictionApi.ts

@@ -1,19 +0,0 @@
-import { AbstractSnapRestrictionApi } from '../../AbstractSnapRestrictionApi';
-import { AxisRestriction } from '../../../../../business/implementation/managers/interaction/restrictions/plane/snap/AxisRestriction';
-
-export class AxisRestrictionApi extends AbstractSnapRestrictionApi {
-    // #region Properties (1)
-
-    readonly #axisRestriction: AxisRestriction;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: AxisRestriction) {
-        super(restriction);
-        this.#axisRestriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-}

package/src/api/implementation/restrictions/plane/snap/GridRestrictionApi.ts

@@ -1,35 +0,0 @@
-import { AbstractSnapRestrictionApi } from '../../AbstractSnapRestrictionApi';
-import { GridRestriction } from '../../../../../business/implementation/managers/interaction/restrictions/plane/snap/GridRestriction';
-
-export class GridRestrictionApi extends AbstractSnapRestrictionApi {
-    // #region Properties (1)
-
-    readonly #gridRestriction: GridRestriction;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(restriction: GridRestriction) {
-        super(restriction);
-        this.#gridRestriction = restriction;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (2)
-
-    public get gridUnit(): number {
-        return this.#gridRestriction.gridUnit;
-    }
-
-    public set gridUnit(value: number) {
-        this.#gridRestriction.gridUnit = value;
-    }
-
-    public get gridUnitEditable(): boolean {
-        return this.#gridRestriction.gridUnitEditable;
-    }
-
-    // #endregion Public Getters And Setters (2)
-}

package/src/api/interfaces/IDrawingToolsApi.ts

@@ -1,98 +0,0 @@
-import { GeometryRestrictionProperties } from '../../business/implementation/managers/interaction/restrictions/geometry/GeometryRestriction';
-import { IRestrictionApi } from './IRestrictionApi';
-import { PlaneRestrictionProperties } from '../../business/implementation/managers/interaction/restrictions/plane/PlaneRestriction';
-import { PointsData } from '../../business/interfaces/IDrawingToolsManager';
-import { RestrictionProperties } from '../../business/interfaces/IRestriction';
-import { vec3 } from 'gl-matrix';
-
-export interface IDrawingToolsApi {
-    // #region Properties (5)
-
-    /**
-     * Check if the drawing tool is closed.
-     */
-    readonly closed: boolean;
-    /**
-     * The points data of the drawing tool.
-     */
-    readonly pointsData: PointsData;
-    /**
-     * The restrictions of the drawing tool.
-     */
-    readonly restrictions: {
-        [key: string]: IRestrictionApi
-    };
-
-    /**
-     * Show the distance labels of the drawing tool.
-     */
-    showDistanceLabels: boolean;
-    /**
-     * Show the point labels of the drawing tool.
-     */
-    showPointLabels: boolean;
-
-    // #endregion Properties (5)
-
-    // #region Public Methods (11)
-
-    /**
-     * Add a point to the drawing tool.
-     * 
-     * @param index The index of the point in the position array.
-     * @param position The position of the point.
-     */
-    addPoint(index: number, position?: vec3 | undefined): void;
-    /**
-     * Add a ray tracing intersection restriction to the drawing tool.
-     * 
-     * @param properties The properties of the restriction.
-     * @param token The token of the restriction.
-     * @returns The api of the restriction.
-     */
-    addRestriction(properties: RestrictionProperties | PlaneRestrictionProperties | GeometryRestrictionProperties, token?: string): IRestrictionApi | undefined;
-    /**
-     * Check if the drawing tool can redo the last action.
-     */
-    canRedo(): boolean;
-    /**
-     * Check if the drawing tool can undo the last action.
-     */
-    canUndo(): boolean;
-    /**
-     * Cancel the drawing tool.
-     */
-    cancel(): void;
-    /**
-     * Close the drawing tool.
-     */
-    close(): void;
-    /**
-     * Redo the last action of the drawing tool.
-     */
-    redo(): void;
-    /**
-     * Remove a point from the drawing tool.
-     * 
-     * @param index The index of the point in the position array.
-     */
-    removePoint(index: number): void;
-    /**
-     * Remove a restriction from the drawing tool.
-     * 
-     * @param id 
-     */
-    removeRestriction(id: string): void;
-    /**
-     * Undo the last action of the drawing tool.
-     */
-    undo(): void;
-    /**
-     * Receive an update of the drawing tool.
-     * 
-     * @returns The points data of the drawing tool.
-     */
-    update(): PointsData | undefined;
-
-    // #endregion Public Methods (11)
-}

package/src/api/interfaces/IRestrictionApi.ts

@@ -1,15 +0,0 @@
-export interface IRestrictionApi {
-    // #region Properties (2)
-
-    /**
-     * The unique identifier of the restriction.
-     */
-    readonly id: string;
-
-    /**
-     * Whether the restriction is enabled or not.
-     */
-    enabled: boolean;
-
-    // #endregion Properties (2)
-}

package/src/api/interfaces/ISnapRestrictionApi.ts

@@ -1,18 +0,0 @@
-import { IRestrictionApi } from './IRestrictionApi';
-
-export interface ISnapRestrictionApi extends IRestrictionApi {
-    // #region Properties (2)
-
-    /**
-     * If the enabling or disabling of the restriction is allowed to the end user.
-     * If it is not editable, the default value for enabling or disabling the restriction is used.
-     */
-    readonly enabledEditable: boolean;
-
-    /**
-     * The priority of the restriction.
-     */
-    priority: number;
-
-    // #endregion Properties (2)
-}