graphics-ts/lib/Shape.d.ts

A porting of purescript-{canvas, free-canvas, drawing} featuring fp-ts

/**
 * Adapted from https://github.com/purescript-contrib/purescript-drawing
 *
 * @since 1.0.0
 */
import { HKT, Kind, Kind2, Kind3, URIS, URIS2, URIS3 } from 'fp-ts/lib/HKT'
import { Foldable, Foldable1, Foldable2, Foldable3 } from 'fp-ts/lib/Foldable'
import * as M from 'fp-ts/lib/Monoid'
/**
 * Represents an angle specified in degrees.
 *
 * @category model
 * @since 1.0.0
 */
export interface Degrees {
  readonly _tag: 'Degrees'
  /**
   * The angle in degrees.
   */
  readonly degrees: number
}
/**
 * Represents an angle specified in radians.
 *
 * @category model
 * @since 1.0.0
 */
export interface Radians {
  readonly _tag: 'Radians'
  /**
   * The angle in radians.
   */
  readonly radians: number
}
/**
 * Represents an angle specified in either degrees or radians.
 *
 * @category model
 * @since 1.0.0
 */
export declare type Angle = Degrees | Radians
/**
 * A single point consisting of `x` and `y` coordinates on a two-dimensional plane.
 *
 * @category model
 * @since 1.0.0
 */
export interface Point {
  /**
   * The x-axis coordinate.
   */
  readonly x: number
  /**
   * The y-axis coordinate.
   */
  readonly y: number
}
/**
 * An arc with center coordinates `x` and `y`, radius `r`, starting and ending angles `start` and `end`,
 * and travels in the direction given by `anticlockwise` (defaulting to clockwise)
 *
 * @category model
 * @since 1.0.0
 */
export interface Arc {
  readonly _tag: 'Arc'
  /**
   * The position of the center of the arc on the x-axis.
   */
  readonly x: number
  /**
   * The position of the center of the arc on the y-axis.
   */
  readonly y: number
  /**
   * The radius of the arc.
   */
  readonly r: number
  /**
   * The starting angle of the arc.
   */
  readonly start: number
  /**
   * The ending angle of the arc.
   */
  readonly end: number
  /**
   * If `true`, draws the `Arc` in a counter-clockwise direction. Defaults to `false` (clockwise).
   */
  readonly anticlockwise: boolean
}
/**
 * Represents a shape that is composed of several other shapes.
 *
 * @category model
 * @since 1.0.0
 */
export interface Composite {
  readonly _tag: 'Composite'
  /**
   * The list of shapes that compose the composite shape.
   */
  readonly shapes: ReadonlyArray<Shape>
}
/**
 * An elliptical arc centered at (`x`, `y`) with the radii radiusX and radiusY specified by `rx` and `ry`.
 * The path starts at startAngle and ends at endAngle, specified by `start` and `end`, with the specified
 * `rotation` and travels in the direction given by `anticlockwise` (defaulting to clockwise).
 *
 * @category model
 * @since 1.0.0
 */
export interface Ellipse {
  readonly _tag: 'Ellipse'
  /**
   * The position of the center of the ellipse on the x-axis.
   */
  readonly x: number
  /**
   * The position of the center of the ellipse on the y-axis.
   */
  readonly y: number
  /**
   * The major-axis radius of the ellipse.
   */
  readonly rx: number
  /**
   * The minor-axis radius of the ellipse.
   */
  readonly ry: number
  /**
   * The starting angle of the arc.
   */
  readonly start: number
  /**
   * The ending angle of the arc.
   */
  readonly end: number
  /**
   * The rotation of the ellipse.
   */
  readonly rotation: number
  /**
   * If `true`, draws the `Ellipse` in a counter-clockwise direction. Defaults to `false` (clockwise).
   */
  readonly anticlockwise: boolean
}
/**
 * A path is a list of points joined by line segments.
 *
 * @category model
 * @since 1.0.0
 */
export interface Path {
  readonly _tag: 'Path'
  /**
   * Indicates if the path is closed or open.
   */
  readonly closed: boolean
  /**
   * The list of points that make up the path.
   */
  readonly points: ReadonlyArray<Point>
}
/**
 * Represents a rectangle with top-left corner coordinates at `x` and `y`.
 *
 * @category model
 * @since 1.0.0
 */
export interface Rect {
  readonly _tag: 'Rect'
  /**
   * The position of the top-left corner of the rectangle on the x-axis.
   */
  readonly x: number
  /**
   * The position of the top-left corner of the rectangle on the x-axis.
   */
  readonly y: number
  /**
   * The width of the rectangle.
   */
  readonly width: number
  /**
   * The height of the rectangle.
   */
  readonly height: number
}
/**
 * Represents a shape that can be drawn.
 *
 * @category model
 * @since 1.0.0
 */
export declare type Shape = Arc | Composite | Ellipse | Path | Rect
/**
 * Constructs an angle specified in degrees.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const degrees: (degrees: number) => Degrees
/**
 * Constructs an angle specified in degrees.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const radians: (radians: number) => Radians
/**
 * Converts an angle into radians for use with the canvas.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const angle: (angle: Angle) => number
/**
 * Constructs a `Point` from x and y coordinates.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const point: (x: number, y: number) => Point
/**
 * Constructs an `Arc` shape.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const arc: (x: number, y: number, r: number, start: Angle, end: Angle, anticlockwise?: boolean) => Arc
/**
 * Constructs an `Arc` that forms a circle shape.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const circle: (x: number, y: number, r: number) => Arc
/**
 * Constructs a `Composite` shape.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const composite: (shapes: ReadonlyArray<Shape>) => Composite
/**
 * Constructs an `Ellipse` shape.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const ellipse: (
  x: number,
  y: number,
  rx: number,
  ry: number,
  rotation: Angle,
  start: Angle,
  end: Angle,
  anticlockwise?: boolean
) => Ellipse
/**
 * Constructs a closed `Path` shape from a `Foldable` of `Point`s.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare function closed<F extends URIS3>(foldable: Foldable3<F>): <E, A>(fa: Kind3<F, E, A, Point>) => Path
export declare function closed<F extends URIS2>(foldable: Foldable2<F>): <A>(fa: Kind2<F, A, Point>) => Path
export declare function closed<F extends URIS>(foldable: Foldable1<F>): (fa: Kind<F, Point>) => Path
export declare function closed<F>(F: Foldable<F>): (fa: HKT<F, Point>) => Path
/**
 * Constructs an open `Path` shape from a `Foldable` of `Point`s.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare function path<F extends URIS3>(foldable: Foldable3<F>): <E, A>(fa: Kind3<F, E, A, Point>) => Path
export declare function path<F extends URIS2>(foldable: Foldable2<F>): <A>(fa: Kind2<F, A, Point>) => Path
export declare function path<F extends URIS>(foldable: Foldable1<F>): (fa: Kind<F, Point>) => Path
export declare function path<F>(F: Foldable<F>): (fa: HKT<F, Point>) => Path
/**
 * Constructs a `Rectangle` shape.
 *
 * @category constructors
 * @since 1.0.0
 */
export declare const rect: (x: number, y: number, width: number, height: number) => Rect
/**
 * The `Monoid` instance for a `Path`.
 *
 * @category instances
 * @since 1.0.0
 */
export declare const monoidPath: M.Monoid<Path>