imagemagick-async/im_modules/Drawables/Shapes/annulus.js

An API for Image Magick commands.

let Path = require('path');

let PathParts = __dirname.split(Path.sep);
let index = PathParts.indexOf('imagemagick-async');
let RootDir = PathParts.slice(0, index + 1).join(Path.sep);

let Err = require(Path.join(RootDir, 'error.js'));
let Filepath = require(Path.join(RootDir, 'filepath.js')).Filepath;
let Coordinates = require(Path.join(Filepath.InputsDir(), 'coordinates.js')).Coordinates;
let Circle = require(Path.join(Filepath.PrimitivesDir(), 'circle.js')).Circle;
let Ellipse = require(Path.join(Filepath.PrimitivesDir(), 'ellipse.js')).Ellipse;
let PrimitivesBaseClass = require(Path.join(Filepath.PrimitivesDir(), 'primitivesbaseclass.js')).PrimitivesBaseClass;

//---------------------------------

class Annulus extends PrimitivesBaseClass {
  constructor(builder) {
    super(builder);
  }

  /**
   * @override
   */
  static get Builder() {
    class Builder {
      constructor() {
        this.name = 'Annulus';
        this.args = {};
      }

      /**
       * @param {Coordinates} coordinates 
       */
      center(coordinates) {
        this.args.center = coordinates;
        return this;
      }

      /**
       * @param {number} n Length of the inner radius.
       */
      minorRadius(n) {
        this.args.minorRadius = n;
        return this;
      }

      /**
       * @param {number} n Length of the outer radius.
       */
      majorRadius(n) {
        this.args.majorRadius = n;
        return this;
      }

      /**
       * @param {Color} color The color of the annulus.
       */
      color(color) {
        this.args.color = color;
        return this
      }

      /**
       * @param {Color} color The color of the outlines making up the major and minor radii. (Optional)
       */
      strokeColor(color) {
        this.args.strokeColor = color;
        return this;
      }

      /**
       * @param {number} n Width of the outlines making up the major and minor radii. Larger values produce thicker lines. (Optional)
       */
      strokeWidth(n) {
        this.args.strokeWidth = n;
        return this;
      }

      /**
       * @param {Color} color The color used to fill in the empty space inside the annulus. (Optional)
       */
      fillColor(color) {
        this.args.fillColor = color;
        return this;
      }

      /**
       * @param {Offset} offset
       */
      offset(offset) {
        this.args.offset = offset;
        return this;
      }

      build() {
        return new Annulus(this);
      }
    }
    return new Builder();
  }

  /** 
   * @override
   */
  Args() {
    let args = [];

    // Compute offset center

    let offsetX = this.args.center.args.x;
    let offsetY = this.args.center.args.y;

    if (this.args.offset) {
      offsetX += this.args.offset.args.x;
      offsetY += this.args.offset.args.y;
    }

    let offsetCenter = Coordinates.Builder
      .x(offsetX)
      .y(offsetY)
      .build();

    // Minor outline

    let minorEdge = Coordinates.Builder
      .x(offsetCenter.args.x + this.args.minorRadius)
      .y(offsetCenter.args.y)
      .build();

    let minorCircle = Circle.Builder
      .center(offsetCenter)
      .edge(minorEdge)
      .strokeColor(this.args.strokeColor)
      .strokeWidth(this.args.strokeWidth)
      .build();

    // Major outline

    let majorEdge = Coordinates.Builder
      .x(offsetCenter.args.x + this.args.majorRadius)
      .y(offsetCenter.args.y)
      .build();

    let majorCircle = Circle.Builder
      .center(offsetCenter)
      .edge(majorEdge)
      .strokeColor(this.args.strokeColor)
      .strokeWidth(this.args.strokeWidth)
      .build();

    // Fill color (background) (Same as major circle but solid colored)

    if (this.args.fillColor) {
      let fillColorCircle = Circle.Builder
        .center(offsetCenter)
        .edge(majorEdge)
        .strokeColor(this.args.strokeColor)
        .strokeWidth(this.args.strokeWidth)
        .fillColor(this.args.fillColor)
        .build();

      args = args.concat(fillColorCircle.Args());
    }

    // Donut

    let ellipse = Ellipse.Builder
      .center(offsetCenter)
      .width(this.args.majorRadius + this.args.minorRadius)
      .height(this.args.majorRadius + this.args.minorRadius)
      .strokeColor(this.args.color)
      .strokeWidth(this.args.majorRadius - this.args.minorRadius)
      .angleStart(0)
      .angleEnd(360)
      .build();

    args = args.concat(ellipse.Args()).concat(majorCircle.Args()).concat(minorCircle.Args());

    return args;
  }

  /**
   * @override
   */
  Errors() {
    let params = Annulus.Parameters();
    let errors = [];
    let prefix = 'ANNULUS_SHAPE_ERROR';

    // Check required args

    let centerErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Center')
      .condition(
        new Err.ObjectCondition.Builder(this.args.center)
          .typeName('Coordinates')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (centerErr)
      errors.push(centerErr);

    let minorRadiusErr = Err.ErrorMessage.Build
      .prefix(prefix)
      .varName('Minor radius')
      .condition(
        new Err.NumberCondition.Builder(this.args.minorRadius)
          .isInteger(true)
          .min(params.minorRadius.min)
          .build()
      )
      .build()
      .String();

    if (minorRadiusErr)
      errors.push(minorRadiusErr);

    let majorRadiusErr = Err.ErrorMessage.Build
      .prefix(prefix)
      .varName('Major radius')
      .condition(
        new Err.NumberCondition.Builder(this.args.majorRadius)
          .isInteger(true)
          .min(params.majorRadius.min)
          .build()
      )
      .build()
      .String();

    if (majorRadiusErr)
      errors.push(majorRadiusErr);

    let colorErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Color')
      .condition(
        new Err.ObjectCondition.Builder(this.args.color)
          .typeName('Color')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (colorErr)
      errors.push(colorErr);

    // Check optional args

    if (this.args.strokeColor) {
      let strokeColorErr = Err.ErrorMessage.Builder
        .prefix(prefix)
        .varName('Stroke color')
        .condition(
          new Err.ObjectCondition.Builder(this.args.color)
            .typeName('Color')
            .checkForErrors(true)
            .build()
        )
        .build()
        .String();

      if (strokeColorErr)
        errors.push(strokeColorErr);
    }

    if (this.args.strokeWidth) {
      let strokeWidthErr = Err.ErrorMessage.Build
        .prefix(prefix)
        .varName('Stroke width')
        .condition(
          new Err.NumberCondition.Builder(this.args.strokeWidth)
            .isInteger(true)
            .min(params.strokeWidth.min)
            .build()
        )
        .build()
        .String();

      if (strokeWidthErr)
        errors.push(strokeWidthErr);
    }

    if (this.args.fillColor) {
      let fillColorErr = Err.ErrorMessage.Builder
        .prefix(prefix)
        .varName('Fill color')
        .condition(
          new Err.ObjectCondition.Builder(this.args.color)
            .typeName('Color')
            .checkForErrors(true)
            .build()
        )
        .build()
        .String();

      if (fillColorErr)
        errors.push(fillColorErr);
    }

    return errors;
  }

  /**
   * @override
   */
  static Parameters() {
    return {
      center: {
        type: 'Inputs.Coordinates',
        required: true
      },
      minorRadius: {
        type: 'number',
        subtype: 'integer',
        min: 1,
        required: true
      },
      majorRadius: {
        type: 'number',
        subtype: 'integer',
        min: 1,
        required: true
      },
      color: {
        type: 'Inputs.Color',
        required: true
      },
      strokeColor: {
        type: 'Inputs.Color',
        required: false
      },
      strokeWidth: {
        type: 'number',
        subtype: 'integer',
        min: 1,
        required: false
      },
      fillColor: {
        type: 'Inputs.Color',
        required: false
      },
      offset: {
        type: 'Inputs.Offset',
        required: false
      }
    };
  }
}

//-----------------------------
// EXPORTS

exports.Annulus = Annulus;