jclic 2.2.0 → 2.3.0

package/src/shapers/ClassicJigSaw.js

@@ -1,138 +0,0 @@
-/**
- *  File    : shapers/ClassicJigSaw.js
- *  Created : 25/05/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import Shaper from './Shaper.js';
-import JigSaw from './JigSaw.js';
-import { PathStroke } from '../AWT.js';
-
-/**
- * This is the classic {@link module:shapers/JigSaw.JigSaw JigSaw} {@link module:shapers/Shaper.Shaper Shaper} used in puzzle toys, where teeth and slots
- * are shaped by Bézier curves.
- * @extends module:shapers/JigSaw.JigSaw
- */
-export class ClassicJigSaw extends JigSaw {
-  /**
-   * ClassicJigSaw constructor
-   * @param {number} nx - Number of columns
-   * @param {number} ny - Number of rows
-   */
-  constructor(nx, ny) {
-    super(nx, ny);
-  }
-
-  /**
-   * Overrides {@link module:shapers/JigSaw.JigSaw#hLine}
-   * @override
-   * @param {module:AWT.Path} sd - The Path to which the line will be added
-   * @param {number} type - Type  of tooth: 0 is flat (no tooth), 1 means tooth up, and 2 means tooth down
-   * @param {number} x - X coordinate of the starting point
-   * @param {number} y - Y coordinate of the starting point
-   * @param {number} w - Width of the piece
-   * @param {number} h - Height of the piece
-   * @param {boolean} inv - The line must be drawn right to left
-   */
-  hLine(sd, type, x, y, w, h, inv) {
-    const
-      kx = inv ? -1 : 1,
-      ky = type === 1 ? 1 : -1;
-
-    if (type === 0)
-      // Flat line
-      sd.addStroke(new PathStroke('L', [x + w * kx, y]));
-    else {
-      const
-        x0 = x + (w - w * this.baseWidthFactor) / 2 * kx,
-        wb = w * (this.baseWidthFactor / 12) * kx;
-
-      // Approximation to the tooth:
-      sd.addStroke(new PathStroke('L', [x0, y]));
-      // This is the tooth:
-      const hb = h * this.toothHeightFactor * ky / 8;
-      sd.addStroke(new PathStroke('B', [x0 + 4 * wb, y, x0 + 6 * wb, y - hb, x0 + 4 * wb, y - 3 * hb]));
-      sd.addStroke(new PathStroke('B', [x0 + 2 * wb, y - 5 * hb, x0 + 10 * wb, y - 5 * hb, x0 + 8 * wb, y - 3 * hb]));
-      sd.addStroke(new PathStroke('B', [x0 + 6 * wb, y - 1 * hb, x0 + 8 * wb, y, x0 + 12 * wb, y]));
-      // Draw the remaining line
-      sd.addStroke(new PathStroke('L', [x + w * kx, y]));
-    }
-  }
-
-  /**
-   * Overrides {@link module:shapers/JigSaw.JigSaw#vLine}
-   * @override
-   * @param {module:AWT.Path} sd - The Path to which the line will be added
-   * @param {number} type - Type  of tooth: 0 is flat (no tooth), 1 means tooth right, and 2 means tooth left
-   * @param {number} x - X coordinate of the starting point
-   * @param {number} y - Y coordinate of the starting point
-   * @param {number} w - Width of the piece
-   * @param {number} h - Height of the piece
-   * @param {boolean} inv - The line must be drawn bottom to top
-   */
-  vLine(sd, type, x, y, w, h, inv) {
-    const
-      ky = inv ? -1 : 1,
-      kx = type === 1 ? 1 : -1;
-
-    if (type === 0)
-      // Flat line
-      sd.addStroke(new PathStroke('L', [x, y + h * ky]));
-    else {
-      const
-        y0 = y + (h - h * this.baseWidthFactor) / 2 * ky,
-        hb = h * this.baseWidthFactor / 12 * ky;
-
-      // Approximation to the tooth:
-      sd.addStroke(new PathStroke('L', [x, y0]));
-      // This is the tooth:
-      const wb = w * this.toothHeightFactor * kx / 8;
-      sd.addStroke(new PathStroke('B', [x, y0 + 4 * hb, x - wb, y0 + 6 * hb, x - 3 * wb, y0 + 4 * hb]));
-      sd.addStroke(new PathStroke('B', [x - 5 * wb, y0 + 2 * hb, x - 5 * wb, y0 + 10 * hb, x - 3 * wb, y0 + 8 * hb]));
-      sd.addStroke(new PathStroke('B', [x - 1 * wb, y0 + 6 * hb, x, y0 + 8 * hb, x, y0 + 12 * hb]));
-      // Draw the remaining line
-      sd.addStroke(new PathStroke('L', [x, y + h * ky]));
-    }
-  }
-}
-
-Object.assign(ClassicJigSaw.prototype, {
-  /**
-   * ClassicJigSaw needs a biggest base width
-   * @name module:shapers/ClassicJigSaw.ClassicJigSaw#baseWidthFactor
-   * @type {number} */
-  baseWidthFactor: 3.0 / 4,
-  /**
-   * ClassicJigSaw needs a biggest base height factor
-   * @name module:shapers/ClassicJigSaw.ClassicJigSaw#toothHeightFactor
-   * @type {number} */
-  toothHeightFactor: 3.0 / 5,
-});
-
-// Register this class in the list of known shapers
-export default Shaper.registerClass('@ClassicJigSaw', ClassicJigSaw);

package/src/shapers/Holes.js

@@ -1,77 +0,0 @@
-/**
- *  File    : shapers/Holes.js
- *  Created : 20/05/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import Shaper from './Shaper.js';
-
-/**
- * This {@link module:shapers/Shaper.Shaper Shaper} consists of a set of arbitrary shapes placed over a main rectangle that
- * acts as a enclosure.
- * The components can be of type {@link module:AWT.Rectangle}, {@link module:AWT.Ellipse} or {@link module:AWT.Path}.
- * This components have internal dimension values relative to the horizontal and vertical
- * sizes of the enclosure. Its values (always between 0 and 1) must be scaled to real sizes
- * of graphic objects.
- * @extends module:shapers/Shaper.Shaper
- */
-export class Holes extends Shaper {
-  /**
-   * Holes constructor
-   * @param {number} nx - Not used
-   * @param {number} ny - Not used
-   */
-  constructor(nx, ny) {
-    super(1, 1);
-    this.customShapes = true;
-    this.nCols = nx;
-    this.nRows = ny;
-    this.showEnclosure = true;
-  }
-
-  /**
-   * Shapes are already loaded by {@link module:shapers/Shaper.Shaper Shaper}, so this function just sets `initiated` to `true`
-   * @override
-   */
-  buildShapes() {
-    if (this.nCells > 0)
-      this.initiated = true;
-  }
-
-  /**
-   * Gets the rectangle that contains all shapes
-   * @override
-   * @returns {module:AWT.Rectangle}
-   */
-  getEnclosingShapeData() {
-    return this.showEnclosure ? (this.enclosing || super.getEnclosingShapeData()) : null;
-  }
-}
-
-// Register this class in the list of known shapers
-export default Shaper.registerClass('@Holes', Holes);

package/src/shapers/JigSaw.js

@@ -1,161 +0,0 @@
-/**
- *  File    : shapers/JigSaw.js
- *  Created : 01/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import Shaper from './Shaper.js';
-import { Path, PathStroke } from '../AWT.js';
-
-/**
- *
- * This {@link module:shapers/Shaper.Shaper Shaper} returns a set of rectangular shapes with teeth and slots that fit between them.
- * @extends module:shapers/Shaper.Shaper
- */
-export class JigSaw extends Shaper {
-  /**
-   * JigSaw constructor
-   * @param {number} nx - Number of columns
-   * @param {number} ny - Number of rows
-   */
-  constructor(nx, ny) {
-    super(nx, ny);
-  }
-
-  /**
-   * Builds the jigsaw shapes based on the number of rows and columns
-   * @override
-   */
-  buildShapes() {
-    // Create two two-dimension arrays for storing the type of horizontal and vertical lines
-    let hLineType = [], vLineType = [];
-    for (let i = 0; i <= this.nRows; i++) {
-      hLineType[i] = [];
-      vLineType[i] = [];
-    }
-
-    for (let row = 0; row < this.nRows; row++) {
-      for (let col = 0; col < this.nCols; col++) {
-        hLineType[row][col] = row === 0 ? 0 : 1 + (this.randomLines ? Math.round(Math.random() * 9) : row + col) % 2;
-        vLineType[row][col] = col === 0 ? 0 : 1 + (this.randomLines ? Math.round(Math.random() * 9) : col + row + 1) % 2;
-        if (col === this.nCols - 1)
-          vLineType[row][col + 1] = 0;
-        if (row === this.nRows - 1)
-          hLineType[row + 1][col] = 0;
-      }
-    }
-
-    const w = 1 / this.nCols, h = 1 / this.nRows;
-    for (let r = 0; r < this.nRows; r++) {
-      for (let c = 0; c < this.nCols; c++) {
-        const x = w * c;
-        const y = h * r;
-        const sd = new Path([new PathStroke('M', [x, y])]);
-        this.hLine(sd, hLineType[r][c], x + 0, y + 0, w, h, false);
-        this.vLine(sd, vLineType[r][c + 1], x + w, y + 0, w, h, false);
-        this.hLine(sd, hLineType[r + 1][c], x + w, y + h, w, h, true);
-        this.vLine(sd, vLineType[r][c], x + 0, y + h, w, h, true);
-        sd.addStroke(new PathStroke('X'));
-        sd.calcEnclosingRect();
-        // Save the Path in `shapeData`
-        this.shapeData[r * this.nCols + c] = sd;
-      }
-    }
-    this.initiated = true;
-  }
-
-  /**
-   * Adds an horizontal line to the provided path
-   * @param {module:AWT.Path} sd - The Path to which the line will be added
-   * @param {number} type - Type  of tooth: 0 is flat (no tooth), 1 means tooth up, and 2 means tooth down
-   * @param {number} x - X coordinate of the starting point
-   * @param {number} y - Y coordinate of the starting point
-   * @param {number} w - Width of the piece
-   * @param {number} h - Height of the piece
-   * @param {boolean} inv - The line must be drawn right to left
-   */
-  hLine(sd, type, x, y, w, h, inv) {
-    const
-      kx = inv ? -1 : 1,
-      ky = type === 1 ? 1 : -1;
-
-    if (type === 0)
-      // Flat line
-      sd.addStroke(new PathStroke('L', [x + w * kx, y]));
-    else {
-      const x0 = x + (w - w * this.baseWidthFactor) / 2 * kx;
-      const wb = w * this.baseWidthFactor * kx;
-      // Approximation to the tooth:
-      sd.addStroke(new PathStroke('L', [x0, y]));
-      // The tooth:
-      const hb = h * this.toothHeightFactor * ky;
-      sd.addStroke(new PathStroke('L', [x0, y + hb]));
-      sd.addStroke(new PathStroke('L', [x0 + wb, y + hb]));
-      sd.addStroke(new PathStroke('L', [x0 + wb, y]));
-      // Draw the remaining of the line
-      sd.addStroke(new PathStroke('L', [x + w * kx, y]));
-    }
-  }
-
-  /**
-   *
-   * Adds a vertical line to the provided path
-   * @param {module:AWT.Path} sd - The Path to which the line will be added
-   * @param {number} type - Type  of tooth: 0 is flat (no tooth), 1 means tooth right, and 2 means tooth left
-   * @param {number} x - X coordinate of the starting point
-   * @param {number} y - Y coordinate of the starting point
-   * @param {number} w - Width of the piece
-   * @param {number} h - Height of the piece
-   * @param {boolean} inv - The line must be drawn bottom to top
-   */
-  vLine(sd, type, x, y, w, h, inv) {
-    const
-      ky = inv ? -1 : 1,
-      kx = type === 1 ? 1 : -1;
-
-    if (type === 0) {
-      // Flat line
-      sd.addStroke(new PathStroke('L', [x, y + h * ky]));
-    } else {
-      const y0 = y + (h - h * this.baseWidthFactor) / 2 * ky;
-      const hb = h * this.baseWidthFactor * ky;
-      // Approximation to the tooth:
-      sd.addStroke(new PathStroke('L', [x, y0]));
-      // The tooth:
-      const wb = w * this.toothHeightFactor * kx;
-      sd.addStroke(new PathStroke('L', [x + wb, y0]));
-      sd.addStroke(new PathStroke('L', [x + wb, y0 + hb]));
-      sd.addStroke(new PathStroke('L', [x, y0 + hb]));
-      // Draw the remaining line
-      sd.addStroke(new PathStroke('L', [x, y + h * ky]));
-    }
-  }
-}
-
-// Register this class in the list of known shapers
-export default Shaper.registerClass('@JigSaw', JigSaw);

package/src/shapers/Rectangular.js

@@ -1,78 +0,0 @@
-/**
- *  File    : shapers/Rectangular.js
- *  Created : 19/05/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Catalan Educational Telematic Network (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import Shaper from './Shaper.js';
-import { Rectangle, Point, Dimension } from '../AWT.js';
-
-/**
- *
- * This is the simplest {@link module:shapers/Shaper.Shaper Shaper}. It divides the graphic object in a set of rectangular
- * shapes distributed in the specified number of rows and columns.
- * @extends module:shapers/Shaper.Shaper
- */
-export class Rectangular extends Shaper {
-  /**
-   * Rectangular constructor
-   * @param {number} nx - Number of columns
-   * @param {number} ny - Number of rows
-   */
-  constructor(nx, ny) {
-    super(nx, ny);
-  }
-
-  /**
-   * Builds the rectangular shapes based on the number of rows and columns
-   * @override
-   */
-  buildShapes() {
-    const
-      w = 1 / this.nCols,
-      h = 1 / this.nRows;
-    for (let y = 0; y < this.nRows; y++) {
-      for (let x = 0; x < this.nCols; x++) {
-        this.shapeData[y * this.nCols + x] = new Rectangle(new Point(x * w, y * h), new Dimension(w, h));
-      }
-    }
-    this.initiated = true;
-  }
-}
-
-Object.assign(Rectangular.prototype, {
-  /**
-   * Overrides same flag in {@link module:/shapers/Shaper.Shaper#rectangularShapes Shaper#rectangularShapes}
-   * @name module:shapers/Rectangular.Rectangular#rectangularShapes
-   * @override
-   * @type {boolean} */
-  rectangularShapes: true,
-});
-
-// Register this class in the list of known shapers
-export default Shaper.registerClass('@Rectangular', Rectangular);