https://github.com/bryik/aframe-layers-component
This is an A-Frame component for controlling the layers of an entity.
https://github.com/bryik/aframe-layers-component
aframe vr webvr
Last synced: about 1 year ago
JSON representation
This is an A-Frame component for controlling the layers of an entity.
- Host: GitHub
- URL: https://github.com/bryik/aframe-layers-component
- Owner: bryik
- License: mit
- Created: 2020-07-25T00:05:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T20:29:17.000Z (over 3 years ago)
- Last Synced: 2025-04-13T15:54:09.378Z (over 1 year ago)
- Topics: aframe, vr, webvr
- Language: JavaScript
- Homepage: https://bryik.github.io/aframe-layers-component/index.html
- Size: 1.89 MB
- Stars: 4
- Watchers: 0
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## aframe-layers-component
This is an A-Frame component for controlling the [layers](https://threejs.org/docs/index.html#api/en/core/Layers) of an entity.
Why is this useful? In VR, sometimes you want to show things to one eye but
not the other (stereo panoramas for instance). This can be done by restricting
an Object3D to either layer 1 [(visible to the left eye) or layer 2 (visible
to the right eye)](https://github.com/mrdoob/three.js/blob/0950e5b6e8bceb520c154f45b5c240af45f0ed11/src/renderers/webxr/WebXRManager.js#L41).
- [Demo](https://bryik.github.io/aframe-layers-component/index.html)
### properties
| Property | Description | Default Value |
| :------: | :-----------------------------------------------------------: | :-----------: |
| layers | An array of layers the entity should have enabled e.g. "0, 1" | "0" |
Note: omitting layer 0 will likely cause your object to disappear (unless you enable additional layers on the camera).
## usage
### browser
Install and use by directly including the [browser files](dist):
```html
My A-Frame Scene
```
This code generated the image shown at the top of this README. In VR, the blue box is visible to the left eye only while the yellow cylinder is visible to the right eye only. Outside of VR, neither the box or cylinder are visible because the camera defaults to layer 0 only.
### npm
Alternatively, install via npm:
```bash
npm install aframe-layers-component
```
Then register and use.
```js
require("aframe");
require("aframe-layers-component");
```
## local development
### prerequisites
- `node.js` and `npm`
- OpenSSL (if HTTPS is needed for local dev)
### install
1. Clone this repo
2. `npm install`
### run
```bash
npm run dev
# if https is needed
npm run dev-ssl
```
This will start a local dev server.
### new releases
Once new features/bug fixes are merged into master.
1. Increment package version in `package.json` ([semver](https://semver.org/) is recommended).
2. `npm run dist`
3. Commit the newly generated `./dist` files.
4. `npm publish`
5. Update jsdelivr CDN links in this README to point to new version.
6. Draft a new release on GitHub, add a changelog describing what has changed since the last release.
## references
This component was originally based on Óscar Marín Miró's [stereocam component](https://github.com/oscarmarinmiro/aframe-stereo-component).
### notes
In three.js, Object3D have a `layers` property that can be used to control visibility.
> ...an object must share a layer with a camera to be visible when that camera's view is renderered. - [three.js docs](https://threejs.org/docs/index.html#api/en/core/Layers)
By default all Object3Ds are a member of layer 0, so everything starts out visible. In VR mode, each eye is represented by a separate camera and [given access to an additional layer](https://github.com/mrdoob/three.js/blob/0950e5b6e8bceb520c154f45b5c240af45f0ed11/src/renderers/webxr/WebXRManager.js#L41):
- the left eye can see layers 0 and 1
- the right eye can see layers 0 and 2
This makes it easy to do things like show meshes to each eye independently--a necessary trick to [view stereo panoramas](https://github.com/bryik/stereo-panorama-viewer).