Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mithi/bare-minimum-3d
A small package to transform declared 3d data (points, polygons, lines) to 2d data.
https://github.com/mithi/bare-minimum-3d
3d-graphics 3d-plot computer-graphics data-visualization graphics-programming hacktoberfest javascript javascript-library plotly svg typescript typescript-library
Last synced: 2 days ago
JSON representation
A small package to transform declared 3d data (points, polygons, lines) to 2d data.
- Host: GitHub
- URL: https://github.com/mithi/bare-minimum-3d
- Owner: mithi
- License: apache-2.0
- Created: 2020-08-24T08:24:04.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-29T23:46:41.000Z (over 2 years ago)
- Last Synced: 2024-11-11T06:12:40.750Z (3 days ago)
- Topics: 3d-graphics, 3d-plot, computer-graphics, data-visualization, graphics-programming, hacktoberfest, javascript, javascript-library, plotly, svg, typescript, typescript-library
- Language: TypeScript
- Homepage: https://mithi.github.io/hello-3d-world/
- Size: 1.74 MB
- Stars: 34
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@mithi/bare-minimum-3d)
[](https://bundlephobia.com/result?p=@mithi/bare-minimum-3d)
[](https://bundlephobia.com/result?p=bare-minimum-3d)
[](https://packagephobia.com/result?p=%40mithi%2Fbare-minimum-3d)
[](https://coveralls.io/github/mithi/bare-minimum-3d?branch=master)
[](https://codeclimate.com/github/mithi/bare-minimum-3d)
[](https://codeclimate.com/github/mithi/bare-minimum-3d/trends/technical_debt)
[](https://ko-fi.com/minimithi)
# Bare Minimum 3d
A small package to transform declared 3d data (points, polygons, lines) to 2d data. The output is intended to be fed to a [`BareMinimum2d`](https://github.com/mithi/bare-minimum-2d) React component.
Extremely lightweight and fairly configurable, this package has zero dependencies and a relatively straightforward declarative API. See also: [why I created this project](https://github.com/mithi/bare-minimum-3d/wiki/Why-I-created-this-project).
You can checkout a demo application (and play with the parameters!) at: https://mithi.github.io/hello-3d-world
## Getting started
```
$ npm i @mithi/bare-minimum-3d
$ npm i bare-minimum-2d
```
You can check out the examples of [`SceneOptions`, `SceneSettings`, `ViewSettings`](https://github.com/mithi/bare-minimum-3d/blob/master/test/data/input-settings.ts) that you can pass to the `renderScene()` function. You can pass 3d data such as this [`hexapod`](https://github.com/mithi/bare-minimum-3d/blob/master/test/data/input-data-3d.ts) or [`pyramid`](https://github.com/mithi/hello-3d-world/blob/master/src/data/input-3d-pyramid.ts). When you pass the hexapod data along with the other example parameters linked above, [`this is the corresponding 2d data`](https://github.com/mithi/bare-minimum-3d/blob/master/test/data/output-data-2d.ts) that `renderScene()` would return.
```js
import BareMinimum2d from "bare-minimum-2d"
import renderScene from "@mithi/bare-minimum-3d"
const { container, data } = renderScene(
viewSettings, sceneSettings, sceneOptions, data3d
)
```
Please check the [wiki / documentation](https://github.com/mithi/bare-minimum-3d/wiki), to learn more about the arguments that you'll need to pass to `BareMinimum3d`'s `renderScene()` function.
- [`SceneOptions`](https://github.com/mithi/bare-minimum-3d/wiki/SceneOptions)
- [`SceneSettings`](https://github.com/mithi/bare-minimum-3d/wiki/SceneSettings)
- [`ViewSettings`](https://github.com/mithi/bare-minimum-3d/wiki/ViewSettings)
## `0.4.0` Update
In Version `0.4.0` all utility functions are now exposed to the users, so you can use it however you like. With all the building blocks available to you, you can even build your own custom `renderScene` function, should you want to!
```js
import {
renderScene,
SCENE_ORIENTATION,
getWorldWrtCameraMatrix,
AxesRenderer,
SceneCube,
DataRenderer,
SceneCubeRenderer,
Vector,
rotateXYZmatrix,
multiply4x4matrix,
radians,
} from "@mithi/bare-minimum-3d"
```
## ⚠️❗ Limitations
This library does NOT perform [clipping](https://www.gabrielgambetta.com/computer-graphics-from-scratch/clipping.html) or [hidden surface removal](https://www.gabrielgambetta.com/computer-graphics-from-scratch/hidden-surface-removal.html). Each element are just painted to the screen in the order that you declare them in your array of data, and the scene elements are always rendered first, meaning your data will be rendered on top of any scene element. This means that it is possible that elements will incorrectly overlap other elements that are actually nearer to the camera. There is no plan to fix this... unless someone [makes a pull request](https://github.com/mithi/bare-minimum-3d/issues/20)! :heart:
## Contributing [](./CONTRIBUTING.md)
Please read the [contributing guidelines](https://github.com/mithi/hexapod/blob/master/CONTRIBUTING.md) and the recommended [commit style guide](https://github.com/mithi/hexapod/wiki/A-Commit-Style-Guide)! Thank you!