❤
npm
Sign UpSign In

This package has been deprecated

Author message:

WARNING: This package has been renamed to bitdraw. Please reinstall using npm install bitdraw instead.

graphical-engine

0.1.7 • Public • Published

graphical-engine

A simple 2D drawing library to ease the use of the HTML5 Canvas API. Made with Typescript.

Table of contents

  1. Installation
  2. Usage
  3. Documentation
  4. License

Installation

Open a command prompt or terminal and run npm install graphical-engine or yarn add graphical-engine

Usage

Along with the <script> tag/s containing your bundled code, you will need a canvas element with an id of #canvas. You can use the following HTML template for new projects:

<!DOCTYPE html>
<html>
	<head>
		<title>graphical-engine Example</title>
	</head>
	<body>
		<canvas id="canvas"></canvas>
		<script src="bundle.js"></script>
	</body>
</html>

Documentation

  1. Drawing Methods
  2. Utility Methods
  3. Globals
  4. Utilities

Drawing Methods

background(width, height, color)

  • parameters:
    • width - <number> The new canvas width.
    • height - <number> The new canvas height.
    • color - <Color> The new canvas color.
  • description:
    • This method resizes the canvas to the specified size, and simply draws a rectangle covering the entire canvas with the specified fill color.

stroke(loc1, loc2, color, width?)

  • parameters:
    • loc1 - <Vector2> The first point.
    • loc2 - <Vector2> The second point.
    • color - <Color> The color of the line.
    • width - <?number> The width of the line in pixels. 1 by default.
  • description:
    • This methods draws a line connecting the 2 supplied vertices.

circle(loc, radius, color, fill, width?)

  • parameters:
    • loc - <Vector2> The central vertex of the circle.
    • radius - <number> The radius of the circle in pixels.
    • color - <Color> The color of the circle.
    • fill - <boolean> Whether the circle should be filled.
    • width - <?number> The width of the circle border in pixels. 1 by default.
  • description:
    • This method draws a circle that can be filled or transparent with a border.

arc(loc, radius, color, startAngle, endAngle, fill, width?)

  • parameters:
    • loc - <Vector2> The center of the arc.
    • radius - <number> The radius of the arc in pixels.
    • color - <Color> The color of the arc.
    • startAngle - <number> The starting angle of the arc in radians.
    • endAngle - <number> The ending angle of the arc in radians.
    • fill - <boolean> Whether the arc should be filled.
    • width - <?number> The width of the arc border in pixels. 1 by default.
  • description:
    • This method draws a circle sector (a 'slice of pie' shape). The starting and ending angles are in a clockwise order.

rect(loc1, loc2, color, fill, width?)

  • parameters:
    • loc1 - <Vector2> The first vertex of the rectangle.
    • loc2 - <Vector2> The vertex opposite/diagonal to the first vertex.
    • color - <Color> The color of the rectangle.
    • fill - <boolean> Whether the rectangle should be filled.
    • width - <?number> The width of the rectangle border in pixels. 1 by default.
  • description:
    • This method draws a rectangle that can be filled or transparent with a border.

triangle(loc1, loc2, loc3, color, fill, width?)

  • parameters:
    • loc1 - <Vector2> The first vertex of the triangle.
    • loc2 - <Vector2>The second vertex of the triangle.
    • loc2 - <Vector2> The third vertex of the triangle.
    • color - <Color> The color of the triangle.
    • fill - <boolean> Whether the triangle should be filled.
    • width - <?number> The width of the triangle border in pixels. 1 by default.
  • description:
    • This function draws a triangle connecting the 3 provided vertices. It can be filled or transparent with a border. The order of the vertices does not matter.

Utility Methods

clear()

  • description:
    • This function simply calls background(), except the arguments are always the current canvas width and height, and the color used in the last background()call. It is used to clear the canvas.

center(absolute?)

  • parameters:
    • absolute - <?boolean> Whether the element should be centered absolutely, or use margin: auto; (in a flex parent). true by default.
  • description:
    • This function is purely a DOM manipulation function: it centers the canvas element.

setup(callback)

  • parameters:
    • callback - <function> The callback that gets executed upon app startup.
  • description:
    • The callback passed to this method is called once, on app startup. This is initialization and DOM methods should be ideally called, for performance reasons.

update(callback)

  • parameters:
    • callback - <function(number)> The callback that gets executed every frame. It recieves deltaTime; the number of miliseconds between the previous and last frame.
  • description:
    • This function initialises the main app loop. The provided callback is called every frame with the number of miliseconds between the previous and last frame.

Globals

canvas - <HTMLCanvasElement>

The canvas element.

ctx - <CanvasRenderingContext2D>

The 2D canvas rendering context.

CANVAS_WIDTH - <number>

The current width of the canvas element.

CANVAS_HEIGHT - <number>

The current height of the canvas element.

Utilities

class: Vector2

A 2D vector class that contains useful methods for creating and manipulating vectors.

Properties:

  • x <number> - The X coordinate of the vector.
  • y <number> - The Y coordinate of the vector.

Methods:

  • static Vector2.from(v)

    • Creates a new vector from the coordinates of the supplied vector.
    • param v - <Vector2> A vector.
    • returns <Vector2> - A new vector.

  • getDirection()

    • Returns the angle from the X-axis to the vector.
    • returns <number> - Angle in radians.

  • setDirection(radians)

    • Sets the direction of the vector.
    • param radians - <number> Angle in radians.

  • getMagnitude()

    • Gets the length of a vector from the origin.
    • returns <number> - Length of vector.

  • setMagnitude(magnitude)

    • Sets the vector's length.
    • param magnitude - <number> The number to set the vectors magnitude to.

  • add(v)

    • Returns the result of adding two vectors together.
    • param v - <Vector2> Another vector.
    • returns <Vector2> - A new vector.

  • addAndMutate(v)

    • Adds the argument vector to this vector.
    • param v - <Vector2> Another vector.

  • subtract(v)

    • Returns the result of subtracting the argument vector from this vector.
    • param v - <Vector2> Another vector.
    • returns <Vector2> - A new vector.

  • subtractAndMutate(v)

    • Subtracts the argument vector from this vector.
    • param v - <Vector2> Another vector.

  • multiply(scalar)

    • Returns the result of multiplying this vector by the provided scalar.
    • param scalar - <number> The number by which to multiply this vector.
    • returns <Vector2> - A new vector.

  • multiplyAndMutate(scalar)

    • Multiplies this vector by the provided number.
    • param scalar - <number> The number by which to multiply this vector.

  • divide(scalar)

    • Returns the result of dividing this vector by the provided number.
    • param scalar - <number> The number by which to divide this vector.
    • returns <Vector2> - A new vector.

  • divideAndMutate(scalar)

    • Divides this vector by the provided number.
    • param scalar - <number> The number by which to divide this vector.

  • absolute()

    • Returns an absolute value of this vector. This essentially puts the vector into the first quadrant of the coordinate plane.
    • returns <Vector2> - An absolute vector.

  • absoluteAndMutate()

    • Makes this vector absolute.

  • copy()

    • Returns a vector identical to this one.
    • returns <Vector2> - A new vector.

  • toString()

    • Returns a string representation of this vector.
    • returns <string> - A string representing this vector.

  • toArray()

    • Returns an array representation of this vector.
    • returns <Array<number>> - An array representing this vector.

  • toObject()

    • Returns an object representation of this vector.
    • returns <Object> - An object representing this vector.

  • set(v)

    • Sets this vector's coordinates to that of another vector.
    • param v - <Vector2> Another vector.

  • setCoords(x, y)

    • Sets this vector's X and Y coordinates the supplied parameters.
    • param x - <number> The X coordinate.
    • param y - <number> The Y coordinate.

  • normalise()

    • Returns the result of normalising this vector.
    • returns <Vector2> - A normalised vector.

  • normaliseAndMutate()

    • Normalises this vector.

  • normal(clockwise?)

    • Returns the normal of this vector.
    • param clockwise - <?boolean> Whether to return the clockwise normal of this vector. false by default.
    • returns <Vector2> - A normal vector.

class: Color

An RGB/hex color class that contains useful methods for translating color formats.

Properties:

Methods:

  • static Color.RGBtoHex(r, g, b)

    • A helper method that converts an RGB color value to a Hex color value.
    • param r - <number> Red.
    • param g - <number> Green.
    • param b - <number> Blue.
    • returns <string> - A Hex color value string.

  • static Color.HexToRGB(hex)

    • A helper method that converts a Hex color value to an RGB color value.
    • param hex - <number> A hex color value string.
    • returns <Object> - An object representing an RGB color value. Has r, g, b, and a properties.

  • getHex()

    • Returns a Hex string representation of this Color object.
    • returns <string> - A Hex color value string.

  • getRGB()

    • Returns an RGB string representation of this Color object.
    • returns <string> - An RGB color value string.

  • getRGBA()

    • Returns an RGBA string representation of this Color object.
    • returns <string> - An RGBA color value string.

  • setRGB(r, g, b, a?)

    • Sets the RGBA values of this Color object to the supplied RGBA parameters.
    • param r - <number> Red.
    • param g - <number> Green.
    • param b - <number> Blue.
    • param b - <?number> Alpha. 1 by default.

  • setHex(hex)

    • Sets the RGBA values of this Color object to the supplied hex string.
    • param hex - <number> A hex color value string.

License

This project and all of its code are under the permissive MIT license. You can read more here: LICENSE

Readme

Keywords

Package Sidebar

Install

npm i graphical-engine

Repository

github.com/mapokapo/graphical-engine

Homepage

github.com/mapokapo/graphical-engine#readme

Weekly Downloads

0

Version

0.1.7

License

MIT

Unpacked Size

85.2 kB

Total Files

19

Last publish

Collaborators

  • mapokapo
Try on RunKit
Report malware