@gg-web-engine/matter 0.0.1

package/README.md

@@ -0,0 +1,13 @@
+<p align="center">
+  <img src="../../documentation/assets/logo.png" style="height: 400px; width:400px;" alt=''/>
+</p>
+
+## [Matter.js](https://github.com/liabru/matter-js) integration for [gg-web-engine](https://github.com/AndyGura/gg-web-engine), providing 2D physics simulation
+
+### Installation:
+1) make sure **@gg-web-engine/core** installed
+1) `npm install --save @gg-web-engine/matter`
+1) Add to your `tsconfig.json` in the record `compilerOptions.paths`:
+```json lines
+"matter-js": ["./node_modules/@gg-web-engine/matter/node_modules/matter-js"]
+```

package/dist/impl/gg-2d-body-factory.d.ts

@@ -0,0 +1,13 @@
+import { BodyShape2DDescriptor, IGg2dBodyFactory, Point2, Shape2DDescriptor } from '@gg-web-engine/core';
+import { Gg2dBody } from './gg-2d-body';
+export declare class Gg2dBodyFactory implements IGg2dBodyFactory<Gg2dBody, any> {
+    createRigidBody(descriptor: BodyShape2DDescriptor, transform?: {
+        position?: Point2;
+        rotation?: number;
+    }): Gg2dBody;
+    createTrigger(descriptor: Shape2DDescriptor, transform?: {
+        position?: Point2;
+        rotation?: number;
+    }): any;
+    private transformOptions;
+}

package/dist/impl/gg-2d-body-factory.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gg2dBodyFactory = void 0;
+const gg_2d_body_1 = require("./gg-2d-body");
+const matter_js_1 = require("matter-js");
+class Gg2dBodyFactory {
+    createRigidBody(descriptor, transform) {
+        var _a, _b;
+        let nativeBody = null;
+        switch (descriptor.shape.shape) {
+            case 'SQUARE':
+                nativeBody = matter_js_1.Bodies.rectangle(0, 0, descriptor.shape.dimensions.x, descriptor.shape.dimensions.y, this.transformOptions(descriptor.body));
+                break;
+            case 'CIRCLE':
+                nativeBody = matter_js_1.Bodies.circle(0, 0, descriptor.shape.radius, this.transformOptions(descriptor.body));
+                break;
+        }
+        if (!nativeBody) {
+            throw new Error(`Shape "${descriptor.shape}" not implemented for Matter.js`);
+        }
+        nativeBody.position = matter_js_1.Vector.create(((_a = transform === null || transform === void 0 ? void 0 : transform.position) === null || _a === void 0 ? void 0 : _a.x) || 0, ((_b = transform === null || transform === void 0 ? void 0 : transform.position) === null || _b === void 0 ? void 0 : _b.y) || 0);
+        nativeBody.angle = (transform === null || transform === void 0 ? void 0 : transform.rotation) || 0;
+        return new gg_2d_body_1.Gg2dBody(nativeBody);
+    }
+    createTrigger(descriptor, transform) {
+        throw new Error('Triggers not implemented for Matter.js');
+    }
+    transformOptions(options) {
+        const res = {
+            isStatic: options.dynamic !== undefined ? !options.dynamic : !options.mass,
+            mass: options.mass,
+            restitution: options.restitution,
+            friction: options.friction,
+        };
+        for (const key in res) {
+            if (res[key] === undefined) {
+                delete res[key];
+            }
+        }
+        return res;
+    }
+}
+exports.Gg2dBodyFactory = Gg2dBodyFactory;

package/dist/impl/gg-2d-body.d.ts

@@ -0,0 +1,19 @@
+import { IGg2dBody, Point2, Gg2dEntity } from '@gg-web-engine/core';
+import { Gg2dPhysicsWorld } from './gg-2d-physics-world';
+import { Body } from 'matter-js';
+export declare class Gg2dBody implements IGg2dBody {
+    nativeBody: Body;
+    get position(): Point2;
+    set position(value: Point2);
+    get rotation(): number;
+    set rotation(value: number);
+    get scale(): Point2;
+    name: string;
+    entity: Gg2dEntity | null;
+    constructor(nativeBody: Body);
+    clone(): Gg2dBody;
+    addToWorld(world: Gg2dPhysicsWorld): void;
+    removeFromWorld(world: Gg2dPhysicsWorld): void;
+    dispose(): void;
+    resetMotion(): void;
+}

package/dist/impl/gg-2d-body.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gg2dBody = void 0;
+const matter_js_1 = require("matter-js");
+class Gg2dBody {
+    constructor(nativeBody) {
+        this.nativeBody = nativeBody;
+        this.name = '';
+        this.entity = null;
+    }
+    get position() {
+        return this.nativeBody.position;
+    }
+    set position(value) {
+        matter_js_1.Body.translate(this.nativeBody, matter_js_1.Vector.create(value.x, value.y));
+    }
+    get rotation() {
+        return this.nativeBody.angle;
+    }
+    set rotation(value) {
+        this.nativeBody.angle = value;
+    }
+    get scale() {
+        // hmm, is it even possible to be different?
+        return { x: 1, y: 1 };
+    }
+    clone() {
+        // TODO
+        throw new Error('Gg2dBody.clone() not implemented for Matter.js');
+    }
+    addToWorld(world) {
+        matter_js_1.Composite.add(world.matterWorld, this.nativeBody);
+    }
+    removeFromWorld(world) {
+        matter_js_1.Composite.remove(world.matterWorld, this.nativeBody);
+    }
+    dispose() { }
+    resetMotion() {
+        matter_js_1.Body.setVelocity(this.nativeBody, { x: 0, y: 0 });
+        matter_js_1.Body.setAngularVelocity(this.nativeBody, 0);
+    }
+}
+exports.Gg2dBody = Gg2dBody;

package/dist/impl/gg-2d-physics-world.d.ts

@@ -0,0 +1,20 @@
+import { IGg2dPhysicsWorld, GgDebugPhysicsDrawer, Point2, Gg2dWorld } from '@gg-web-engine/core';
+import { World } from 'matter-js';
+import { Gg2dBodyFactory } from './gg-2d-body-factory';
+export declare class Gg2dPhysicsWorld implements IGg2dPhysicsWorld {
+    private matterEngine;
+    get matterWorld(): World | null;
+    readonly factory: Gg2dBodyFactory;
+    private _gravity;
+    get gravity(): Point2;
+    set gravity(value: Point2);
+    private _timeScale;
+    get timeScale(): number;
+    set timeScale(value: number);
+    get physicsDebugViewActive(): boolean;
+    init(): Promise<void>;
+    simulate(delta: number): void;
+    startDebugger(world: Gg2dWorld, drawer: GgDebugPhysicsDrawer<Point2, number>): void;
+    stopDebugger(): void;
+    dispose(): void;
+}

package/dist/impl/gg-2d-physics-world.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gg2dPhysicsWorld = void 0;
+const matter_js_1 = require("matter-js");
+const gg_2d_body_factory_1 = require("./gg-2d-body-factory");
+class Gg2dPhysicsWorld {
+    constructor() {
+        this.matterEngine = null;
+        this.factory = new gg_2d_body_factory_1.Gg2dBodyFactory();
+        this._gravity = { x: 0, y: 9.82 };
+        this._timeScale = 1;
+    }
+    get matterWorld() {
+        return this.matterEngine && this.matterEngine.world;
+    }
+    get gravity() {
+        return this._gravity;
+    }
+    set gravity(value) {
+        this._gravity = value;
+        if (this.matterEngine) {
+            this.matterEngine.gravity.x = this._gravity.x;
+            this.matterEngine.gravity.y = this._gravity.y;
+        }
+    }
+    get timeScale() {
+        return this._timeScale;
+    }
+    set timeScale(value) {
+        this._timeScale = value;
+    }
+    get physicsDebugViewActive() {
+        return false;
+    }
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.matterEngine = matter_js_1.Engine.create({ gravity: Object.assign(Object.assign({}, this._gravity), { scale: 0.0001 }) });
+        });
+    }
+    simulate(delta) {
+        matter_js_1.Engine.update(this.matterEngine, this._timeScale * delta);
+    }
+    startDebugger(world, drawer) {
+        // TODO
+        throw new Error('Matter.js DebugDrawer not implemented');
+    }
+    stopDebugger() {
+        // TODO
+        throw new Error('Matter.js DebugDrawer not implemented');
+    }
+    dispose() {
+        matter_js_1.Engine.clear(this.matterEngine);
+    }
+}
+exports.Gg2dPhysicsWorld = Gg2dPhysicsWorld;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './impl/gg-2d-body';
+export * from './impl/gg-2d-body-factory';
+export * from './impl/gg-2d-physics-world';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./impl/gg-2d-body"), exports);
+__exportStar(require("./impl/gg-2d-body-factory"), exports);
+__exportStar(require("./impl/gg-2d-physics-world"), exports);

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@gg-web-engine/matter",
+  "version": "0.0.01",
+  "description": "An attempt to create open source game engine for browser",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prettier-format": "prettier --config ../core/.prettierrc 'src/**/*.ts' --write",
+    "prepublish": "tsc",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AndyGura/gg-web-engine.git"
+  },
+  "keywords": [
+    "game-development",
+    "game-engine",
+    "game-engine-framework",
+    "gamedev"
+  ],
+  "author": "AndyGura",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/AndyGura/gg-web-engine/issues"
+  },
+  "homepage": "https://github.com/AndyGura/gg-web-engine#readme",
+  "dependencies": {
+    "@gg-web-engine/core": "^0.0.1",
+    "matter-js": "^0.18.0"
+  },
+  "devDependencies": {
+    "@types/matter-js": "^0.18.2",
+    "prettier": "^2.8.6",
+    "typescript": "~4.7.2"
+  }
+}

package/src/impl/gg-2d-body-factory.ts

@@ -0,0 +1,60 @@
+import { Body2DOptions, BodyShape2DDescriptor, IGg2dBodyFactory, Point2, Shape2DDescriptor } from '@gg-web-engine/core';
+import { Gg2dBody } from './gg-2d-body';
+import { Bodies, IBodyDefinition, Vector, Body } from 'matter-js';
+
+export class Gg2dBodyFactory implements IGg2dBodyFactory<Gg2dBody, any> {
+  createRigidBody(
+    descriptor: BodyShape2DDescriptor,
+    transform?: {
+      position?: Point2;
+      rotation?: number;
+    },
+  ): Gg2dBody {
+    let nativeBody: Body | null = null;
+    switch (descriptor.shape.shape) {
+      case 'SQUARE':
+        nativeBody = Bodies.rectangle(
+          0,
+          0,
+          descriptor.shape.dimensions.x,
+          descriptor.shape.dimensions.y,
+          this.transformOptions(descriptor.body),
+        );
+        break;
+      case 'CIRCLE':
+        nativeBody = Bodies.circle(0, 0, descriptor.shape.radius, this.transformOptions(descriptor.body));
+        break;
+    }
+    if (!nativeBody) {
+      throw new Error(`Shape "${descriptor.shape}" not implemented for Matter.js`);
+    }
+    nativeBody.position = Vector.create(transform?.position?.x || 0, transform?.position?.y || 0);
+    nativeBody.angle = transform?.rotation || 0;
+    return new Gg2dBody(nativeBody);
+  }
+
+  createTrigger(
+    descriptor: Shape2DDescriptor,
+    transform?: {
+      position?: Point2;
+      rotation?: number;
+    },
+  ): any {
+    throw new Error('Triggers not implemented for Matter.js');
+  }
+
+  private transformOptions(options: Partial<Body2DOptions>): IBodyDefinition {
+    const res: IBodyDefinition = {
+      isStatic: options.dynamic !== undefined ? !options.dynamic : !options.mass,
+      mass: options.mass,
+      restitution: options.restitution,
+      friction: options.friction,
+    };
+    for (const key in res) {
+      if ((res as any)[key] === undefined) {
+        delete (res as any)[key];
+      }
+    }
+    return res;
+  }
+}

package/src/impl/gg-2d-body.ts

@@ -0,0 +1,52 @@
+import { IGg2dBody, Point2, Gg2dEntity } from '@gg-web-engine/core';
+import { Gg2dPhysicsWorld } from './gg-2d-physics-world';
+import { Body, Composite, Vector } from 'matter-js';
+
+export class Gg2dBody implements IGg2dBody {
+  public get position(): Point2 {
+    return this.nativeBody.position;
+  }
+
+  public set position(value: Point2) {
+    Body.translate(this.nativeBody, Vector.create(value.x, value.y));
+  }
+
+  public get rotation(): number {
+    return this.nativeBody.angle;
+  }
+
+  public set rotation(value: number) {
+    this.nativeBody.angle = value;
+  }
+
+  public get scale(): Point2 {
+    // hmm, is it even possible to be different?
+    return { x: 1, y: 1 };
+  }
+
+  public name: string = '';
+
+  public entity: Gg2dEntity | null = null;
+
+  constructor(public nativeBody: Body) {}
+
+  clone(): Gg2dBody {
+    // TODO
+    throw new Error('Gg2dBody.clone() not implemented for Matter.js');
+  }
+
+  addToWorld(world: Gg2dPhysicsWorld): void {
+    Composite.add(world.matterWorld!, this.nativeBody);
+  }
+
+  removeFromWorld(world: Gg2dPhysicsWorld): void {
+    Composite.remove(world.matterWorld!, this.nativeBody);
+  }
+
+  dispose(): void {}
+
+  resetMotion(): void {
+    Body.setVelocity(this.nativeBody, { x: 0, y: 0 });
+    Body.setAngularVelocity(this.nativeBody, 0);
+  }
+}

package/src/impl/gg-2d-physics-world.ts

@@ -0,0 +1,59 @@
+import { IGg2dPhysicsWorld, GgDebugPhysicsDrawer, Point2, Gg2dWorld } from '@gg-web-engine/core';
+import { Engine, World } from 'matter-js';
+import { Gg2dBodyFactory } from './gg-2d-body-factory';
+
+export class Gg2dPhysicsWorld implements IGg2dPhysicsWorld {
+  private matterEngine: Engine | null = null;
+
+  public get matterWorld(): World | null {
+    return this.matterEngine && this.matterEngine.world;
+  }
+
+  public readonly factory: Gg2dBodyFactory = new Gg2dBodyFactory();
+
+  private _gravity: Point2 = { x: 0, y: 9.82 };
+  public get gravity(): Point2 {
+    return this._gravity;
+  }
+  public set gravity(value: Point2) {
+    this._gravity = value;
+    if (this.matterEngine) {
+      this.matterEngine.gravity.x = this._gravity.x;
+      this.matterEngine.gravity.y = this._gravity.y;
+    }
+  }
+
+  private _timeScale: number = 1;
+  public get timeScale(): number {
+    return this._timeScale;
+  }
+  public set timeScale(value: number) {
+    this._timeScale = value;
+  }
+
+  public get physicsDebugViewActive(): boolean {
+    return false;
+  }
+
+  async init(): Promise<void> {
+    this.matterEngine = Engine.create({ gravity: { ...this._gravity, scale: 0.0001 } });
+  }
+
+  simulate(delta: number): void {
+    Engine.update(this.matterEngine!, this._timeScale * delta);
+  }
+
+  startDebugger(world: Gg2dWorld, drawer: GgDebugPhysicsDrawer<Point2, number>): void {
+    // TODO
+    throw new Error('Matter.js DebugDrawer not implemented');
+  }
+
+  stopDebugger(): void {
+    // TODO
+    throw new Error('Matter.js DebugDrawer not implemented');
+  }
+
+  dispose(): void {
+    Engine.clear(this.matterEngine!);
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './impl/gg-2d-body';
+export * from './impl/gg-2d-body-factory';
+export * from './impl/gg-2d-physics-world';

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": "./src/",
+    "outDir": "./dist/",
+    "paths": {
+      "mini-signals": ["./node_modules/mini-signals/index.js"],
+      "path": ["./node_modules/path-browserify"],
+      "fs": ["./node_modules/fs-web"]
+    }
+  },
+  "include": ["*.ts", "**/*.ts"],
+}