qualifiers/compass.ts

import {CompassQualifier} from "./gravity/qualifiers/compass/CompassQualifier.js";


/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description South center part (bottom center).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function south(): CompassQualifier {
  return new CompassQualifier('south');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description North center part (top center).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function north(): CompassQualifier {
  return new CompassQualifier('north');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description Middle east part (right).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function east(): CompassQualifier {
  return new CompassQualifier('east');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description Middle west part (left).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function west(): CompassQualifier {
  return new CompassQualifier('west');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description North west corner (top left).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function northWest(): CompassQualifier {
  return new CompassQualifier('north_west');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description North east corner (top right).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function northEast(): CompassQualifier {
  return new CompassQualifier('north_east');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description South west corner (bottom left).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function southWest(): CompassQualifier {
  return new CompassQualifier('south_west');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description South east corner (bottom right).
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function southEast(): CompassQualifier {
  return new CompassQualifier('south_east');
}

/**
 * @summary qualifier
 * @memberOf Qualifiers.Compass
 * @description The center of the image.
 * @return {Qualifiers.Compass.CompassQualifier} Compass
 */
function center(): CompassQualifier {
  return new CompassQualifier('center');
}




/**
 * @description Defines the focal Compass for certain methods of cropping.
 * @namespace Compass
 * @memberOf Qualifiers
 * @see Visit {@link Qualifiers.Gravity|Gravity} for an example
 */
class Compass {
  static north = north;
  static west = west;
  static east = east;
  static south =south;
  static center = center
  static northWest =northWest
  static southEast =southEast;
  static southWest = southWest;
  static northEast =northEast;
}


export {
  Compass,
  north,
  west,
  east,
  south,
  center,
  northWest,
  southEast,
  southWest,
  northEast
};