Skip to content

Commit

Permalink
updated documentation to reflect folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
disasteroftheuniverse committed Dec 30, 2019
1 parent 24ee7b5 commit 27bea04
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/aframe-oculus-hands.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,64 @@ Gestures are stored as animation targets in the [prescribed hand model](./assets
### Alignments

The presribed hand model includes a number of transforms which assist in aligning objects to different hand gestures when they are picked up. Which alignment a grabbed item aligns to may be configured with the ['grabbable' component](#grabbable).

## **collider**

<hr>

A simple AABB collision detection system

**Example**

```html
<a-entity collider="interval: 40; group: foo; collidesWith: bar; bounds: auto; size: 0 0 0;static: false; enabled: true; autoRefesh: false;"></a-entity>
```

**Properties**

| Property | Property Type | Default Value | Description |
|---|---|---|---|
| interval | _number_ | 40 | number of miliseconds between bounds updates & collision tests. |
| group | _string_ | 'all' | A group that this entity belongs to. Used to filter collisions. |
| collidesWith | _string_ | 'none' | A group that this entity considers for collisions if autoRefresh is `true`. |
| bounds | _string_ | 'auto' | How the boundaries of the AABB are computed. Can be one of `auto`,`proxy`,`box` or `mesh` |
| static | _booean_ | true | Whether or not to update the bounds and position on each interval |
| enabled | _booean_ | true | Whether this entity should be by other collider components. |
| autoRefresh | _booean_ | false | Whether or not this entity should check for intersections on each interval. |

**Bounds**

| Name | Description |
|---|---|
| _auto_ | Requires a 3D model component. Creates a proxy object whose bounds are fit to the bounding volume of a _mesh_. The AABB is computed from the proxy object. |
| _proxy_ | Requires the `proxy` component. The AABB is computed from the proxy object. |
| _box_ | The AABB is computed from the `size` property, where the size represents the extents of `'size: width depth height;'` |
| _mesh_ | Requires a 3D model component. The AABB is computed from a mesh. |

**Events**

| Name | Description |
|---|---|
| _hitstart_ | Emitted from both intersecting entities when their AABBs overlap. |
| _hitend_ | Emitted from both intersecting entities when their AABBs no longer overlap. |

<hr>

## **constraint**

<hr>

Attaches one entity to another using `THREE.Object3D.attach()`.

**Example**

```html
<a-entity id="foo"></a-entity>
<a-entity constraint="parent: #foo"></a-entity>
```

**Properties**

| Property | Property Type | Default Value | Description |
|---|---|---|---|
| parent | _selector_ | `null` | Another entity to attach this one to. May not be the same entity. |

0 comments on commit 27bea04

Please sign in to comment.