Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fernandojsg/aframe-teleport-controls
A-Frame teleport controls component
https://github.com/fernandojsg/aframe-teleport-controls
Last synced: 19 days ago
JSON representation
A-Frame teleport controls component
- Host: GitHub
- URL: https://github.com/fernandojsg/aframe-teleport-controls
- Owner: fernandojsg
- License: mit
- Created: 2016-10-27T13:56:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T01:51:58.000Z (almost 2 years ago)
- Last Synced: 2024-04-15T02:08:38.957Z (8 months ago)
- Language: JavaScript
- Homepage: https://fernandojsg.github.io/aframe-teleport-controls
- Size: 25 MB
- Stars: 175
- Watchers: 12
- Forks: 72
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- vr-resources - aframe-teleport-controls, A-Frame teleport controls component
README
# aframe-teleport-controls
Teleport component
## Properties
| Property | Description | Default Value |
| -------- | ----------- | ------------- |
| cameraRig | Selector of the camera Rig to teleport | |
| teleportOrigin | Selector of the child of cameraRig to use as the center point for teleporting, typically the camera. If set teleporting will position the cameraRig such that this element ends up above the teleport location (rather than the center of the camreaRig) | |
| type | Type of teleport: line or parabolic | parabolic |
| button | Button used to launch the teleport: trackpad, trigger, grip, menu | trackpad |
| collisionEntities | Selector of the meshes used to check the collisions. If no value provided a plane Y=0 is used | |
| endEvents | Paired with `startEvents`, list of events to listen for to finish teleporting.| [] |
| hitEntity | Entity used to show at the hitting position. If no value provided a cylinder will be used as default. | |
| hitCylinderColor | Color used for the default `hitEntity` primitives | #99ff99 |
| hitCylinderRadius | Radius used for the default `hitEntity` primitives | 0.25 |
| hitCylinderHeight | Height used for the default `hitEntity` primitives | 0.3 |
| interval | Number of milliseconds to wait in between each intersection test. Lower number is better for faster updates. Higher number is better for performance. | 0 |
| curveHitColor | Color used for the curve when hit the mesh | #99ff99 |
| curveMissColor | Color used for the curve when it doesn't hit anything | #ff0000 |
| curveNumberPoints | Number of points used in the curve | 30 |
| curveLineWidth | Line width of the curve | 0.025 |
| curveShootingSpeed | Curve shooting speed, as bigger value, farther distance. | 5 |
| defaultPlaneSize | Default plane size | 100 |
| maxLength | Max length of the ray when using type=line teleport | 10 |
| landingNormal | Normal vector to detect collisions with the `collisionEntity` | (0, 1, 0) |
| landingMaxAngle | Angle threshold (in degrees) used together with `landingNormal` to detect if the mesh is so steep to jump to it. | 45 |
| startEvents | Alternative to `button`, list of events to listen to start teleporting.| [] |
### Usage
#### Browser Installation
Install and use by directly including the [browser files](dist):
There are two ways to use it: using a camera rig or not. I strongly recommend using a camera rig as the following example:
```html
My A-Frame Scene
```
To use this component with Gear VR, you need to add `gearvr-controls`:
```html
```
You can also use the trigger button instead of trackpad button by adding `button: trigger`.
For Daydream, replace `gearvr-controls` by `daydream-controls`.
If you use [aframe-environment-component](https://github.com/feiss/aframe-environment-component) > 1.0.0
and want to teleport on the generated ground, on the hills, you can
specify `collisionEntities: .environmentGround`. You can also add `.environmentDressing` if you want to teleport on the dressing like the mushrooms.
On Gear VR, it can be very slow with the curved line. Use `maxLength: 200; type: line;` in this case.
#### NPM Installation
Install via NPM:
```bash
npm install aframe-teleport-controls
```
Then register and use.
```js
require('aframe-teleport-controls');
```
### Events
| Event | Properties of `event.detail` | Description |
|------------|------------------------------------------|----------------------------------|
| `teleported` | `oldPosition`, `newPosition`, `hitPoint` | Fires when teleportation begins. |