PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.5.0

npm

2gl

WebGL library for 2GIS projects

Published11 Dec 2017
Direct dependencies19
Transitive dependenciesNot calculated

README

Current package documentation

2gl Build Status Coverage Status

Узкоспециализированная библиотека WebGL для использования в проектах 2GIS

Документация

  • Для работы с матрицами и векторами используется библиотека glMatrix
  • Работа с геометрическими объектами, например, Plane, Line3, Ray, взята из three.js

На данный момент может работать со следующими типами объектов для отображения:

  1. Basic mesh - меш, закрашивается в один цвет
  2. Complex mesh - меш, для которого можно установить: цвета для каждой из вершин, освещение, текстуру и определять для какой из вершин будет использоваться текстура
  3. Sprite - спрайт, к камере расположен всегда одной гранью, удалённость не влияет на размеры изображения
  4. MultiSprite - мультиспрайт представляет собой множество спрайтов, которые рисуются в один draw call

Examples

Установка

  • npm install 2gl

Подключение

Есть несколько способов подключения библиотеки:

  • Напрямую через тег, скрипт 2gl.js лежит в папке dist и содержит все компоненты библиотеки:
<script src="2gl.js"></script>
  • Если вы используете сборщики, например, browserify или webpack:
var dgl = require("2gl"); // CommonJS
import dgl from "2gl"; // ES6
  • Можно подключать только нужные компоненты для уменьшения размера:
var Mesh = require("2gl/Mesh");
var AmbientLight = require("2gl/lights/AmbientLight");

Development

  • npm install
  • npm start

Checking examples locally

  • Install http-server
  • Run http-server at the root project directory
  • Open http://localhost:8080/ and navigate to some *.html demo at the examples directory

Release

If you plan to release a new version from your branch

  • Bump version via npm version major | minor | patch
  • Merge your branch into master
  • Create a new release, this will run the release workflow

Beta-release

Beta-release is suitable to perform some checks/integrations with npm-package.

It releases the same npm package as a regular release, but in the beta tag, which do not update latest version on npm.

To make beta-release you should create a tag with a current version in package.json and suffix, e.g.

npm version 0.12.0-foo-bar

And then push tag.

git push --tags

Pushed tag will run the beta-release workflow.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 19

Native requirements
19 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@2gis/gl-matrix
Environment
{
  "local_name": "@2gis/gl-matrix",
  "alias": false,
  "peer_metadata": null
}
^2.4.1runtime
nyc
Environment
{
  "local_name": "nyc",
  "alias": false,
  "peer_metadata": null
}
^10.1.2development
jsdoc
Environment
{
  "local_name": "jsdoc",
  "alias": false,
  "peer_metadata": null
}
git://github.com/jsdoc3/jsdoc.gitdevelopment
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
^3.5.0development
sinon
Environment
{
  "local_name": "sinon",
  "alias": false,
  "peer_metadata": null
}
^1.17.2development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^4.5.0development
minami
Environment
{
  "local_name": "minami",
  "alias": false,
  "peer_metadata": null
}
git://github.com/Trufi/minami.gitdevelopment
dat-gui
Environment
{
  "local_name": "dat-gui",
  "alias": false,
  "peer_metadata": null
}
^0.5.0development
webpack
Environment
{
  "local_name": "webpack",
  "alias": false,
  "peer_metadata": null
}
^3.5.5development
babel-cli
Environment
{
  "local_name": "babel-cli",
  "alias": false,
  "peer_metadata": null
}
^6.26.0development
coveralls
Environment
{
  "local_name": "coveralls",
  "alias": false,
  "peer_metadata": null
}
^2.13.1development
babel-core
Environment
{
  "local_name": "babel-core",
  "alias": false,
  "peer_metadata": null
}
^6.26.0development
babel-loader
Environment
{
  "local_name": "babel-loader",
  "alias": false,
  "peer_metadata": null
}
^7.1.2development
chokidar-cli
Environment
{
  "local_name": "chokidar-cli",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
babel-register
Environment
{
  "local_name": "babel-register",
  "alias": false,
  "peer_metadata": null
}
^6.26.0development
babel-preset-env
Environment
{
  "local_name": "babel-preset-env",
  "alias": false,
  "peer_metadata": null
}
^1.6.0development
babel-plugin-istanbul
Environment
{
  "local_name": "babel-plugin-istanbul",
  "alias": false,
  "peer_metadata": null
}
^4.1.4development
babel-plugin-module-resolver
Environment
{
  "local_name": "babel-plugin-module-resolver",
  "alias": false,
  "peer_metadata": null
}
^2.7.1development
babel-plugin-add-module-exports
Environment
{
  "local_name": "babel-plugin-add-module-exports",
  "alias": false,
  "peer_metadata": null
}
^0.2.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "94413c7b42d513817f1b74a29e8f008554879cd5",
  "tarball": "https://registry.npmjs.org/2gl/-/2gl-0.5.0.tgz",
  "integrity": "sha512-6z37j8v2jIby08Y+AkZbKgJNYk8Hpwtx6jhMaaiVEOl1FA6Bmb23xRya3ODRpyhFEh9hprxrAJnMenewFzdfLw==",
  "signatures": [
    {
      "sig": "MEYCIQCwfGuzZIBjIciCfIfYJ8wgzYlFAKWEd7tYcJwxWcnJqQIhAKdTKSsJn+on2oo7F53/p7WTS/HCaFiH5Me8wVyiC2DK",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ]
}

Repository

PENDING
2gis/2gl

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:13 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:a88384e7ca36d86a50ab5c0ff9e35f59f20f084c23ba20bd6cd57d7a1fd45306

Other collected versions

0.13.313 Mar0.13.213 Mar0.13.113 Mar0.13.06 Mar0.12.0-beta-release6 Mar0.12.026 JanView all collected versions →