# @sakitam-gis/vis-engine

> A sample gl render engine toolkit.

Latest version **1.5.3** (published 2024-03-23) · BSD 3-Clause license · 0 weekly downloads

## Install

```sh
npm install @sakitam-gis/vis-engine
pnpm add @sakitam-gis/vis-engine
yarn add @sakitam-gis/vis-engine
bun add @sakitam-gis/vis-engine
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.5.3 |
| Published | 2024-03-23 |
| First published | 2023-01-28 |
| Weekly downloads | 0 |
| License | BSD 3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 14.18.1 |
| Dependencies | 2 |
| Unpacked size | 2.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | sakitam-fdd |
| Maintainers | sakitam-gis-owner, sakitam-fdd |
| Keywords | 3d, webgl, vis, three |

## Links

- npm: https://www.npmjs.com/package/@sakitam-gis/vis-engine
- Repository: https://github.com/sakitam-gis/vis-engine
- Homepage: https://github.com/sakitam-gis/vis-engine#readme
- Issues: https://github.com/sakitam-gis/vis-engine/issues
- npm.io page: https://npm.io/package/@sakitam-gis/vis-engine

## Dependencies (2)

- [colord](https://npm.io/package/colord.md) ^2.9.3
- [gl-matrix](https://npm.io/package/gl-matrix.md) ^3.4.3

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.5.3 (latest) — 2024-03-23
- 1.5.2 — 2024-01-17
- 1.5.1 — 2023-11-19
- 1.5.0 — 2023-04-24
- 1.4.9 — 2023-03-25
- 1.4.8 — 2023-03-19
- 1.4.7 — 2023-03-19
- 1.4.6 — 2023-03-15
- 1.4.5 — 2023-03-14
- 1.4.4 — 2023-03-14
- 1.4.3 — 2023-03-13
- 1.4.2 — 2023-03-08
- 1.4.1 — 2023-03-06
- 1.4.0 — 2023-02-07
- 1.3.2 — 2023-02-04
- … 10 more at https://npm.io/package/@sakitam-gis/vis-engine/versions

## README

## vis-engine

**vis-engine** 是一个简单的 `webgl` 渲染引擎工具包，它的设计受到了 [threejs](https://threejs.org/) 和 [ogl](https://github.com/oframe/ogl) 的启发。

它的定位介于 WebGL 封装和渲染引擎之间，包含了相机，Mesh 和 Shader 模块化以及 webgl 状态管理。

[![CI](https://github.com/sakitam-gis/vis-engine/actions/workflows/ci.yml/badge.svg)](https://github.com/sakitam-gis/vis-engine/actions/workflows/ci.yml) [![npm version](https://badgen.net/npm/v/@sakitam-gis/vis-engine)](https://npm.im/@sakitam-gis/vis-engine) [![npm downloads](https://badgen.net/npm/dm/@sakitam-gis/vis-engine)](https://npm.im/@sakitam-gis/vis-engine) [![Coverage Status](https://coveralls.io/repos/github/sakitam-gis/vis-engine/badge.svg?branch=master)](https://coveralls.io/github/sakitam-gis/vis-engine?branch=master)

### Install

```bash
yarn add @sakitam-gis/vis-engine -S

pnpm i @sakitam-gis/vis-engine

import { Renderer, Raf, Scene, PerspectiveCamera, Geometry, Mesh, Program } from '@sakitam-gis/vis-engine';
```

### Usage

#### Renderer

创建渲染器：

```ts
const renderer = new Renderer(canvas, {
  alpha: true,
});
```

#### Camera

创建相机：

```ts
const fov = 15;
const nearZ = 0.1;

const farZ = 100;
const camera = new PerspectiveCamera(fov, canvas.width / canvas.height, nearZ, farZ);
camera.position.z = fov;
```

#### Scene

创建场景：

```ts
const scene = new Scene();
```

#### Geometry

创建几何体对象：

```ts
const geometry = new Geometry(renderer, {
  position: {
    size: 3,
    data: new Float32Array([
      -1.6, 1.5, 0,
      -1, -1, 0,
      1, -1, 0,
      -1, -1, 0,
      1, -1, 0,
      1.6, 1.5, 0,
    ])
  },
});
```

#### Program

创建着色器资源：

```ts
const program = new Program(renderer, {
  vertexShader: `
    attribute vec2 uv;
    attribute vec3 position;
    uniform mat4 modelViewMatrix;
    uniform mat4 projectionMatrix;

    varying vec2 vUv;

    void main() {
        vUv = uv;

        gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);

        // gl_PointSize only applicable for gl.POINTS draw mode
        gl_PointSize = 5.0;
    }
    `,
  fragmentShader: `
    precision highp float;

    uniform float uTime;
    varying vec2 vUv;

    void main() {
        gl_FragColor.rgb = 0.5 + 0.3 * sin(vUv.yxx + uTime) + vec3(0.2, 0.0, 0.1);
        gl_FragColor.a = 1.0;
    }
    `,
  uniforms: {
    uTime: { value: 0 },
  },
});
```

#### Mesh

创建 Mesh：

```ts
const triangles = new Mesh(renderer, { mode: renderer.gl.TRIANGLES, geometry, program });
```

#### 添加到场景

```ts
scene.add(triangles);
```

#### 渲染

更新 uniform 变量并渲染场景：

```ts
const raf = new Raf((t) => {
  program.setUniform('uTime', t);
  renderer.render({ scene, camera });
});
```

### Types

vis-engine 完全采用 Typescript 编写

### Roadmap

📢注意：这是一个玩具项目，不是为了替代什么，但是我会尽力完善它，它最大的方向可能是和各类地图引擎结合例如 mapbox-gl/maptalks/leaflet 等，所以暂时没有固定的路线图。

- [mapbox-gl adapters](https://github.com/sakitam-gis/vis-engine/tree/master/adapters/mapbox)
- [maptalks adapters](https://github.com/sakitam-gis/vis-engine/tree/master/adapters/maptalks)

### License

[BSD 3-Clause](https://github.com/sakitam-gis/vis-engine/LICENSE)

---
_Source: https://npm.io/package/@sakitam-gis/vis-engine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
