three-mesh-ui - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #llm #golang #machine-learning #macos #nodejs #java #awesome #kubernetes #pytorch #mcp

three-mesh-ui

(★ 1,475)

⏹ Make VR user interfaces for Three.js

File Explorer

Download Latest Version (.zip)

- - npm-publish.yml
- build.browser.html
- build.browser.min.html
- build.module.html
- build.module.min.html
- index.html
- three-mesh-ui.js
- three-mesh-ui.min.js
- three-mesh-ui.module.js
- three-mesh-ui.module.min.js
- - .babelrc
  - .eslintrc
  - ij_config.xml
- webpack.config.js
- webpack.prodConfig.js
- - backspace.png
  - enter.png
  - Roboto-msdf.json
  - Roboto-msdf.png
  - Rye.json
  - Rye.png
  - Saira.json
  - Saira.png
  - shift.png
  - spiny_bush_viper.jpg
  - threejs.png
  - uv_grid.jpg
- - example_template.html
  - index.html
- - deepDelete.js
  - ShadowedLight.js
  - VRControl.js
- align_items.js
- antialiasing.js
- background_size.js
- basic_setup.js
- best_fit.js
- border.js
- content_direction.js
- font_kerning.js
- hidden_overflow.js
- inline_block.js
- interactive_button.js
- justification.js
- justify_content.js
- keyboard.js
- letter_spacing.js
- manual_positioning.js
- msdf_text.js
- nested_blocks.js
- onafterupdate.js
- preloaded_font.js
- text_align.js
- tutorial_result.js
- vertical_alignment.js
- whitespace.js
- - Block.js
  - InlineBlock.js
  - Keyboard.js
  - Text.js
- - Frame.js
  - MSDFGlyph.js
  - MSDFText.js
- - deepDelete.js
  - Defaults.js
  - Keymaps.js
  - mix.js
- three-mesh-ui.js
- types.d.ts
.editorconfig
.gitignore
.npmignore
LICENSE
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/felixmariotto/three-mesh-ui

Downloads the entire project code from GitHub to your computer.

cd three-mesh-ui

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# three-mesh-ui

<a href="https://three-mesh-ui.herokuapp.com/#interactive_button">
  <img alt="buttons example" target="_blank" src="https://felixmariotto.s3.eu-west-3.amazonaws.com/three-mesh-ui-teasers/buttons_opti.gif" width="45%">
</a>

<a href="https://three-mesh-ui.herokuapp.com/#hidden_overflow">
  <img alt="tuto example" target="_blank" src="https://felixmariotto.s3.eu-west-3.amazonaws.com/three-mesh-ui-teasers/hidden_overflow_opti.gif" width="45%">
</a>

<a href="https://three-mesh-ui.herokuapp.com/#nested_blocks">
  <img alt="big text example" target="_blank" src="https://felixmariotto.s3.eu-west-3.amazonaws.com/three-mesh-ui-teasers/nested_layout_opti.gif" width="45%">
</a>

<a href="https://three-mesh-ui.herokuapp.com/#keyboard">
  <img alt="big text example" target="_blank" src="https://felixmariotto.s3.eu-west-3.amazonaws.com/three-mesh-ui-teasers/keyboard_opti.gif" width="45%">
</a>

## [Examples (live)](https://felixmariotto.github.io/three-mesh-ui/) &nbsp;|	&nbsp;[NPM](https://www.npmjs.com/package/three-mesh-ui)	&nbsp;|	&nbsp;[Documentation](https://github.com/felixmariotto/three-mesh-ui/wiki)	&nbsp;|	&nbsp;[Contributing](https://github.com/felixmariotto/three-mesh-ui/wiki/Roadmap-&-Contributions)

📢 7.x.x is in evaluation, check it out here https://github.com/felixmariotto/three-mesh-ui/pull/223

# What is it ?

**three-mesh-ui** is a small library for building VR user interfaces. The objects it creates are [three.object3Ds](https://github.com/mrdoob/three.js/blob/dev/src/core/Object3D.js), usable directly in a [three.js](https://threejs.org) scene like any other Object3D.    
        
**It is not a framework**, but a minimalist library to be used with the last version of three.js. It has no dependency but three.js.

# Why ?

In a normal three.js workflow, the common practice is to build user interfaces with HTML/CSS.

In immersive VR, it is impossible, therefore this library was created.

# Quick Start

## Try it now

Give it a try in [this jsFiddle](https://jsfiddle.net/felixmariotto/y81rf5t2/44/)

Using react-three-fiber ? Here is a [codesandbox](https://codesandbox.io/s/react-three-mesh-ui-forked-v7n0b?file=/src/index.js) to get started.

## Import
### JSM
#### With NPM 
`npm install three-mesh-ui`
*:warning: It requires three as peer dependency*

##### ES6 ([codesandbox demo](https://codesandbox.io/s/npm-package-demo-2onzpo))

```javascript
import ThreeMeshUI from 'three-mesh-ui'
```

##### CommonJS   
```javascript
const ThreeMeshUI = require('three-mesh-ui');
```

##### HTML &lt;script&gt; tag ([codesandbox demo](https://codesandbox.io/s/module-build-demo-bkmfi8?file=/index.html:281-913))
```html
 
<script async src="https://unpkg.com/es-module-shims@1.3.6/dist/es-module-shims.js"></script>
<script type="importmap">
{
    "imports": {
        "three": "https://unpkg.com/three@0.132.2/build/three.module.js",
        "three-mesh-ui": "https://unpkg.com/three-mesh-ui@6.4.0/build/three-mesh-ui.module.js"
    }
}
</script>

<script type="module">
    import * as THREE from "three";
    import * as ThreeMeshUI from "three-mesh-ui";

// code goes here ...
</script>
```
:muscle: *You can use the minified version named __three-mesh-ui.module.min.js__ ([codesandbox demo](https://codesandbox.io/s/module-build-demo-minified-pm6jwx))*

### JS
#### HTML &lt;script&gt; tag ([codesandbox demo](https://codesandbox.io/s/js-build-demo-061eku))
```html


<script src="https://unpkg.com/three@0.132.2/build/three.js"></script>

<script src="https://unpkg.com/three-mesh-ui@6.4.1/build/three-mesh-ui.js"></script>

<script>
    /* global THREE, ThreeMeshUI */

// code goes here ...
</script>
```
:muscle: *You can use the minified version named __three-mesh-ui.min.js__ ([codesandbox demo](https://codesandbox.io/s/js-build-demo-minified-onh8zi))*    
:warning: *Although this would theorically allows you to build 'something', loading js libraries instead of using jsm, might restrict the global features you would have. This is true for both three and three-mesh-ui libraries.*

## Font files

In order to display some text with three-mesh-ui, you will need to provide font files.   
You can use the two files named `Roboto-msdf` in [this directory](https://github.com/felixmariotto/three-mesh-ui/tree/master/examples/assets), or [create your own font files](https://github.com/felixmariotto/three-mesh-ui/wiki/Creating-your-own-fonts)

## API

Here is an example of basic three-mesh-ui usage :

```javascript
const container = new ThreeMeshUI.Block({
 width: 1.2,
 height: 0.7,
 padding: 0.2,
 fontFamily: './assets/Roboto-msdf.json',
 fontTexture: './assets/Roboto-msdf.png',
});

//

const text = new ThreeMeshUI.Text({
 content: "Some text to be displayed"
});

container.add( text );

// scene is a THREE.Scene (see three.js)
scene.add( container );

// This is typically done in the render loop :
ThreeMeshUI.update();
```