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

package/src/business/implementation/managers/interaction/restrictions/plane/snap/GridRestriction.ts

@@ -1,246 +0,0 @@
-import * as THREE from 'three';
-import { AbstractRestriction } from '../../AbstractRestriction';
-import { Box, sceneTree } from '@shapediver/viewer';
-import { DrawingToolsManager } from '../../../../../DrawingToolsManager';
-import { IRay } from '@shapediver/viewer.features.interaction';
-import { ISnapRestriction, SnapRestrictionProperties } from '../../../../../../interfaces/ISnapRestriction';
-import { PlaneRestriction } from '../PlaneRestriction';
-import { RestrictionMetaData } from '../../../../../../interfaces/IRestriction';
-import { vec3 } from 'gl-matrix';
-
-// #region Type aliases (1)
-
-/**
- * Properties for the grid restriction
- */
-export type GridRestrictionProperties = {
-    /**
-     * Size of the grid unit
-     */
-    gridUnit?: number;
-
-    /**
-     * If the grid unit is editable for change to the end user.
-     * If it is not editable, the grid unit cannot be changed from the default value.
-     */
-    gridUnitEditable?: boolean;
-} & SnapRestrictionProperties;
-
-// #endregion Type aliases (1)
-
-// #region Classes (1)
-
-export class GridRestriction extends AbstractRestriction implements ISnapRestriction {
-    // #region Properties (10)
-
-    readonly #activationKey: string;
-    readonly #drawingToolsManager: DrawingToolsManager;
-    readonly #planeRestriction: PlaneRestriction;
-
-    #active: boolean = false;
-    #gridHelper?: THREE.GridHelper;
-    #gridSize: number = 100;
-    #gridUnit: number;
-    #gridUnitEditable: boolean = true;
-    #offsetFromUnit: vec3 = vec3.create();
-    #priority: number = 0;
-
-    // #endregion Properties (10)
-
-    // #region Constructors (1)
-
-    constructor(drawingToolsManager: DrawingToolsManager, planeRestriction: PlaneRestriction, properties?: GridRestrictionProperties) {
-        super(drawingToolsManager, 'grid');
-
-        this.#drawingToolsManager = drawingToolsManager;
-        this.#planeRestriction = planeRestriction;
-
-        this.#activationKey = properties?.activationKey || 'g';
-        this.enabled = properties?.enabled ?? false;
-        this._enabledEditable = properties?.enabledEditable ?? true;
-        this.#gridUnit = properties?.gridUnit || 1;
-        this.#gridUnitEditable = properties?.gridUnitEditable ?? true;
-        this.#priority = properties?.priority || 0;
-
-        // create the offset of the grid size to origin
-        this.createOffsetFromUnit();
-
-        // calculate offset of grid size to origin
-        this.createGridVisualization();
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (8)
-
-    public get active(): boolean {
-        return this.#active;
-    }
-
-    public set active(value: boolean) {
-        this.#active = value;
-
-        if (this.#gridHelper) this.#gridHelper.visible = value;
-    }
-
-    public get enabledEditable(): boolean {
-        return this._enabledEditable;
-    }
-
-    public get gridUnit(): number {
-        return this.#gridUnit;
-    }
-
-    public set gridUnit(value: number) {
-        if (this.#gridUnitEditable === false) return;
-
-        this.#gridUnit = value;
-        this.createOffsetFromUnit();
-        this.createGridVisualization();
-    }
-
-    public get gridUnitEditable(): boolean {
-        return this.#gridUnitEditable;
-    }
-
-    public get priority(): number {
-        return this.#priority;
-    }
-
-    public set priority(value: number) {
-        this.#priority = value;
-    }
-
-    // #endregion Public Getters And Setters (8)
-
-    // #region Public Methods (2)
-
-    // public get
-    public snap(ray: IRay, point: vec3, metaData: RestrictionMetaData): vec3 | undefined {
-        // if the restriction is not enabled OR the activation key is set and the key is not pressed, return
-        if (this.enabled === false && this.#drawingToolsManager.keyPressed(this.#activationKey) === false) return;
-
-        /**
-         * Explanation of the following code:
-         * 1. Calculate the projection of the origin onto the plane that is created by the point and the normal
-         * 2. Move the grid helper to the projected origin
-         */
-
-        // vector from the point to the origin
-        const v = vec3.sub(vec3.create(), this.#planeRestriction.origin, point);
-
-        // dot product of the vector and the normal
-        const dot = vec3.dot(v, this.#planeRestriction.normal);
-
-        // projection of the origin onto the plane that is created by the point and the normal
-        const projectedOrigin = vec3.sub(vec3.create(), this.#planeRestriction.origin, vec3.scale(vec3.create(), this.#planeRestriction.normal, dot));
-
-        // we move the grid helper to the projected origin
-        if (this.#gridHelper) {
-            this.#gridHelper.position.copy(new THREE.Vector3(projectedOrigin[0], projectedOrigin[1], projectedOrigin[2]));
-            this.#gridHelper.visible = false;
-        }
-
-        /**
-         * Explanation of the following code:
-         * 1. Rotate the point so that the normal of the plane is aligned with the Z axis (with previously calculated transformation matrix)
-         * 2. Snap the point to the grid
-         * 3. Rotate the point back to the original coordinate system (with previously calculated transformation matrix)
-         */
-
-        // Apply the transformation to the point
-        const rotatedPoint = vec3.transformMat4(vec3.create(), point, this.#planeRestriction.transformationToXYPlaneMatrix);
-
-        // Snap the offset to the grid
-        const snappedOffset = vec3.create();
-        snappedOffset[0] = Math.round(rotatedPoint[0] / this.#gridUnit) * this.#gridUnit - this.#offsetFromUnit[0];
-        snappedOffset[1] = Math.round(rotatedPoint[1] / this.#gridUnit) * this.#gridUnit - this.#offsetFromUnit[1];
-        snappedOffset[2] = rotatedPoint[2];
-
-        // Move the snapped point back to the original coordinate system
-        const snappedPoint = vec3.transformMat4(vec3.create(), snappedOffset, this.#planeRestriction.transformationFromXYPlaneMatrix);
-
-        return snappedPoint;
-    }
-
-    public updatePlaneDefinition(): void {
-        this.createOffsetFromUnit();
-        this.createGridVisualization();
-    }
-
-    // #endregion Public Methods (2)
-
-    // #region Protected Methods (1)
-
-    protected visibilityChanged(visible: boolean): void {
-        if (visible === false) {
-            if (this.#gridHelper) {
-                this.#gridHelper.visible = false;
-            }
-        }
-    }
-
-    // #endregion Protected Methods (1)
-
-    // #region Private Methods (2)
-
-    private createGridVisualization(): void {
-        if (this.#gridHelper) {
-            this._object3D.remove(this.#gridHelper);
-            this.#gridHelper.dispose();
-        }
-
-        const bb = new Box();
-        for (let i = 0; i < sceneTree.root.children.length; i++) {
-            if ((sceneTree.root.children[i] as unknown as { sessionNode?: boolean }).sessionNode === true) {
-                bb.union(sceneTree.root.children[i].boundingBox);
-            }
-        }
-
-        const radius = bb.boundingSphere.radius;
-        this.#gridSize = radius * 2;
-        if (this.#gridSize === Infinity || this.#gridSize === -Infinity || isNaN(this.#gridSize) || this.#gridSize === 0)
-            this.#gridSize = 100;
-
-        // if the grid size is not divisible by the grid unit, we need to adjust the grid size
-        let gridSize = this.#gridUnit * Math.ceil(this.#gridSize / this.#gridUnit);
-        // if the number of divisions is odd, we need to add one more division
-        if (gridSize / this.#gridUnit % 2 === 1)
-            gridSize += this.#gridUnit;
-
-        // todo  adjust grid size so that is divisible by grid unit
-        this.#gridHelper = new THREE.GridHelper(gridSize, gridSize / this.#gridUnit, 0x666666, 0x222222);
-        const adjustedOrigin = vec3.add(vec3.create(), this.#planeRestriction.origin, this.#offsetFromUnit);
-        this.#gridHelper.position.copy(new THREE.Vector3(adjustedOrigin[0], adjustedOrigin[1], adjustedOrigin[2]));
-        this.#gridHelper.visible = false;
-
-        this.#gridHelper.renderOrder = 100;
-        (this.#gridHelper.material as THREE.LineBasicMaterial).depthTest = false;
-        (this.#gridHelper.material as THREE.LineBasicMaterial).transparent = true;
-
-        // three.js uses a right-handed coordinate system, so we need to rotate the grid helper
-        const rotationMatrix = new THREE.Matrix4().fromArray([
-            this.#planeRestriction.vectorU[0], this.#planeRestriction.vectorU[1], this.#planeRestriction.vectorU[2], 0,
-            this.#planeRestriction.vectorV[0], this.#planeRestriction.vectorV[1], this.#planeRestriction.vectorV[2], 0,
-            this.#planeRestriction.normal[0], this.#planeRestriction.normal[1], this.#planeRestriction.normal[2], 0,
-            0, 0, 0, 1
-        ]);
-
-        this.#gridHelper.rotation.setFromRotationMatrix(rotationMatrix);
-        // three.js grid helper is created in the XY plane, so we need to rotate it by 90 degrees around the X axis
-        this.#gridHelper.rotateX(Math.PI / 2);
-
-        this._object3D.add(this.#gridHelper);
-    }
-
-    private createOffsetFromUnit(): void {
-        // Calculate the offset of the rotated point from the rotated origin
-        this.#offsetFromUnit[0] = this.#gridUnit * Math.round(this.#planeRestriction.origin[0] / this.#gridUnit) - this.#planeRestriction.origin[0];
-        this.#offsetFromUnit[1] = this.#gridUnit * Math.round(this.#planeRestriction.origin[1] / this.#gridUnit) - this.#planeRestriction.origin[1];
-        this.#offsetFromUnit[2] = this.#gridUnit * Math.round(this.#planeRestriction.origin[2] / this.#gridUnit) - this.#planeRestriction.origin[2];
-    }
-
-    // #endregion Private Methods (2)
-}
-
-// #endregion Classes (1)

package/src/business/implementation/utils/numberCleaner.ts

@@ -1,5 +0,0 @@
-
-export const numberCleaner = (value: number): number => {
-    const roundedThreshold = 100;
-    return Math.round(value * roundedThreshold) / roundedThreshold;
-};

package/src/business/interfaces/IDrawingToolsManager.ts

@@ -1,312 +0,0 @@
-import { GeometryRestrictionProperties } from '../implementation/managers/interaction/restrictions/geometry/GeometryRestriction';
-import { IManager } from './IManager';
-import { IMapData, IMaterialBasicLineDataProperties, IMaterialMultiPointDataProperties } from '@shapediver/viewer.shared.types';
-import { IRestriction, RestrictionProperties } from './IRestriction';
-import { PlaneRestrictionProperties } from '../implementation/managers/interaction/restrictions/plane/PlaneRestriction';
-import { vec3 } from 'gl-matrix';
-
-// #region Type aliases (5)
-
-/**
- * The callbacks of the drawing tool.
- * 
- * Here you can define the callbacks that are used when interacting with the drawing tool.
- * 
- * @typedef Callbacks
- */
-export type Callbacks = {
-    /**
-     * The callback that is called when the drawing tool is cancelled.
-     */
-    onCancel(): void;
-    /**
-     * The callback that is called when the drawing tool is updated.
-     * 
-     * @param pointsData The points data of the drawing tool.
-     */
-    onUpdate(pointsData: PointsData): void;
-};
-export type DefaultTextures = { [key: string]: Promise<IMapData> | IMapData }
-
-/**
- * The data of the points.
- * The points are defined as an array of arrays, where each array contains the x, y and z coordinates of the point.
- * 
- * @example [[0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0], [0, 0, 0]]
- * @typedef PointsData
- */
-export type PointsData = number[][];
-/**
- * The initial settings of the drawing tool.
- * Here you can define the initial settings of the drawing tool.
- * 
- * @typedef Settings
- * 
- */
-export type Settings = {
-    /**
-     * The geometry settings of the drawing tool.
-     * 
-     * Here you can define the points, the mode and specific details of the geometry.
-     */
-    geometry: {
-        /**
-         * The points that are used when starting the drawing tool.
-         * The points are defined as an array of arrays, where each array contains the x, y and z coordinates of the point.
-         *  
-         * If the mode is set to 'lines', the points are connected in the order they are defined.
-         * If the mode is set to 'points', the points are not connected.
-         * 
-         * @default []
-         * @example [[0, 0, 0], [1, 0, 0], [1, 1, 0], [0, 1, 0], [0, 0, 0]]
-         */
-        points: PointsData;
-
-        /**
-         * The mode of the geometry.
-         * 
-         * If the mode is set to 'lines', the points are connected in the order they are defined.
-         * If the mode is set to 'points', the points are not connected.
-         * 
-         * @default 'lines'
-         */
-        mode: 'points' | 'lines';
-
-        /**
-         * The minimum amount of points, if undefined, the geometry is not restricted.
-         * This value is checked whenever the user tries to update or finish the drawing tool.
-         * 
-         * @default undefined
-         */
-        minPoints?: number;
-
-        /**
-         * The maximum amount of points, if undefined, the geometry is not restricted.
-         * This value is checked whenever the user tries to update or finish the drawing tool.
-         * 
-         * @default undefined
-         */
-        maxPoints?: number;
-
-        /**
-         * If the number of points is strictly checked during the drawing process.
-         * If this setting is set to true, once the minimum or maximum amount of points is reached, the user cannot add or remove points that would violate the restriction.
-         * If this setting is set to false, the user can add or remove points even if the minimum or maximum amount of points is exceeded temporarily.
-         * Once the user tries to update or finish the drawing tool, the amount of points is checked in either case.
-         * 
-         * @default true
-         */
-        strictMinMaxPoints?: boolean;
-
-        /**
-         * If the mode is set to 'lines', if it is a closed line or not.
-         * If the mode is set to 'points', this setting is ignored.
-         * 
-         * A line can be closed by connecting the last point with the first point.
-         * 
-         * @default true
-         */
-        close: boolean;
-
-        /**
-         * If the mode is set to 'lines', if the line is automatically closed.
-         * If the mode is set to 'points', this setting is ignored.
-         * 
-         * The first and last point are always connected if the line is automatically closed.
-         * 
-         * @default true
-         */
-        autoClose: boolean;
-
-    },
-
-    /**
-     * The restrictions of the drawing tool.
-     * 
-     * Here you can define the restrictions that are used when interacting with the drawing tool.
-     * At least one restriction is required, the plane restriction is added by default if no restrictions are defined.
-     */
-    restrictions: { [key: string]: RestrictionProperties | PlaneRestrictionProperties | GeometryRestrictionProperties };
-
-    /**
-     * The visualization settings of the drawing tool.
-     * 
-     * Here you can define the visualization of the drawing tool.
-     */
-    visualization: {
-        /**
-         * The multiplication factor of the point size when interactions are performed.
-         * If the factor is set to 2, the point size is doubled when interacting.
-         * 
-         * @default 2
-         */
-        distanceMultiplicationFactor: number,
-
-        /**
-         * If the point labels are shown.
-         * The point labels display the position of the points.
-         * 
-         * @default false
-         */
-        pointLabels: boolean,
-
-        /**
-         * If the distance labels are shown.
-         * The distance labels display the distance between the points.
-         * 
-         * @default true
-         */
-        distanceLabels: boolean,
-
-        /**
-         * The material properties of the points.
-         */
-        points: IMaterialMultiPointDataProperties,
-
-        /**
-         * The material properties of the lines.
-         */
-        lines: IMaterialBasicLineDataProperties
-
-    };
-
-    /**
-     * The control settings of the drawing tool.
-     * 
-     * Here you can define which keys are used for the different actions of the drawing tool.
-     */
-    controls: {
-        /**
-         * The key that is used to insert a point.
-         * 
-         * @default ['Insert','+']
-         */
-        insert: string | string[],
-
-        /**
-         * The key that is used to delete a point.
-         * 
-         * @default ['Delete','-']
-         */
-        delete: string | string[],
-
-        /**
-         * The key that is used to confirm actions.
-         * 
-         * @default 'Enter'
-         */
-        confirm: string | string[],
-
-        /**
-         * The key that is used to cancel drawing.
-         * 
-         * @default 'Escape'
-         */
-        cancel: string | string[],
-
-        /**
-         * The keys that are used to undo the last action.
-         * 
-         * @default 'Control+Z'
-         */
-        undo: string | string[],
-
-        /**
-         * The keys that are used to redo the last action.
-         * 
-         * @default 'Control+Y'
-         */
-        redo: string | string[]
-    };
-
-    /**
-     * The general settings of the drawing tool.
-     * 
-     * Here you can define general settings of the drawing tool.
-     */
-    general: {
-        /**
-         * If the drawing tool is started automatically when no points are defined.
-         * 
-         * @default true
-         */
-        autoStart: boolean;
-
-        /**
-         * If the drawing tool is updated automatically when the drawing is changed.
-         * 
-         * @default false
-         */
-        autoUpdate: boolean;
-        /**
-         * If the drawing tool is closed when the drawing is updated.
-         * 
-         * @default false
-         */
-        closeOnUpdate: boolean;
-
-        /** 
-         * The unit that will be displayed in the distance and point labels. 
-         * 
-         * @default ''
-         */
-        displayUnit: string;
-    }
-
-};
-export type SettingsOptional = {
-    geometry?: Partial<Settings['geometry']>;
-    restrictions?: Partial<Settings['restrictions']>;
-    visualization?: Partial<Settings['visualization']>;
-    controls?: Partial<Settings['controls']>;
-    general?: Partial<Settings['general']>;
-};
-
-// #endregion Type aliases (5)
-
-// #region Interfaces (1)
-
-export interface IDrawingToolsManager extends IManager {
-    // #region Properties (4)
-
-    readonly closed: boolean;
-    readonly restrictions: { [key: string]: IRestriction };
-
-    showDistanceLabels: boolean;
-    showPointLabels: boolean;
-
-    // #endregion Properties (4)
-
-    // #region Public Methods (13)
-
-    addPoint(index: number, position?: vec3, temporary?: boolean): void;
-    addRestriction(properties: RestrictionProperties, token?: string): string | undefined;
-    canRedo(): boolean;
-    canUndo(): boolean;
-    cancel(): void;
-    getPointsData(): PointsData;
-    movePoint(index: number, position: vec3, temporary?: boolean): void;
-    redo(): void;
-    removePoint(index: number, temporary?: boolean): void;
-    removePoints(indices: number[]): void;
-    removeRestriction(token: string): void;
-    undo(): void;
-    update(): PointsData | undefined;
-
-    // #endregion Public Methods (13)
-}
-
-// #endregion Interfaces (1)
-
-// #region Enums (1)
-
-export enum MATERIAL_INDEX {
-    DEFAULT = 0,
-    HOVERED = 1,
-    SELECTED = 2,
-    SELECTED_HOVERED = 3,
-    INSERTION = 4,
-    INSERTION_HOVERED = 5
-}
-
-// #endregion Enums (1)

package/src/business/interfaces/IManager.ts

@@ -1,7 +0,0 @@
-export interface IManager {
-    // #region Public Methods (1)
-
-    close(): void;
-
-    // #endregion Public Methods (1)
-}

package/src/business/interfaces/IRestriction.ts

@@ -1,63 +0,0 @@
-import { IRay } from '@shapediver/viewer.features.interaction';
-import { IRestrictionBase } from './IRestrictionBase';
-import { ISnapRestriction } from './ISnapRestriction';
-import { vec3 } from 'gl-matrix';
-
-// #region Type aliases (2)
-
-export type RestrictionMetaData = {
-    index?: number;
-    referencePoint?: vec3;
-}
-
-export type RestrictionProperties = {
-    /**
-     * Type of the restriction
-     */
-    type: RESTRICTION_TYPE;
-};
-
-// #endregion Type aliases (2)
-
-// #region Interfaces (1)
-
-export interface IRestriction extends IRestrictionBase {
-    // #region Properties (2)
-
-    /**
-     * Priority of the restriction
-     */
-    readonly priority: number;
-
-    /**
-     * The snap restrictions of the restriction.
-     */
-    snapRestrictions: { [key: string]: ISnapRestriction; }
-
-    // #endregion Properties (2)
-
-    // #region Public Methods (1)
-
-    /**
-     * Ray trace the restriction.
-     * If the ray does not intersect the restriction, the method returns undefined.
-     * 
-     * @param ray The ray to trace.
-     * @param metaData The meta data of the ray.
-     * @returns The intersection point of the ray with the restriction.
-     */
-    rayTrace(ray: IRay, metaData?: RestrictionMetaData): vec3 | undefined;
-
-    // #endregion Public Methods (1)
-}
-
-// #endregion Interfaces (1)
-
-// #region Enums (1)
-
-export enum RESTRICTION_TYPE {
-    PLANE = 'plane',
-    GEOMETRY = 'geometry',
-}
-
-// #endregion Enums (1)

package/src/business/interfaces/IRestrictionBase.ts

@@ -1,33 +0,0 @@
-// #region Interfaces (1)
-
-export interface IRestrictionBase {
-    // #region Properties (3)
-
-    /**
-     * The unique identifier of the restriction.
-     */
-    readonly id: string;
-
-    /**
-     * Whether the restriction is enabled or not.
-     */
-    enabled: boolean;
-    
-    /**
-     * Whether the visualization of the restriction is shown or not (if there is one).
-     */
-    showVisualization: boolean;
-
-    // #endregion Properties (3)
-
-    // #region Public Methods (1)
-
-    /**
-     * Remove the visualization of the restriction.
-     */
-    removeVisualization(): void;
-
-    // #endregion Public Methods (1)
-}
-
-// #endregion Interfaces (1)