PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.0.0

npm

@0x4d/locationar

Location based Argumented Reality for three.js

araugmented realitygpslocation basedthree.jsar tooltips
Published11 Jul 2019
Direct dependencies14
Transitive dependenciesNot calculated

README

Current package documentation

LOCATIONAR

Simple Location based Argumented Reality library, based on the WebRTC, Geolocation, DeviceOrientation and AmbientLightSensor

Online Samples:

  1. Use Chrome
  2. goto the Compass example and see if it's working [camera is working, north in the right direction]
  3. goto the Location example and you should see a red cube 10 m in the direction of North
  4. If you don't see the cube or want to change the position click "InfoPanel" and then you can press the button GetPosition to set the position of the cube to your current position and offset it with the +10N, +10W,... buttons Here you can also see the raw sensor data

Problems/Limentations

  • missing compass accurcy[can't find exact numbers, but up to +/- 10° on good devices, on some devices completely unuseable]
  • camera fov[different phones have different fov's and if the difference between the camera fov and the set fov is to big, the mapping for non-centered, far away objects will be distorted]
  • gps accurcy[can be a problem if the object is nearer than 20 meters]
  • to use the light ambient light sensor, you need to set the chrome flag #enable-generic-sensor-extra-classes to enabled

Documentation and Examples

Browser compability

✔️Chrome ❌Samsung Internet[Scaling doesn't work] ❌Firefox [no absolute compass] ❌UC[Source doesn't work] ❌Opera ❔Safari[can't test on apple devices]

Usage

The lib is small, only 20KB

LOCATIONAR is provided as an npm module:

npm i @0x4d/locationar

You can also download this repository and import the dist/LOCATIONAR.js file

Development and Contribution

Please see the development guide. If you are interested in contributing, it may be a good starting point to see the list of open issues on our GitHub issues page.

Acknowledgements

  • three.js awesome 3d rendering library
  • THREEAR marker based AR libary, with was used as a template for this project

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 14

Native requirements
14 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
three
Environment
{
  "local_name": "three",
  "alias": false,
  "peer_metadata": null
}
^0.106.2runtime
husky
Environment
{
  "local_name": "husky",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
live-server
Environment
{
  "local_name": "live-server",
  "alias": false,
  "peer_metadata": null
}
^1.2.1development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^1.18.2development
prettier-webpack-plugin
Environment
{
  "local_name": "prettier-webpack-plugin",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
ts-loader
Environment
{
  "local_name": "ts-loader",
  "alias": false,
  "peer_metadata": null
}
^6.0.4development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
^5.18.0development
tslint-config-prettier
Environment
{
  "local_name": "tslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^1.18.0development
typedoc
Environment
{
  "local_name": "typedoc",
  "alias": false,
  "peer_metadata": null
}
^0.14.2development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^3.5.3development
webpack
Environment
{
  "local_name": "webpack",
  "alias": false,
  "peer_metadata": null
}
^4.35.3development
webpack-bundle-analyzer
Environment
{
  "local_name": "webpack-bundle-analyzer",
  "alias": false,
  "peer_metadata": null
}
^3.3.2development
webpack-cli
Environment
{
  "local_name": "webpack-cli",
  "alias": false,
  "peer_metadata": null
}
^3.3.5development
webpack-dev-server
Environment
{
  "local_name": "webpack-dev-server",
  "alias": false,
  "peer_metadata": null
}
^3.7.2development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-PJG9nqLiKacRDbX3MwfZW7NcSMHf5IInyqaIXIUUSTOOMYeLvqmwNk+sg95knr61InBV29heivRWaeJlHx7kjg==",
  "shasum": "fed50ca42b708c6bd79bcf7b72546e6e31b89964",
  "tarball": "https://registry.npmjs.org/@0x4d/locationar/-/locationar-1.0.0.tgz",
  "fileCount": 45,
  "unpackedSize": 613929,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdJr7HCRA9TVsSAnZWagAAz88P/05UREf9pfeV1iAmut+G\n7uuvSRVBT0FfNKUKdW1xy8uQ12eJywJV3D6QckeQ6tY8JopDsLnPFzmTnRmi\nxDcArJQla4Kv/IUq61goB2oqgpFHdY/vuwuUSIowyleyqIhCig5BaTJyd13E\n+0bBCWcmj/OZaf2pdx46pVyBa/4FAvRK/u3kZU0AMTaA13fYmMat6IQ2i8TZ\n+iiHKnw3WD/h+rz1MWltw/xvFE3akxpVb4unL4SPaK4Wp/KbBjBq2/opnqmB\nkO3WaKh1k6kbm4GaApqafVb6HND6HxJC2cUW3/Yp7ApFWCTwppiNa5aji6S+\nYzHnA7dxR09rCd/t7SW0m/++lHeEo1+azqszDYlI6wQ80ec7nGNFYUksruCc\nEddoV9cBF14rJp/ixZjB+VMFUxI1dFpWScRbvn7utAciGxOU4XYXA3ID6YpC\n4uD9pHfqCZh4jfpBPGonb7XPDpp0GJ31CaYTfomr7TeVTGKiV969RtqC2mUH\n3mbzXmJMhVLx35QxYs2z2Sty1F75KthS6XGYnE9YWKh/q5L4o2uWmRcnlUa+\nwp0yoI50Wki/Z+a4FqfL6b46fQlRcBjNni3K++E564g1w9Oyj4ZhtLauE1l9\n2SIh+8Qez3qqfQX1NUiwwkiFK01yotWe8ZH0T54MrRWQWlPehC4Ftxucpz2y\nsTMK\r\n=oGVu\r\n-----END PGP SIGNATURE-----\r\n",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIBGXViwZEO/RoSuOIvdZ+191pjePhVOxBpCmqYQQio+XAiEAkY3h7xMTgNL9nwIa/YFAG+iPkeun4gx2m+KPP9+eiS4="
    }
  ]
}

Repository

PENDING
0b01001101/locationar

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:37 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:fa0e91bb9f22c7d058dcdc5eeced90d32eef3fcff8e3f0cee08c1e695d9985a3

Other collected versions

1.0.229 Jul1.0.120 JulView all collected versions →