/*
 * Copyright ©2019 Hal Perkins.  All rights reserved.  Permission is
 * hereby granted to students registered for University of Washington
 * CSE 331 for use solely during Spring Quarter 2019 for purposes of
 * the course.  No other use, copying, distribution, or modification
 * is permitted without prior written consent. Copyrights for
 * third-party components of this work must be honored.  Instructors
 * interested in reusing these course materials should contact the
 * author.
 */

package pathfinder.textInterface;

/**
 * Represents the different possible basis arrangements for a two-dimensional cartesian
 * coordinate space.
 */
public enum CoordinateProperties {

  /**
   * The x-coordinate increases in value in the rightward direction.
   * The y-coordinate increases in value in the upward direction.
   * <p>
   * This is the "standard" cartesian coordinate space in general mathematics.
   */
  INCREASING_UP_RIGHT,

  /**
   * The x-coordinate increases in value in the leftward direction.
   * The y-coordinate increases in value in the upward direction.
   */
  INCREASING_UP_LEFT,

  /**
   * The x-coordinate increases in value in the rightward direction.
   * The y-coordinate increases in value in the downward direction.
   * <p>
   * This is a commonly-used space for graphical operations where coordinates are measured from
   * the upper-left corner of some bounding box.
   */
  INCREASING_DOWN_RIGHT,

  /**
   * The x-coordinate increases in value in the leftward direction.
   * The y-coordinate increases in value in the downward direction.
   */
  INCREASING_DOWN_LEFT

}