imagemagick-async/im_modules/Inputs/LineSegments/smooth.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 LineSegmentBaseClass = require(Path.join(Filepath.LineSegmentsDir(), 'linesegmentbaseclass.js')).LineSegmentBaseClass;

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

class Smooth extends LineSegmentBaseClass {
  constructor(builder) {
    super(builder);
  }

  /**
   * @override
   * (Used with CubizBezier or QuadraticBezier)
   */
  static get Builder() {
    class Builder {
      constructor() {
        this.name = 'Smooth';
        this.args = {};
      }

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

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

      /**
       * @param {boolean} bool (Optional)
       */
      isQuadraticBezier(bool) {
        this.args.isQuadraticBezier = bool;
        return this;
      }

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

      build() {
        return new Smooth(builder);
      }
    }
    return new Builder();
  }

  /**
   * @override
   */
  String() {
    let char = 'S';
    if (this.args.isQuadraticBezier)
      char = 'T';

    let cX = this.args.control.args.x;
    let cY = this.args.control.args.y;

    if (this.args.offset) {
      cX += this.args.offset.args.x;
      cY += this.args.offset.args.y;
    }

    return `${char} ${cX},${cY} ${this.args.endPoint.String()}`;
  }

  /**
   * @override
   */
  Errors() {
    let errors = [];
    let prefix = 'SMOOTH_LINE_SEGMENT_ERROR';

    // Check required args

    let controlErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Control')
      .condition(
        new Err.ObjectCondition.Build(this.args.control)
          .typeName('Coordinates')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (controlErr)
      errors.push(controlErr);

    let endPointErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('End point')
      .condition(
        new Err.ObjectCondition.Builder(this.args.endPoint)
          .typeName('Coordinates')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (endPointErr)
      errors.push(endPointErr);

    // Check optional args


    if (this.args.isQuadraticBezier) {
      let isQuadraticBezierErr = Err.ErrorMessage.Builder
        .prefix(prefix)
        .varName('Quadratic bezier flag')
        .condition(
          new Err.BooleanCondition(this.args.isQuadraticBezier)
            .build()
        )
        .build()
        .String();

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

    return errors;
  }

  /**
   * @override
   */
  static Parameters() {
    return {
      control: {
        type: 'Inputs.Coordinates',
        required: true
      },
      endPoint: {
        type: 'Inputs.Coordinates',
        required: true
      },
      isQuadraticBezier: {
        type: 'boolean',
        default: false
      },
      offset: {
        type: 'Inputs.Offset',
        required: false
      }
    };
  }
}

//----------------------------
// EXPORTs

exports.Smooth = Smooth;