hub / github.com/JamesLMilner/THREEAR

github.com/JamesLMilner/THREEAR @v1.0.0

Chat with this repo

repository ↗ · DeepWiki ↗ · release v1.0.0 ↗ · + Follow

142 symbols 244 edges 13 files 61 documented · 43%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

THREE AR

Introduction

THREE AR aims to provide a simple to use Augmented Reality API for the web, leveraging three.js's 3D capabilities. THREE AR is written in TypeScript. You can see a description of the aims of THREE AR here.

Usage

THREE AR works with npm and also as a CDN. For npm you can install in the following manner:

npm install threear

using a CDN you can include a script tag from unpkg like so:

<script src="https://unpkg.com/threear"></script>

Demo

The examples folder features a basic demo, you can open it on a mobile device and point your camera at the following marker:

Hiro Marker

Documentation and Examples

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. Please take a moment to read the code of conduct.

Acknowledgements

ar.js on which this library is based
jsartoolkit the Emscripten library from the C code for artoolkit, on which this library is underpinned

License

All files within the src/artoolkit folder are licensed LGPLv3

All other files are MIT Licensed and are adapted from the work of Jerome Etienne

Extension points exported contracts — how you extend this code

BarcodeMarkerParameters (Interface)

* BarcodeMarker take a given predtermined barcode as the pattern to detect. Each barcode has * a predetermined number,

src/BarcodeMarker.ts

PatternMarkerParameters (Interface)

* PatternMarker takes a given image (as a URL) and use this as the pattern to detect to place * a given marker from thr

src/PatternMarker.ts

MarkerPositioningParameters (Interface)

(no doc)

src/Controller.ts

SourceParameters (Interface)

(no doc)

src/Source.ts

BaseMarkerParameters (Interface)

(no doc)

src/BaseMarker.ts

ControllerParameters (Interface)

Core symbols most depended-on inside this repo

addEventListener

called by 34

src/artoolkit/ARToolKitController.ts

dispatchEvent

called by 10

src/artoolkit/ARToolKitController.ts

called by 9

docs/assets/js/main.js

ajax

called by 7

src/artoolkit/ARToolKit.ts

docs/assets/js/main.js

called by 5

docs/assets/js/main.js

load

called by 4

src/artoolkit/ARToolKitCameraParam.ts

Shape

Method 110

Class 15

Function 10

Interface 7

Languages

TypeScript100%

Modules by API surface

src/artoolkit/ARToolKitController.ts57 symbols

src/Controller.ts23 symbols

src/Source.ts19 symbols

src/artoolkit/ARToolKit.ts17 symbols

docs/assets/js/main.js8 symbols

src/artoolkit/ARToolKitCameraParam.ts6 symbols

src/PatternMarker.ts4 symbols

src/BarcodeMarker.ts4 symbols

src/BaseMarker.ts3 symbols

src/THREEAR.ts1 symbols

For agents

$ claude mcp add THREEAR \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/JamesLMilner/THREEAR @v1.0.0

THREE AR

Introduction

Usage

Demo

Documentation and Examples

Development and Contribution

Acknowledgements

License

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

For agents

Ask about this repo answers extend the page