@finos/legend-extension-dsl-diagram 1.0.27 → 1.0.30

package/src/graphManager/action/changeDetection/DSLDiagram_ObserverHelper.ts

@@ -0,0 +1,153 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  observe_Abstract_PackageableElement,
+  observe_PackageableElementReference,
+  observe_PropertyReference,
+  skipObserved,
+} from '@finos/legend-graph';
+import { computed, makeObservable, observable, override } from 'mobx';
+import type { AssociationView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_AssociationView';
+import type { ClassView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassView';
+import type { ClassViewReference } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassViewReference';
+import type { Diagram } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_Diagram';
+import type { GeneralizationView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_GeneralizationView';
+import type { PropertyView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_PropertyView';
+import type { RelationshipEdgeView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipEdgeView';
+import type { RelationshipView } from '../../../models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipView';
+import type { PositionedRectangle } from '../../../models/metamodels/pure/packageableElements/diagram/geometry/DSLDiagram_PositionedRectangle';
+
+export const observe_PositionedRectangle = skipObserved(
+  (metamodel: PositionedRectangle): PositionedRectangle =>
+    makeObservable(metamodel, {
+      dummyObservable: observable,
+    }),
+);
+
+export const observe_ClassViewReference = skipObserved(
+  (metamodel: ClassViewReference): ClassViewReference => {
+    makeObservable(metamodel, {
+      value: observable,
+    });
+
+    observe_PackageableElementReference(metamodel.ownerReference);
+
+    return metamodel;
+  },
+);
+
+export const observe_ClassView = skipObserved(
+  (metamodel: ClassView): ClassView => {
+    observe_PositionedRectangle(metamodel);
+
+    makeObservable(metamodel, {
+      id: observable,
+      hideProperties: observable,
+      hideTaggedValues: observable,
+      hideStereotypes: observable,
+      hashCode: computed,
+    });
+
+    observe_PackageableElementReference(metamodel.class);
+
+    return metamodel;
+  },
+);
+
+export const observe_RelationShipEdgeView = skipObserved(
+  (metamodel: RelationshipEdgeView): RelationshipEdgeView => {
+    observe_ClassViewReference(metamodel.classView);
+
+    return metamodel;
+  },
+);
+
+export const observe_RelationshipView = skipObserved(
+  (metamodel: RelationshipView): RelationshipView => {
+    makeObservable(metamodel, {
+      // NOTE: to optimize performance for diagram, we have made classview's position and rectangle non-observable
+      // if we want to further optimize, perhaps we can also remove observability from path
+      path: observable,
+      pathForSerialization: computed,
+    });
+
+    observe_RelationShipEdgeView(metamodel.from);
+    observe_RelationShipEdgeView(metamodel.to);
+
+    return metamodel;
+  },
+);
+
+export const observe_GeneralizationView = skipObserved(
+  (metamodel: GeneralizationView): GeneralizationView => {
+    observe_RelationshipView(metamodel);
+
+    makeObservable(metamodel, {
+      hashCode: computed,
+    });
+
+    return metamodel;
+  },
+);
+
+export const observe_AssociationView = skipObserved(
+  (metamodel: AssociationView): AssociationView => {
+    observe_RelationshipView(metamodel);
+
+    makeObservable(metamodel, {
+      hashCode: computed,
+    });
+
+    observe_PropertyReference(metamodel.property);
+    observe_PackageableElementReference(metamodel.association);
+
+    return metamodel;
+  },
+);
+
+export const observe_PropertyView = skipObserved(
+  (metamodel: PropertyView): PropertyView => {
+    observe_RelationshipView(metamodel);
+
+    makeObservable(metamodel, {
+      hashCode: computed,
+    });
+
+    observe_PropertyReference(metamodel.property);
+
+    return metamodel;
+  },
+);
+
+export const observe_Diagram = skipObserved((metamodel: Diagram): Diagram => {
+  observe_Abstract_PackageableElement(metamodel);
+
+  makeObservable<Diagram, '_elementHashCode'>(metamodel, {
+    classViews: observable,
+    associationViews: observable,
+    generalizationViews: observable,
+    propertyViews: observable,
+    _elementHashCode: override,
+  });
+
+  metamodel.classViews.forEach(observe_ClassView);
+  metamodel.associationViews.forEach(observe_AssociationView);
+  metamodel.generalizationViews.forEach(observe_GeneralizationView);
+  metamodel.propertyViews.forEach(observe_PropertyView);
+
+  return metamodel;
+});

package/src/helpers/DiagramHelper.ts

@@ -14,10 +14,13 @@
  * limitations under the License.
  */
 
+import { RelationshipView } from '../models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipView';
+import { Point } from '../models/metamodels/pure/packageableElements/diagram/geometry/DSLDiagram_Point';
+import { Vector } from '../models/metamodels/pure/packageableElements/diagram/geometry/DSLDiagram_Vector';
 import type { PureModel } from '@finos/legend-graph';
+import { deleteEntry } from '@finos/legend-shared';
 import type { ClassView } from '../models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassView';
 import type { Diagram } from '../models/metamodels/pure/packageableElements/diagram/DSLDiagram_Diagram';
-import { Point } from '../models/metamodels/pure/packageableElements/diagram/geometry/DSLDiagram_Point';
 
 /**
  * Get absolute position of element on the screen by recursively walking up element tree
@@ -51,14 +54,14 @@ export const cleanUpDeadReferencesInDiagram = (
         .includes(propertyView.property.value.name),
   );
   propertyViewsToRemove.forEach((propertyView) =>
-    diagram.deletePropertyView(propertyView),
+    deleteEntry(diagram.propertyViews, propertyView),
   );
 
   // Fix orphan class views
   const classViewsToRemove = diagram.classViews.filter(
     (cv) => !graph.getNullableClass(cv.class.value.path),
   );
-  classViewsToRemove.forEach((cw) => diagram.deleteClassView(cw));
+  classViewsToRemove.forEach((cw) => deleteEntry(diagram.classViews, cw));
 
   // Fix orphan gneralization views
   const generalizationViewsToRemove = diagram.generalizationViews.filter(
@@ -74,6 +77,125 @@ export const cleanUpDeadReferencesInDiagram = (
     },
   );
   generalizationViewsToRemove.forEach((g) =>
-    diagram.deleteGeneralizationView(g),
+    deleteEntry(diagram.generalizationViews, g),
+  );
+};
+
+export const _relationshipView_setPath = (
+  relationshipView: RelationshipView,
+  val: Point[],
+): void => {
+  relationshipView.path = val;
+};
+
+/**
+ * Simplify the path.
+ *
+ * Flatten the path if the angle is wide enough between 3 consecutive points
+ * Also remove unnecessary inside points
+ */
+export const _relationshipView_simplifyPath = (
+  relationshipView: RelationshipView,
+): void => {
+  const fullPath = relationshipView.buildFullPath();
+  // NOTE: this method here will `swallow` up points inside of the boxes
+  const newPath = RelationshipView.pruneUnnecessaryInsidePoints(
+    fullPath,
+    relationshipView.from.classView.value,
+    relationshipView.to.classView.value,
   );
+
+  // recompute the offset point from center inside of `from` and `to` classviews.
+  // for each, we first check if `manageInsidePointsDynamically` removes any points from the full path
+  // if it does we will update the offset
+  if (newPath[0] !== fullPath[0]) {
+    const center = relationshipView.from.classView.value.center();
+    relationshipView.from.offsetX = (newPath[0] as Point).x - center.x;
+    relationshipView.from.offsetY = (newPath[0] as Point).y - center.y;
+  }
+
+  if (newPath[newPath.length - 1] !== fullPath[fullPath.length - 1]) {
+    const center = relationshipView.to.classView.value.center();
+    relationshipView.to.offsetX =
+      (newPath[newPath.length - 1] as Point).x - center.x;
+    relationshipView.to.offsetY =
+      (newPath[newPath.length - 1] as Point).y - center.y;
+  }
+
+  // find the point which can be flattened due to its wide angle
+  const result = [];
+  for (let i = 0; i < newPath.length - 2; i++) {
+    const v1 = Vector.fromPoints(
+      newPath[i + 1] as Point,
+      newPath[i] as Point,
+    ).unit();
+    const v2 = Vector.fromPoints(
+      newPath[i + 1] as Point,
+      newPath[i + 2] as Point,
+    ).unit();
+    const dot = v1.dotProduct(v2);
+    const angle = (Math.acos(dot) * 180) / Math.PI;
+    if (Math.abs(angle - 180) > 5) {
+      result.push(newPath[i + 1] as Point);
+    }
+  }
+
+  // NOTE: this new path does not contain the 2 end points
+  _relationshipView_setPath(relationshipView, result);
+};
+
+/**
+ * Based on the location, find the point on the path that matches or create new point
+ * (within a threshold of proximity) from the coordinate and put this in the path array
+ * so it doesn't look too weird
+ */
+export const _findOrBuildPoint = (
+  relationshipView: RelationshipView,
+  x: number,
+  y: number,
+  zoom: number,
+  allowChange: boolean,
+): Point | undefined => {
+  for (const pt of relationshipView.path) {
+    if (
+      Math.sqrt((x - pt.x) * (x - pt.x) + (y - pt.y) * (y - pt.y)) <
+      10 / zoom
+    ) {
+      return pt;
+    }
+  }
+
+  const fullPath = relationshipView.buildFullPath(allowChange);
+  const newPath = [];
+  let point;
+
+  for (let i = 0; i < fullPath.length - 1; i++) {
+    const a = fullPath[i] as Point;
+    const b = fullPath[i + 1] as Point;
+    const u = new Vector(a.x, a.y).normal(new Vector(b.x, b.y)).unit();
+    const v = Vector.fromPoints(a, new Point(x, y));
+
+    // if the selection point is not too far from the segment
+    // of the path, create a new point and make it part of the path
+    if (Math.abs(u.dotProduct(v)) < 5 / zoom) {
+      const lx = (a.x < b.x ? a.x : b.x) - 5 / zoom;
+      const hx = (a.x < b.x ? b.x : a.x) + 5 / zoom;
+      const ly = (a.y < b.y ? a.y : b.y) - 5 / zoom;
+      const hy = (a.y < b.y ? b.y : a.y) + 5 / zoom;
+
+      if (lx <= x && x <= hx && ly <= y && y <= hy) {
+        point = new Point(x, y);
+        newPath.push(point);
+      }
+    }
+
+    if (i < fullPath.length - 2) {
+      newPath.push(fullPath[i + 1] as Point);
+    }
+  }
+  if (point && allowChange) {
+    // NOTE: this new path does not contain the 2 end points
+    _relationshipView_setPath(relationshipView, newPath);
+  }
+  return point;
 };

package/src/index.ts

@@ -24,10 +24,7 @@ export { DiagramRenderer, DIAGRAM_INTERACTION_MODE } from './DiagramRenderer';
 
 export { Diagram } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_Diagram';
 export { ClassView } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassView';
-export {
-  RelationshipView,
-  manageInsidePointsDynamically,
-} from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipView';
+export { RelationshipView } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipView';
 export { PropertyHolderView } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_PropertyHolderView';
 export { PropertyView } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_PropertyView';
 export { AssociationView } from './models/metamodels/pure/packageableElements/diagram/DSLDiagram_AssociationView';

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_AssociationView.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { computed, makeObservable } from 'mobx';
 import { hashArray, type Hashable } from '@finos/legend-shared';
 import { PropertyHolderView } from './DSLDiagram_PropertyHolderView';
 import type { ClassView } from './DSLDiagram_ClassView';
@@ -37,11 +36,6 @@ export class AssociationView extends PropertyHolderView implements Hashable {
     to: ClassView,
   ) {
     super(owner, property, from, to);
-
-    makeObservable(this, {
-      hashCode: computed,
-    });
-
     this.association = association;
   }
 

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassView.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-import { computed, observable, action, makeObservable } from 'mobx';
 import { hashArray, type Hashable } from '@finos/legend-shared';
 import { PositionedRectangle } from './geometry/DSLDiagram_PositionedRectangle';
 import { Rectangle } from './geometry/DSLDiagram_Rectangle';
@@ -37,33 +36,11 @@ export class ClassView extends PositionedRectangle implements Hashable {
     _class: PackageableElementReference<Class>,
   ) {
     super(new Point(0, 0), new Rectangle(0, 0));
-
-    makeObservable(this, {
-      id: observable,
-      hideProperties: observable,
-      hideTaggedValues: observable,
-      hideStereotypes: observable,
-      setHideProperties: action,
-      setHideStereotypes: action,
-      setHideTaggedValues: action,
-      hashCode: computed,
-    });
-
     this.owner = owner;
     this.id = id;
     this.class = _class;
   }
 
-  setHideProperties(val: boolean): void {
-    this.hideProperties = val;
-  }
-  setHideStereotypes(val: boolean): void {
-    this.hideStereotypes = val;
-  }
-  setHideTaggedValues(val: boolean): void {
-    this.hideTaggedValues = val;
-  }
-
   override get hashCode(): string {
     return hashArray([
       DIAGRAM_HASH_STRUCTURE.CLASS_VIEW,

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_ClassViewReference.ts

@@ -14,13 +14,11 @@
  * limitations under the License.
  */
 
-import { observable, action, makeObservable } from 'mobx';
 import type { Diagram } from './DSLDiagram_Diagram';
 import type { ClassView } from './DSLDiagram_ClassView';
 import {
   PackageableElementExplicitReference,
   ReferenceWithOwner,
-  setPackageableElementReferenceValue,
   type PackageableElementImplicitReference,
   type PackageableElementReference,
 } from '@finos/legend-graph';
@@ -34,20 +32,9 @@ export abstract class ClassViewReference extends ReferenceWithOwner {
     value: ClassView,
   ) {
     super(ownerReference);
-
-    makeObservable(this, {
-      value: observable,
-      setValue: action,
-    });
-
     this.ownerReference = ownerReference;
     this.value = value;
   }
-
-  setValue(value: ClassView): void {
-    this.value = value;
-    setPackageableElementReferenceValue(this.ownerReference, value.owner);
-  }
 }
 
 export class ClassViewExplicitReference extends ClassViewReference {

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_Diagram.ts

@@ -14,13 +14,7 @@
  * limitations under the License.
  */
 
-import { observable, action, makeObservable, override } from 'mobx';
-import {
-  hashArray,
-  addUniqueEntry,
-  deleteEntry,
-  type Hashable,
-} from '@finos/legend-shared';
+import { hashArray, type Hashable } from '@finos/legend-shared';
 import type { ClassView } from './DSLDiagram_ClassView';
 import type { PropertyView } from './DSLDiagram_PropertyView';
 import type { GeneralizationView } from './DSLDiagram_GeneralizationView';
@@ -37,63 +31,6 @@ export class Diagram extends PackageableElement implements Hashable {
   generalizationViews: GeneralizationView[] = [];
   propertyViews: PropertyView[] = [];
 
-  constructor(name: string) {
-    super(name);
-
-    makeObservable<Diagram, '_elementHashCode'>(this, {
-      classViews: observable,
-      associationViews: observable,
-      generalizationViews: observable,
-      propertyViews: observable,
-      setClassViews: action,
-      addClassView: action,
-      deleteClassView: action,
-      setAssociationViews: action,
-      deleteAssociationView: action,
-      setGeneralizationViews: action,
-      addGeneralizationView: action,
-      deleteGeneralizationView: action,
-      setPropertyViews: action,
-      addPropertyView: action,
-      deletePropertyView: action,
-      _elementHashCode: override,
-    });
-  }
-
-  setClassViews(val: ClassView[]): void {
-    this.classViews = val;
-  }
-  addClassView(val: ClassView): void {
-    addUniqueEntry(this.classViews, val);
-  }
-  deleteClassView(val: ClassView): void {
-    deleteEntry(this.classViews, val);
-  }
-  setAssociationViews(val: AssociationView[]): void {
-    this.associationViews = val;
-  }
-  deleteAssociationView(val: AssociationView): void {
-    deleteEntry(this.associationViews, val);
-  }
-  setGeneralizationViews(val: GeneralizationView[]): void {
-    this.generalizationViews = val;
-  }
-  addGeneralizationView(val: GeneralizationView): void {
-    addUniqueEntry(this.generalizationViews, val);
-  }
-  deleteGeneralizationView(val: GeneralizationView): void {
-    deleteEntry(this.generalizationViews, val);
-  }
-  setPropertyViews(val: PropertyView[]): void {
-    this.propertyViews = val;
-  }
-  addPropertyView(val: PropertyView): void {
-    addUniqueEntry(this.propertyViews, val);
-  }
-  deletePropertyView(val: PropertyView): void {
-    deleteEntry(this.propertyViews, val);
-  }
-
   protected override get _elementHashCode(): string {
     return hashArray([
       DIAGRAM_HASH_STRUCTURE.DIAGRAM,

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_GeneralizationView.ts

@@ -14,22 +14,11 @@
  * limitations under the License.
  */
 
-import { computed, makeObservable } from 'mobx';
 import { hashArray, type Hashable } from '@finos/legend-shared';
 import { RelationshipView } from './DSLDiagram_RelationshipView';
-import type { Diagram } from './DSLDiagram_Diagram';
-import type { ClassView } from './DSLDiagram_ClassView';
 import { DIAGRAM_HASH_STRUCTURE } from '../../../../DSLDiagram_ModelUtils';
 
 export class GeneralizationView extends RelationshipView implements Hashable {
-  constructor(owner: Diagram, from: ClassView, to: ClassView) {
-    super(owner, from, to);
-
-    makeObservable(this, {
-      hashCode: computed,
-    });
-  }
-
   override get hashCode(): string {
     return hashArray([
       DIAGRAM_HASH_STRUCTURE.GENERALIZATION_VIEW,

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_PropertyView.ts

@@ -14,28 +14,11 @@
  * limitations under the License.
  */
 
-import { computed, makeObservable } from 'mobx';
 import { hashArray, type Hashable } from '@finos/legend-shared';
 import { PropertyHolderView } from './DSLDiagram_PropertyHolderView';
-import type { Diagram } from './DSLDiagram_Diagram';
-import type { ClassView } from './DSLDiagram_ClassView';
-import type { PropertyReference } from '@finos/legend-graph';
 import { DIAGRAM_HASH_STRUCTURE } from '../../../../DSLDiagram_ModelUtils';
 
 export class PropertyView extends PropertyHolderView implements Hashable {
-  constructor(
-    owner: Diagram,
-    property: PropertyReference,
-    from: ClassView,
-    to: ClassView,
-  ) {
-    super(owner, property, from, to);
-
-    makeObservable(this, {
-      hashCode: computed,
-    });
-  }
-
   override get hashCode(): string {
     return hashArray([DIAGRAM_HASH_STRUCTURE.PROPERTY_VIEW, super.hashCode]);
   }

package/src/models/metamodels/pure/packageableElements/diagram/DSLDiagram_RelationshipEdgeView.ts

@@ -14,29 +14,19 @@
  * limitations under the License.
  */
 
-import { observable, action, makeObservable } from 'mobx';
 import type { ClassViewReference } from './DSLDiagram_ClassViewReference';
 
-export class RelationShipEdgeView {
+export class RelationshipEdgeView {
   classView: ClassViewReference;
+  /**
+   * Offsets from the center of the class view.
+   *
+   * These offsets can be used to compute the end points of relationship views.
+   */
   offsetX?: number | undefined;
   offsetY?: number | undefined;
 
   constructor(classView: ClassViewReference) {
-    makeObservable(this, {
-      offsetX: observable,
-      offsetY: observable,
-      setOffsetX: action,
-      setOffsetY: action,
-    });
-
     this.classView = classView;
   }
-
-  setOffsetX(val: number): void {
-    this.offsetX = val;
-  }
-  setOffsetY(val: number): void {
-    this.offsetY = val;
-  }
 }