jgraphics v1.1.3

JGraphics

A simple graphics tool, for react

Example Usage

import React, { Component } from 'react'
import JGraphics from "jgraphics"

class MyGame extends JGraphics {
    // Setup is called once
    setup(){ /* Any JGraphic method can be used here */ }

    // Loop is called many times based on the fps
    loop(delta){ /* Any JGraphic method can be used here */ }
}

export default class App extends Component {
  render() {
    return (
      <div className="App">
        { /* Shown below are the default props, any can be left out */ }
        <MyGame fps={60} id="jgraphic-panel" width="800" height="600"/>
        { /* Be careful no two panels have the same ID */ }
      </div>
    );
  }
}

Methods

View Methods

Set Dimensions

function setDimensions(width, height) Sets the dimensions used for rendering things. A 1x1 square will look much bigger in a 10x10 panel then a 100x100 panel Usage: this.view.setDimensions(80, 60)

Set Center

function setCenter(x, y) Sets the center of the view, by default it is (0, 0) Usage: this.view.setCenter(40, 30)

Is Y Axis Up Positive

function isYAxisUpPositive(bool) If true, it will set the y axis so that higher up the screen is higher coordinates. Older graphics systems sometimes had the top left corner as (0, 0). For that effect, you would need to set this false. Usage: this.view.isYAxisUpPositive(true)

Graphics Methods

Set Mode

function setMode(mode) Switch between line and fill mode. Is fill mode by default Usage: this.draw.setMode(this.draw.MODE_FILL) Usage: this.draw.setMode(this.draw.MODE_LINE)

Background

function background(color) Sets the background color. You may want to call this at the start of each loop. Color may be any valid html color. Eg) "blue", "#0099cc", "rgb(0, 100, 200)" Usage: this.draw.background("blue")

Ellipse

function ellipse(x, y, width, height [, color]) Draws an ellipse, centered on (x+width/2, y+height/2). If no colour is provided, it will use the last used color, probably the background color. Respects the draw mode Usage: this.draw.ellipse(0, 0, 20, 20, "blue") Usage: this.draw.ellipse(0, 0, 20, 20)

Rectangle

function rectangle(x, y, width, height [, color]) Draws an rectangle, centered on (x+width/2, y+height/2). If no colour is provided, it will use the last used color, probably the background color. Respects the draw mode Usage: this.draw.rectangle(0, 0, 20, 20, "blue") Usage: this.draw.rectangle(0, 0, 20, 20)

Triangle

function triangle(x1, y1, x2, y2, x3, y3 [, color]) Draws a triangle, at the 3 points. If no colour is provided, it will use the last used color, probably the background color. Respects the draw mode

Usage: this.draw.triangle(0, 0, 1, 1, 1, 0, "#0099CC") Usage: this.draw.triangle(0, 0, 2, 2, 2, 0)

Image

function image(imgPath, x, y, width, height) Draws an image, centered on (x+width/2, y+height/2). Images should be loaded first with the loadImage function. If the image is not yet loaded, nothing will be drawn Usage: this.draw.image(require("./logo.png"), 10, 10, 10, 10)

Load Image

function loadImage(imgPath) Loads an image. This is not instant. It is recommended to load images in setup, then draw them in loop Usage: this.draw.image(require("./logo.png"), 10, 10, 10, 10)

Load Image

function isImageLoaded(imgPath) returns true if the image is loaded Usage: this.draw.isImageLoaded(require("./logo.png"))

Input Methods

Is Key Pressed

function isKeyPressed(key) Returns a boolean which indicates if the key is pressed. A list of key values can be seen here. Key Values Usage: this.input.isKeyPressed('w')

On Key Down

function onKeyDown(key, handler) Sets an event listener for keydown events. A list of key values can be seen here. Key Values Usage: this.input.onKeyDown('w', () => { console.log("Aaaahhhh") })

On Key Up

function onKeyUp(key, handler) Sets an event listener for keyup events. A list of key values can be seen here. Key Values Usage: this.input.onKeyUp('w', () => { console.log("Aaaahhhh") })

onMouseClick

function onMouseClick(handler [, bounds]) Sets an event listener for mouse press events. Takes an option bounds argument, which specifies a region the mouse has to be within to trigger the event. The bounds argument must be an object with the following properties

{
    x: float,
    y: float,
    width: float,
    height: float,
}

Handler is passed through the x and y coordinates of the mouse Usage: this.input.onMouseClick('w', (x, y) => { console.log("The mouse was clicked at position " + x + " " + y) }) Usage: this.input.onMouseClick((x,y) => console.log(${x}:${y}), {x: 0, y: 0, width: 10, height: 10})

getMouse

function getMouse() Returns an object with information on the mouse position. The object is in the following form.

{
    x: float,
    y: float,
    isClicked: bool
}

Usage: this.input.getMouse()