README.md

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 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.

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 that you can pass to the renderScene() function. You can pass 3d data such as this hexapod or pyramid. When you pass the hexapod data along with the other example parameters linked above, this is the corresponding 2d data that renderScene() would return.

import BareMinimum2d from "bare-minimum-2d"
import renderScene from "@mithi/bare-minimum-3d"

const { container, data } = renderScene(
    viewSettings, sceneSettings, sceneOptions, data3d
)

<BareMinimum2d {...{container, data} />

Please check the wiki / documentation, to learn more about the arguments that you'll need to pass to BareMinimum3d's renderScene() function.

• SceneOptions
• SceneSettings
• 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!

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 or hidden surface removal. 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! ❤️

Contributing

Please read the contributing guidelines and the recommended commit style guide! Thank you!