plotboilerplate 1.15.0 → 1.16.0

package/src/ts/VEllipse.ts

@@ -13,7 +13,9 @@
  * @modified 2021-03-10 Added the `toCubicBezier` method.
  * @modified 2021-03-15 Added `VEllipse.quarterSegmentCount` and `VEllipse.scale` functions.
  * @modified 2021-03-19 Added the `VEllipse.rotate` function.
- * @version  1.2.2
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @modified 2022-02-02 Cleared the `VEllipse.toSVGString` function (deprecated). Use `drawutilssvg` instead.
+ * @version  1.3.0
  *
  * @file VEllipse
  * @fileoverview Ellipses with a center and an x- and a y-axis (stored as a vertex).
@@ -71,6 +73,14 @@ export class VEllipse implements SVGSerializable {
    */
   rotation: number;
 
+  /**
+   * @member isDestroyed
+   * @memberof VEllipse
+   * @type {boolean}
+   * @instance
+   */
+  isDestroyed: boolean;
+
   /**
    * The constructor.
    *
@@ -411,16 +421,31 @@ export class VEllipse implements SVGSerializable {
    * @return string The SVG string
    */
   toSVGString(options: { className?: string }) {
-    options = options || {};
-    var buffer: Array<string> = [];
-    buffer.push("<ellipse");
-    if (options.className) buffer.push(' class="' + options.className + '"');
-    buffer.push(' cx="' + this.center.x + '"');
-    buffer.push(' cy="' + this.center.y + '"');
-    buffer.push(' rx="' + this.axis.x + '"');
-    buffer.push(' ry="' + this.axis.y + '"');
-    buffer.push(" />");
-    return buffer.join("");
+    // options = options || {};
+    // var buffer: Array<string> = [];
+    // buffer.push("<ellipse");
+    // if (options.className) buffer.push(' class="' + options.className + '"');
+    // buffer.push(' cx="' + this.center.x + '"');
+    // buffer.push(' cy="' + this.center.y + '"');
+    // buffer.push(' rx="' + this.axis.x + '"');
+    // buffer.push(' ry="' + this.axis.y + '"');
+    // buffer.push(" />");
+    // return buffer.join("");
+    console.warn(
+      "[Deprecation] Warning: the VEllipse.toSVGString method is deprecated and does not return and valid SVG data any more. Please use `drawutilssvg` instead."
+    );
+    return "";
+  }
+
+  /**
+   * This function should invalidate any installed listeners and invalidate this object.
+   * After calling this function the object might not hold valid data any more and
+   * should not be used.
+   */
+  destroy() {
+    this.center.destroy();
+    this.axis.destroy();
+    this.isDestroyed = true;
   }
 
   /**

package/src/ts/VEllipseSector.ts

@@ -4,7 +4,8 @@
  *
  * @author  Ikaros Kappler
  * @date    2021-02-26
- * @version 1.0.0
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @version 1.1.0
  */
 
 import { CubicBezierCurve } from "./CubicBezierCurve";
@@ -64,6 +65,14 @@ export class VEllipseSector {
    */
   endAngle: number;
 
+  /**
+   * @member isDestroyed
+   * @memberof VEllipseSector
+   * @type {boolean}
+   * @instance
+   */
+  isDestroyed: boolean;
+
   /**
    * Create a new elliptic sector from the given ellipse and two angles.
    *
@@ -150,6 +159,16 @@ export class VEllipseSector {
     return curves;
   }
 
+  /**
+   * This function should invalidate any installed listeners and invalidate this object.
+   * After calling this function the object might not hold valid data any more and
+   * should not be used.
+   */
+  destroy() {
+    this.ellipse.destroy();
+    this.isDestroyed = true;
+  }
+
   static ellipseSectorUtils = {
     /**
      * Helper function to convert an elliptic section to SVG arc params (for the `d` attribute).

package/src/ts/Vector.ts

@@ -9,7 +9,9 @@
  * @modified 2019-12-04 Added the Vector.inv() function.
  * @modified 2020-03-23 Ported to Typescript from JS.
  * @modified 2021-01-20 Added UID.
- * @version  1.3.0
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @modified 2022-02-02 Cleared the `Vector.toSVGString` function (deprecated). Use `drawutilssvg` instead.
+ * @version  1.4.0
  *
  * @file Vector
  * @public
@@ -17,7 +19,7 @@
 
 import { VertTuple } from "./VertTuple";
 import { Vertex } from "./Vertex";
-import { SVGSerializable  } from "./interfaces";
+import { SVGSerializable } from "./interfaces";
 
 /**
  * @classdesc A vector (Vertex,Vertex) is a line with a visible direction.<br>
@@ -28,175 +30,177 @@ import { SVGSerializable  } from "./interfaces";
  * @requires VertTuple
  * @requires Vertex
  **/
-export class Vector extends VertTuple<Vector> implements SVGSerializable {  
+export class Vector extends VertTuple<Vector> implements SVGSerializable {
+  /**
+   * Required to generate proper CSS classes and other class related IDs.
+   **/
+  readonly className: string = "Vector";
 
-    /**
-     * Required to generate proper CSS classes and other class related IDs.
-     **/
-    readonly className : string = "Vector";
-    
-    /**
-     * The constructor.
-     * 
-     * @constructor
-     * @name Vector
-     * @extends Line
-     * @param {Vertex} vertA - The start vertex of the vector.
-     * @param {Vertex} vertB - The end vertex of the vector.
-     **/
-    constructor( vertA:Vertex, vertB:Vertex ) {
-	super(vertA,vertB,(a:Vertex,b:Vertex)=>new Vector(a,b));
-    };
+  /**
+   * The constructor.
+   *
+   * @constructor
+   * @name Vector
+   * @extends Line
+   * @param {Vertex} vertA - The start vertex of the vector.
+   * @param {Vertex} vertB - The end vertex of the vector.
+   **/
+  constructor(vertA: Vertex, vertB: Vertex) {
+    super(vertA, vertB, (a: Vertex, b: Vertex) => new Vector(a, b));
+  }
 
+  /**
+   * Get the perpendicular of this vector which is located at a.
+   *
+   * @param {Number} t The position on the vector.
+   * @return {Vector} A new vector being the perpendicular of this vector sitting on a.
+   **/
+  perp(): Vector {
+    var v: Vector = this.clone();
+    v.sub(this.a);
+    v = new Vector(new Vertex(), new Vertex(-v.b.y, v.b.x));
+    v.a.add(this.a);
+    v.b.add(this.a);
+    return v;
+  }
 
-    
-    /**
-     * Get the perpendicular of this vector which is located at a.
-     *
-     * @param {Number} t The position on the vector.
-     * @return {Vector} A new vector being the perpendicular of this vector sitting on a.
-     **/
-    perp():Vector {
-	var v : Vector = this.clone();
-	v.sub( this.a );
-	v = new Vector( new Vertex(), new Vertex(-v.b.y,v.b.x) );
-	v.a.add( this.a );
-	v.b.add( this.a );
-	return v;
-    };
+  /**
+   * The inverse of a vector is a vector witht the same magnitude but oppose direction.
+   *
+   * Please not that the origin of this vector changes here: a->b becomes b->a.
+   *
+   * @return {Vector}
+   **/
+  inverse(): Vector {
+    var tmp = this.a;
+    this.a = this.b;
+    this.b = tmp;
+    return this;
+  }
 
-    
-    /**
-     * The inverse of a vector is a vector witht the same magnitude but oppose direction.
-     *
-     * Please not that the origin of this vector changes here: a->b becomes b->a.
-     *
-     * @return {Vector}
-     **/
-    inverse():Vector {
-	var tmp = this.a;
-	this.a = this.b;
-	this.b = tmp;
-	return this;
-    };
-    
+  /**
+   * This function computes the inverse of the vector, which means 'a' stays untouched.
+   *
+   * @return {Vector} this for chaining.
+   **/
+  inv(): Vector {
+    this.b.x = this.a.x - (this.b.x - this.a.x);
+    this.b.y = this.a.y - (this.b.y - this.a.y);
+    return this;
+  }
 
-    /**
-     * This function computes the inverse of the vector, which means 'a' stays untouched.
-     *
-     * @return {Vector} this for chaining.
-     **/
-    inv():Vector {
-	this.b.x = this.a.x-(this.b.x-this.a.x);
-	this.b.y = this.a.y-(this.b.y-this.a.y);
-	return this;
-    };
+  /**
+   * Get the intersection if this vector and the specified vector.
+   *
+   * @method intersection
+   * @param {Vector} line The second vector.
+   * @return {Vertex} The intersection (may lie outside the end-points).
+   * @instance
+   * @memberof Line
+   **/
+  intersection(line: Vector): Vertex | null {
+    var denominator = this.denominator(line);
+    if (denominator == 0) return null;
 
+    var a = this.a.y - line.a.y;
+    var b = this.a.x - line.a.x;
+    var numerator1 = (line.b.x - line.a.x) * a - (line.b.y - line.a.y) * b;
+    var numerator2 = (this.b.x - this.a.x) * a - (this.b.y - this.a.y) * b;
+    a = numerator1 / denominator; // NaN if parallel lines
+    b = numerator2 / denominator;
 
-    /**
-     * Get the intersection if this vector and the specified vector.
-     *
-     * @method intersection
-     * @param {Vector} line The second vector.
-     * @return {Vertex} The intersection (may lie outside the end-points).
-     * @instance
-     * @memberof Line
-     **/
-    intersection( line:Vector ):Vertex|null {
-	var denominator = this.denominator(line);
-	if( denominator == 0 ) 
-	    return null;
-	
-	var a = this.a.y - line.a.y; 
-	var b = this.a.x - line.a.x; 
-	var numerator1 = ((line.b.x - line.a.x) * a) - ((line.b.y - line.a.y) * b);
-	var numerator2 = ((this.b.x - this.a.x) * a) - ((this.b.y - this.a.y) * b);
-	a = numerator1 / denominator; // NaN if parallel lines
-	b = numerator2 / denominator;
+    // TODO:
+    // FOR A VECTOR THE LINE-INTERSECTION MUST BE ON BOTH VECTORS
+
+    // if we cast these lines infinitely in both directions, they intersect here:
+    return new Vertex(this.a.x + a * (this.b.x - this.a.x), this.a.y + a * (this.b.y - this.a.y));
+  }
 
-	// TODO:
-	// FOR A VECTOR THE LINE-INTERSECTION MUST BE ON BOTH VECTORS
-	
-	// if we cast these lines infinitely in both directions, they intersect here:
-	return new Vertex( this.a.x + (a * (this.b.x - this.a.x)),
-			   this.a.y + (a * (this.b.y - this.a.y)) );
-    };
-    
-    
+  /**
+   * Create an SVG representation of this line.
+   *
+   * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
+   * @method toSVGString
+   * @override
+   * @param {object=} options - A set of options, like 'className'.
+   * @return {string} The SVG string representation.
+   * @instance
+   * @memberof Vector
+   **/
+  toSVGString(options: { className?: string }) {
+    // options = options || {};
+    // var buffer = [];
+    // var vertices = Vector.utils.buildArrowHead(this.a, this.b, 8, 1.0, 1.0);
+    // buffer.push("<g");
+    // if (options.className) buffer.push(' class="' + options.className + '"');
+    // buffer.push(">");
+    // buffer.push("   <line");
+    // buffer.push(' x1="' + this.a.x + '"');
+    // buffer.push(' y1="' + this.a.y + '"');
+    // buffer.push(' x2="' + vertices[0].x + '"');
+    // buffer.push(' y2="' + vertices[0].y + '"');
+    // buffer.push(" />");
+    // // Add arrow head
+
+    // buffer.push('   <polygon points="');
+    // for (var i = 0; i < vertices.length; i++) {
+    //   if (i > 0) buffer.push(" ");
+    //   buffer.push("" + vertices[i].x + "," + vertices[i].y);
+    // }
+    // buffer.push('"/>');
+    // buffer.push("</g>");
+    // return buffer.join("");
+    console.warn(
+      "[Deprecation] Warning: the Vector.toSVGString method is deprecated and does not return and valid SVG data any more. Please use `drawutilssvg` instead."
+    );
+    return "";
+  }
+
+  static utils = {
     /**
-     * Create an SVG representation of this line.
+     * Generate a four-point arrow head, starting at the vector end minus the
+     * arrow head length.
+     *
+     * The first vertex in the returned array is guaranteed to be the located
+     * at the vector line end minus the arrow head length.
      *
-     * @deprecated DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.
-     * @method toSVGString
-     * @override
-     * @param {object=} options - A set of options, like 'className'.
-     * @return {string} The SVG string representation.
-     * @instance
-     * @memberof Vector
+     *
+     * Due to performance all params are required.
+     *
+     * The params scaleX and scaleY are required for the case that the scaling is not uniform (x and y
+     * scaling different). Arrow heads should not look distored on non-uniform scaling.
+     *
+     * If unsure use 1.0 for scaleX and scaleY (=no distortion).
+     * For headlen use 8, it's a good arrow head size.
+     *
+     * Example:
+     *    buildArrowHead( new Vertex(0,0), new Vertex(50,100), 8, 1.0, 1.0 )
+     *
+     * @param {Vertex} zA - The start vertex of the vector to calculate the arrow head for.
+     * @param {Vertex} zB - The end vertex of the vector.
+     * @param {number} headlen - The length of the arrow head (along the vector direction. A good value is 12).
+     * @param {number} scaleX  - The horizontal scaling during draw.
+     * @param {number} scaleY  - the vertical scaling during draw.
      **/
-    toSVGString( options:{className?:string} ) {
-	options = options || {};
-	var buffer = [];
-	var vertices = Vector.utils.buildArrowHead( this.a, this.b, 8, 1.0, 1.0 );
-	buffer.push( '<g' );
-	if( options.className )
-	    buffer.push( ' class="' + options.className + '"' );
-	buffer.push( '>' );
-	buffer.push( '   <line' );
-	buffer.push( ' x1="' + this.a.x + '"' );
-	buffer.push( ' y1="' + this.a.y + '"' );
-	buffer.push( ' x2="' + vertices[0].x + '"' );
-	buffer.push( ' y2="' + vertices[0].y + '"' );
-	buffer.push( ' />' );
-	// Add arrow head
-	
-	buffer.push( '   <polygon points="' );
-	for( var i = 0; i < vertices.length; i++ ) {
-	    if( i > 0 )
-		buffer.push( ' ' );
-	    buffer.push( '' + vertices[i].x + ',' + vertices[i].y );
-	}
-	buffer.push( '"/>' );
-	buffer.push( '</g>' );
-	return buffer.join('');
-    };
-
-    static utils = {
-	/**
-	 * Generate a four-point arrow head, starting at the vector end minus the
-	 * arrow head length.
-	 *
-	 * The first vertex in the returned array is guaranteed to be the located
-	 * at the vector line end minus the arrow head length.
-	 *
-	 *
-	 * Due to performance all params are required.
-	 *
-	 * The params scaleX and scaleY are required for the case that the scaling is not uniform (x and y
-	 * scaling different). Arrow heads should not look distored on non-uniform scaling.
-	 *
-	 * If unsure use 1.0 for scaleX and scaleY (=no distortion).
-	 * For headlen use 8, it's a good arrow head size.
-	 *
-	 * Example:
-	 *    buildArrowHead( new Vertex(0,0), new Vertex(50,100), 8, 1.0, 1.0 )
-	 *
-	 * @param {Vertex} zA - The start vertex of the vector to calculate the arrow head for.
-	 * @param {Vertex} zB - The end vertex of the vector.
-	 * @param {number} headlen - The length of the arrow head (along the vector direction. A good value is 12).
-	 * @param {number} scaleX  - The horizontal scaling during draw.
-	 * @param {number} scaleY  - the vertical scaling during draw.
-	 **/
-	buildArrowHead : ( zA:Vertex, zB:Vertex, headlen:number, scaleX:number, scaleY:number ) => {
-	    var angle = Math.atan2( (zB.y-zA.y)*scaleY, (zB.x-zA.x)*scaleX );   
-	    var vertices = [];
-	    vertices.push( new Vertex(zB.x*scaleX-(headlen)*Math.cos(angle), zB.y*scaleY-(headlen)*Math.sin(angle)) );    
-	    vertices.push( new Vertex(zB.x*scaleX-(headlen*1.35)*Math.cos(angle-Math.PI/8), zB.y*scaleY-(headlen*1.35)*Math.sin(angle-Math.PI/8) ) );
-	    vertices.push( new Vertex(zB.x*scaleX, zB.y*scaleY) );
-	    vertices.push( new Vertex(zB.x*scaleX-(headlen*1.35)*Math.cos(angle+Math.PI/8), zB.y*scaleY-(headlen*1.35)*Math.sin(angle+Math.PI/8)) );
+    buildArrowHead: (zA: Vertex, zB: Vertex, headlen: number, scaleX: number, scaleY: number) => {
+      var angle = Math.atan2((zB.y - zA.y) * scaleY, (zB.x - zA.x) * scaleX);
+      var vertices = [];
+      vertices.push(new Vertex(zB.x * scaleX - headlen * Math.cos(angle), zB.y * scaleY - headlen * Math.sin(angle)));
+      vertices.push(
+        new Vertex(
+          zB.x * scaleX - headlen * 1.35 * Math.cos(angle - Math.PI / 8),
+          zB.y * scaleY - headlen * 1.35 * Math.sin(angle - Math.PI / 8)
+        )
+      );
+      vertices.push(new Vertex(zB.x * scaleX, zB.y * scaleY));
+      vertices.push(
+        new Vertex(
+          zB.x * scaleX - headlen * 1.35 * Math.cos(angle + Math.PI / 8),
+          zB.y * scaleY - headlen * 1.35 * Math.sin(angle + Math.PI / 8)
+        )
+      );
 
-	    return vertices;
-	} 
+      return vertices;
     }
-    
+  };
 }