Skip to content

Commit

Permalink
Merge pull request #679 from mingir2/dev
Browse files Browse the repository at this point in the history
Documentation edits on location-based AR
  • Loading branch information
nicolocarpignoli authored Dec 19, 2019
2 parents 088c346 + 8dca33f commit ac6027d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ More details about markers:

# What "Location Based" means

### Check out the Location Based documentation: [here](https://github.com/jeromeetienne/AR.js/blob/location-based/aframe/README.md#location-based).
### Check out the Location Based documentation: [here](https://github.com/jeromeetienne/AR.js/blob/master/aframe/README.md#location-based).

AR.js, on its `aframe` implementation, comes with few custom components that make possible to integrate data from GPS sensors.

Expand Down Expand Up @@ -100,7 +100,7 @@ Every example uses the `places.js` script to load places. You set your places us

Otherwise, as default, the script searches for places of interest near the user using Foursquare APIs. Please retrieve valid API credentials [here](https://developer.foursquare.com/) in order to use it. Place credentials (replace both Client Secret and Client Id) on `places.js`.

You can also use GeoAR.js **without** the script, adding `gps-entity-place` entities directly on the `index.html` file.as documentated [here](https://github.com/jeromeetienne/AR.js/blob/location-based/aframe/README.md).
You can also use GeoAR.js **without** the script, adding `gps-entity-place` entities directly on the `index.html` file.as documentated [here](https://github.com/jeromeetienne/AR.js/blob/master/aframe/README.md).


# Index
Expand Down
20 changes: 10 additions & 10 deletions aframe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ cameraTransform would fit well a room-scale setup, with *multiple markers connec
modelView is able to provide multiple *independent* markers.

```html
<!-- add artoolkit into your scene -->
<a-scene artoolkit>
<!-- define your scene as usual -->
<a-box></a-box>
<!-- define a camera inside the <a-marker-camera> -->
<a-marker-camera preset='hiro'><a-marker-camera>
</a-scene>
<!-- add artoolkit into your scene -->
<a-scene artoolkit>
<!-- define your scene as usual -->
<a-box></a-box>
<!-- define a camera inside the <a-marker-camera> -->
<a-marker-camera preset='hiro'><a-marker-camera>
</a-scene>
```

## Location Based
Expand Down Expand Up @@ -75,7 +75,7 @@ In addition to that, as you can see on the example above, we also have to add `r
**Required**: yes
**Max allowed per scene**: no limit

This component makes every entity GPS-trackable. It assignes a specific world position to the entity, so the user can see it when their phone is pointing to its position in the real world. If user is far from the entity, their will see it smaller. If it is too far, their will not see it at all.
This component makes each entity GPS-trackable. This assigns a specific world position to an entity, so that the user can see it when their device is pointing to its position in the real world. If the user is far from the entity, it will seem smaller. If it's too far away, it won't be seen at all.

It requires latitude and longitude as a single string parameter (example with `a-box` aframe primitive):

Expand All @@ -88,10 +88,10 @@ It requires latitude and longitude as a single string parameter (example with `a
**Required**: no
**Max allowed per scene**: 1

This component has to be added only in development environments, not production ones.
This component should only be added in development environments, not in production environments.
It shows a debug UI with camera informations and a list of registered `gps-entity-place` entities, showing also distance from the user for each one.

It has to be added to the `a-scene`:
This replaces the `gps-camera`:

```HTML
<a-scene gps-camera-debug embedded arjs='sourceType: webcam; debugUIEnabled: false;'></a-scene>
Expand Down

0 comments on commit ac6027d

Please sign in to comment.