2015-12-18 23:36:21 +00:00
|
|
|
# aframe-click-drag-component
|
|
|
|
|
|
|
|
|
|
A Click & Drag component for [A-Frame](https://aframe.io).
|
|
|
|
|
|
|
|
|
|
Entities with the `click-drag` component can be click and dragged around the 3D
|
2016-10-04 06:46:38 +00:00
|
|
|
scene. Even works whle the camera is moving or rotating!
|
2015-12-18 23:36:21 +00:00
|
|
|
|
2016-09-28 12:48:21 +00:00
|
|
|
### Events
|
|
|
|
|
|
|
|
|
|
**dragstart**
|
|
|
|
|
|
|
|
|
|
Emitted with the following info:
|
|
|
|
|
|
|
|
|
|
- `offset: {x, y, z}` - The offset from entity center to drag position.
|
|
|
|
|
- `depth` - the perpendicular distance from the screen to align the entity while
|
|
|
|
|
dragging
|
|
|
|
|
- `clientX` - the mouse event's `clientX` value
|
|
|
|
|
- `clientY` - the mouse event's `clientY` value
|
|
|
|
|
|
|
|
|
|
**dragmove**
|
|
|
|
|
|
|
|
|
|
Emitted with the following info:
|
|
|
|
|
|
|
|
|
|
- `nextPosition: {x, y, z}` - The next world position of the entity.
|
|
|
|
|
- `clientX` - the mouse event's `clientX` value
|
|
|
|
|
- `clientY` - the mouse event's `clientY` value
|
|
|
|
|
|
|
|
|
|
**dragend**
|
|
|
|
|
|
|
|
|
|
Emitted with the following info:
|
|
|
|
|
|
|
|
|
|
- `offset: {x, y, z}` - The offset from entity center to drag position.
|
2016-09-28 12:42:51 +00:00
|
|
|
- `velocity: {x, y, z}` - The smoothed velocity of the entity at dragend time.
|
2016-09-28 12:48:21 +00:00
|
|
|
- `depth` - the perpendicular distance from the screen to align the entity while
|
|
|
|
|
dragging
|
|
|
|
|
- `clientX` - the final mouse event's `clientX` value
|
|
|
|
|
- `clientY` - the final mouse event's `clientY` value
|
|
|
|
|
|
2015-12-18 23:36:21 +00:00
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
#### Browser
|
|
|
|
|
|
|
|
|
|
Use directly from the unpkg CDN:
|
|
|
|
|
|
|
|
|
|
```html
|
|
|
|
|
<head>
|
|
|
|
|
<script src="https://aframe.io/releases/0.3.0/aframe.min.js"></script>
|
|
|
|
|
<script src="https://unpkg.com/aframe-click-drag-component"></script>
|
|
|
|
|
<script>
|
|
|
|
|
registerAframeClickDragComponent(window.AFRAME);
|
|
|
|
|
</script>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
<a-scene>
|
|
|
|
|
<a-sphere click-drag position="0 1.25 -5" radius="1.25" color="#EF2D5E"></a-sphere>
|
|
|
|
|
<a-camera look-controls-enabled="false"></a-camera>
|
|
|
|
|
</a-scene>
|
|
|
|
|
</body>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### npm
|
|
|
|
|
|
|
|
|
|
Install via npm:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install aframe-click-drag-component
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then register and use.
|
|
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
import aframe from 'aframe';
|
|
|
|
|
import registerClickDrag from 'aframe-click-drag-component';
|
|
|
|
|
registerClickDrag(aframe);
|
|
|
|
|
```
|
