To better introduce this library I wrote an article on Medium. You can start from it.
New features/bug fixing will take place on AR.js repository!
See the AR.js Changelog.
Refer to AR.js issues for problems and feature requests about this project.
Please open issues on AR.js using the 'location-based' label.
🌍The aim is to bring a basic but working Location Based AR system to the actual AR.js (currently marker based only).
The original version was working with some limitations, but it is now outdated (it was based on aframe v0.6.0, now we have aframe v0.9.0 version with different APIs). The aim is to make it work with updated dependencies and possibly better performances, also refactoring for a more maintainable codebase.
These aframe components can work independently from AR.js. By the way, they are a powerful and simple system that become interesting if added to AR.js' marker based capabilities, thus making AR.js a multiple-AR library.
🚀 Here you can track my updates about this project.
For updated stuff about GeoAR.js and AR.js, you can follow me.
Basically, you can add gps-entity-place - custom aframe entities that have a specific longitude/latitude values. You can add them with a script, loading them from APIs (Foursquare, Google Maps, and so on) or just add them statically on your HTML. You can also load them dynamically as you move to a wider area using APIs. Choice is yours and possibilities are endless with Javascript.
Once you have added one or more gps-entities, and added the gps-camera on the camera entity, the system calculates, at every frame, your position and the distance of places from you.
Using your phone sensors for orientation/position, it is able to show on your camera a content for each place on its 'physical' place (so if you point the camera toward the place in real life, you will see the content near it).
If you move the camera, it calculates again orientation and position. If places are far, it shows smaller content. If places are near you, it shows it bigger. Hope I give to you the basic idea. Let's try a demo.
🌍Click on the example name for the online version.
📲Open from mobile phone.
-
Show place icon for every place. Clicking on the icon will show the place name.
-
Show icon and place name above. Clicking on places will redirect to a certain URL (now mocked up).
-
Add Objects [WIP]
Add one or more objects on certain GPS positions and see them in real world with your camera.
Every example uses the places.js script to load places. You can use that with static data using your coordinates, adding these info in the first lines of code (there are comments to explain better).
Otherwise, as default, the script searches for places of interest near the user using Foursquare APIs. Please retrieve valid API credentials here in order to use it. Place credentials (client secret and client id) on places.js.
You can also use GeoAR.js without the script, adding gps-entity-place entities as documentated on the following section, putting them directly on the index.html file.
Work In Progress
Required: yes
Max allowed per scene: 1
This component enables the Location AR. It has to be added to the camera entity.
It makes possible to handle both position and rotation of the camera and it's used to determine where the user is pointing their device.
For example:
<a-camera gps-camera rotation-reader></a-camera>In addition to that, as you can see on the example above, we also have to add rotation-reader to handle rotation events. See here for more details.
| Property | Description | Default Value |
|---|---|---|
| alert | Whether to show a message when GPS signal is under the positionMinAccuracy |
false |
| positionMinAccuracy | Minimum accuracy allowed for position signal | 100 |
| minDistance | If set, places with a distance from the user lower than this value, are not showed. Only a positive value is allowed. Value is in meters. | 0 (disabled) |
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.
It requires latitude and longitude as a single string parameter (example with a-box aframe primitive):
<a-box color="yellow" gps-entity-place="latitude: <your-latitude>; longitude: <your-longitude>"/>Required: no
Max allowed per scene: 1
This component has to be added only in development environments, not production ones.
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:
<a-scene gps-camera-debug embedded arjs='sourceType: webcam; debugUIEnabled: false;'></a-scene>Tried on Huawei P20, works like charm.
Works good also on iPhone 6.
On iOS, from 12.2, Motion sensors on Safari has be to activated from Settings. If not, GeoAR.js will prompt the user to do so. This may change with final release of iOS 13 but as September 2019 is not yet out.
We need a lot of more tests, but the first impression is: the more advanced the phone (so newer) the better. This because of better quality sensors.
It is based on the discussion from this github issue. It has been originated by 1d10t in this file. The first mock up project has been originally created by Jerome Etienne as a branch of AR.js and then as standalone repository, but was left alone from 2017. What I'm doing is to bring it alive and kicking for the first time since its creation.
Thanks a LOT for all contributions! ❤️