Skip to content
Visualization Toolkit for the Web
JavaScript Python HTML GLSL Other
Branch: master
Clone or download
jourdain Merge pull request #1340 from BotellaA/patch-1
Fix OpenglRenderWindow::SetContainer
Latest commit 39863cb Feb 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Data style: 💄 Remove improperly-committed .DS_Store file Oct 4, 2018
Documentation doc(typo): Fix documentation and comments typos identified using code… Feb 24, 2020
Examples doc(typo): Fix documentation and comments typos identified using code… Feb 24, 2020
Sources Merge pull request #1340 from BotellaA/patch-1 Feb 24, 2020
Utilities doc(typo): Fix documentation and comments typos identified using code… Feb 24, 2020
dist fix(Documentation): Update external script usage Nov 1, 2018
.babelrc fix(IE11): Add script entry with polyfill Nov 1, 2018
.browserslistrc feat(ToolChain): Update to kw-web-suite 8 to bring babel 7 and more w… Nov 1, 2018
.editorconfig chore(linter): Update config to provide vtk.js alias Nov 1, 2018
.eslintrc.js chore(linter): Update config to provide vtk.js alias Nov 1, 2018
.gitattributes build(windows): Fix git eol for windows to be lf Jan 8, 2018
.gitignore ci(Azure): Add initial configuration Mar 1, 2019
.npmignore fix(size): npmignore /Data and */test/* Apr 27, 2018
.travis.yml chore(travis): Update travis to use xenial Sep 12, 2019
BREAKING_CHANGES.md doc(typo): Fix documentation and comments typos identified using code… Feb 24, 2020
CONTRIBUTING.md doc(typo): Fix documentation and comments typos identified using code… Feb 24, 2020
Copyright.txt Initial structure May 2, 2016
LICENSE Initial structure May 2, 2016
README.md doc(Citation): Add Zenodo DOI badge Jan 15, 2020
karma.conf.js ci(Azure): Add initial configuration Mar 1, 2019
package-lock.json fix(DracoReader): Provide correct argument Feb 19, 2020
package.json fix(Dependencies): Bump jszip to v3.2.2 Oct 28, 2019
postcss.config.js fix(css): Use *.module.css convention instead of *.mcss Nov 1, 2018
prettier.config.js chore(conf): Update config format Jan 5, 2018
webpack.common.js feat(vtkDracoReader): Add Draco reader Sep 19, 2019
webpack.dev.js fix(IE11): Add script entry with polyfill Nov 1, 2018
webpack.prod.js fix(bundle): Create a lite version and improved generated bundle Nov 1, 2018
webpack.settings.js feat(Rendering): add support for multiple component vtkVolume Jun 3, 2019

README.md

VTK.js - The Visualization Toolkit for JavaScript

Build Status Build Status Dependency Status semantic-release npm-download npm-version-requirement node-version-requirement DOI

Introduction

VTK is an open-source software system for image processing, 3D graphics, volume rendering and visualization. VTK includes many advanced algorithms (e.g., surface reconstruction, implicit modelling, decimation) and rendering techniques (e.g., hardware-accelerated volume rendering, LOD control). The JavaScript implementation remains a subset of the actual C++ library but efforts will be made to easily port or compile native VTK code into WebAssembly to better blend both worlds. vtk.js is a true rewrite of VTK in plain JavaScript (ES6). Therefore not everything has been rewritten.

The origin of VTK is with the textbook "The Visualization Toolkit, an Object-Oriented Approach to 3D Graphics" originally published by Prentice Hall and now published by Kitware, Inc. (Third Edition ISBN 1-930934-07-6). VTK has grown (since its initial release in 1994) to a world-wide user base in the commercial, academic, and research communities.

vtk.js aims to be a subset of VTK and provide 3D rendering using WebGL for both geometry and volume rendering.

Reporting Bugs

If you have found a bug:

  1. If you have a patch, please read the CONTRIBUTING.md document.

  2. Otherwise, please join the one of the VTK Mailing Lists and ask about the expected and observed behaviors to determine if it is really a bug.

  3. Finally, if the issue is not resolved by the above steps, open an entry in the VTK Issue Tracker.

Requirements

In general VTK tries to be as portable as possible; the specific configurations below are known to work and tested.

vtk.js supports the following development environments:

  • Node 8+
  • NPM 6+

and we use @babel/preset-env with the defaults set of browsers target. But when built from source this could be adjusted to support any browser as long they provide WebGL.

Documentation

See the documentation for a getting started guide, advanced documentation, and API descriptions.

Contributing

See CONTRIBUTING.md for instructions to contribute.

License

VTK is distributed under the OSI-approved BSD 3-clause License. See Copyright.txt for details.

You can’t perform that action at this time.