Set the namespace to AR

demos/assets/aframe-with-encantar.js

@@ -11,7 +11,7 @@ __THIS_PLUGIN_HAS_BEEN_TESTED_WITH__({
 });
 
 /**
- * Connect encantar.js to aframe
+ * Do magic to connect encantar.js to aframe
  * @param {(canvas: HTMLCanvasElement) => Promise<Session> | SpeedyPromise<Session>} startARSession
  */
 function encantar(startARSession)
@@ -228,8 +228,8 @@ else
  */
 function __THIS_PLUGIN_HAS_BEEN_TESTED_WITH__(json)
 {
-    try { Martins, AFRAME;
-    const versionOf = { 'encantar.js': Martins.version.replace(/-.*$/, ''), 'aframe': AFRAME.version };
+    try { AR, AFRAME;
+    const versionOf = { 'encantar.js': AR.version.replace(/-.*$/, ''), 'aframe': AFRAME.version };
     const check = (x,v,w) => v !== w ? console.warn(`\n\n\nWARNING\n\nThis plugin has been tested with ${x} version ${v}. The version in use is ${w}. Usage of ${x} version ${v} is recommended instead.\n\n\n`) : void 0;
     for(const [x, expected] of Object.entries(json)) check(x, expected.version, versionOf[x]);
     } catch(e) { alert(e.message); }

demos/assets/three-with-encantar.js

@@ -23,7 +23,7 @@ __THIS_PLUGIN_HAS_BEEN_TESTED_WITH__({
  */
 
 /**
- * Connect encantar.js to three.js
+ * Do magic to connect encantar.js to three.js
  * @param {() => Promise<Session> | SpeedyPromise<Session>} startARSession
  * @param {(ar: ARSystem) => void} [animateVirtualScene] animation callback
  * @param {(ar: ARSystem) => void | Promise<void> | SpeedyPromise<Session>} [initializeVirtualScene] initialization callback
@@ -147,8 +147,8 @@ function encantar(startARSession, animateVirtualScene, initializeVirtualScene)
 function __THIS_PLUGIN_HAS_BEEN_TESTED_WITH__(json)
 {
     window.addEventListener('load', () => {
-    try { Martins, __THREE__;
-    const versionOf = { 'encantar.js': Martins.version.replace(/-.*$/, ''), 'three.js': __THREE__ };
+    try { AR, __THREE__;
+    const versionOf = { 'encantar.js': AR.version.replace(/-.*$/, ''), 'three.js': __THREE__ };
     const check = (x,v,w) => v !== w ? console.warn(`\n\n\nWARNING\n\nThis plugin has been tested with ${x} version ${v}. The version in use is ${w}. Usage of ${x} version ${v} is recommended instead.\n\n\n`) : void 0;
     for(const [x, expected] of Object.entries(json)) check(x, expected.version, versionOf[x]);
     } catch(e) { alert(e.message); }

demos/hello-aframe/demo.js

@@ -1,6 +1,6 @@
 async function startARSession(canvas)
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
@@ -10,15 +10,15 @@ async function startARSession(canvas)
     if(!(canvas instanceof HTMLCanvasElement))
         throw new Error(`startARSession expects a <canvas>`);
 
-    //Martins.Settings.powerPreference = 'low-power';
+    //AR.Settings.powerPreference = 'low-power';
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         canvas: canvas,
         container: document.getElementById('ar-viewport'),
         hudContainer: document.getElementById('ar-hud')
@@ -27,10 +27,10 @@ async function startARSession(canvas)
     const video = document.getElementById('my-video');
     const useWebcam = (video === null);
     const source = useWebcam ?
-        Martins.Source.Camera({ resolution: 'md' }) :
-        Martins.Source.Video(video);
+        AR.Source.Camera({ resolution: 'md' }) :
+        AR.Source.Video(video);
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],

demos/hello-three/demo.js

@@ -99,22 +99,22 @@ window.addEventListener('load', () => {
 
     async function startARSession()
     {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        //Martins.Settings.powerPreference = 'low-power';
+        //AR.Settings.powerPreference = 'low-power';
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport'),
             hudContainer: document.getElementById('ar-hud')
         });
@@ -122,10 +122,10 @@ window.addEventListener('load', () => {
         const video = document.getElementById('my-video');
         const useWebcam = (video === null);
         const source = useWebcam ?
-            Martins.Source.Camera({ resolution: 'md' }) :
-            Martins.Source.Video(video);
+            AR.Source.Camera({ resolution: 'md' }) :
+            AR.Source.Video(video);
 
-        const session = await Martins.startSession({
+        const session = await AR.startSession({
             mode: 'immersive',
             viewport: viewport,
             trackers: [ tracker ],

demos/hello-webgl/demo.js

@@ -911,22 +911,22 @@ window.addEventListener('load', async function() {
 
     async function startARSession()
     {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        //Martins.Settings.powerPreference = 'low-power';
+        //AR.Settings.powerPreference = 'low-power';
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport'),
             hudContainer: document.getElementById('ar-hud')
         });
@@ -934,10 +934,10 @@ window.addEventListener('load', async function() {
         const video = document.getElementById('my-video');
         const useWebcam = (video === null);
         const source = useWebcam ?
-            Martins.Source.Camera({ resolution: 'md' }) :
-            Martins.Source.Video(video);
+            AR.Source.Camera({ resolution: 'md' }) :
+            AR.Source.Video(video);
 
-        const session = await Martins.startSession({
+        const session = await AR.startSession({
             mode: 'immersive',
             viewport: viewport,
             trackers: [ tracker ],

demos/hello-world/demo.js

@@ -15,22 +15,22 @@ window.addEventListener('load', async function() {
 
     async function startARSession()
     {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        //Martins.Settings.powerPreference = 'low-power';
+        //AR.Settings.powerPreference = 'low-power';
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport'),
             hudContainer: document.getElementById('ar-hud')
         });
@@ -38,10 +38,10 @@ window.addEventListener('load', async function() {
         const video = document.getElementById('my-video');
         const useWebcam = (video === null);
         const source = useWebcam ?
-            Martins.Source.Camera({ resolution: 'md' }) :
-            Martins.Source.Video(video);
+            AR.Source.Camera({ resolution: 'md' }) :
+            AR.Source.Video(video);
 
-        const session = await Martins.startSession({
+        const session = await AR.startSession({
             mode: 'immersive',
             viewport: viewport,
             trackers: [ tracker ],

demos/touch-three/demo.js

@@ -129,22 +129,22 @@ window.addEventListener('load', () => {
 
     async function startARSession()
     {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        //Martins.Settings.powerPreference = 'low-power';
+        //AR.Settings.powerPreference = 'low-power';
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport'),
             hudContainer: document.getElementById('ar-hud')
         });
@@ -152,10 +152,10 @@ window.addEventListener('load', () => {
         const video = document.getElementById('my-video');
         const useWebcam = (video === null);
         const source = useWebcam ?
-            Martins.Source.Camera({ resolution: 'md' }) :
-            Martins.Source.Video(video);
+            AR.Source.Camera({ resolution: 'md' }) :
+            AR.Source.Video(video);
 
-        const session = await Martins.startSession({
+        const session = await AR.startSession({
             mode: 'immersive',
             viewport: viewport,
             trackers: [ tracker ],

docs/api/martins.md → docs/api/ar.md

@@ -1,6 +1,6 @@
-# Martins
+# AR
 
-The `Martins` namespace is the entry point of the features and components of encantAR.js.
+The `AR` namespace is the entry point of the features and components of encantAR.js.
 
 I have documented the instantiation of the components of the engine in their respective pages.
 
@@ -8,13 +8,13 @@ I have documented the instantiation of the components of the engine in their res
 
 ### Settings
 
-`Martins.Settings: Settings, read-only`
+`AR.Settings: Settings, read-only`
 
 The [settings](settings.md) of the engine.
 
 ### version
 
-`Martins.version: string, read-only`
+`AR.version: string, read-only`
 
 The version of encantAR.js.
 
@@ -22,7 +22,7 @@ The version of encantAR.js.
 
 ### isSupported
 
-`Martins.isSupported(): boolean`
+`AR.isSupported(): boolean`
 
 Checks if the user agent is capable of running the engine.
 

docs/api/camera-source.md

@@ -4,9 +4,9 @@ A [source of data](source.md) linked to a webcam.
 
 ## Instantiation
 
-### Martins.Source.Camera
+### AR.Source.Camera
 
-`Martins.Source.Camera(settings: object): CameraSource`
+`AR.Source.Camera(settings: object): CameraSource`
 
 Create a new webcam-based source of data with the specified `settings`.
 
@@ -24,7 +24,7 @@ A new webcam-based source of data.
 **Example**
 
 ```js
-const webcam = Martins.Source.Camera({
+const webcam = AR.Source.Camera({
     resolution: 'md+',
     constraints: {
         facingMode: 'environment' // will prefer the rear camera on mobile devices

docs/api/canvas-source.md

@@ -4,9 +4,9 @@ A [source of data](source.md) linked to a `<canvas>` element.
 
 ## Instantiation
 
-### Martins.Source.Canvas
+### AR.Source.Canvas
 
-`Martins.Source.Canvas(canvas: HTMLCanvasElement): CanvasSource`
+`AR.Source.Canvas(canvas: HTMLCanvasElement): CanvasSource`
 
 Create a new source of data linked to the provided `canvas`.
 

docs/api/session.md

@@ -4,9 +4,9 @@ A central component of a WebAR experience. Read the [concepts](../getting-starte
 
 ## Instantiation
 
-### Martins.startSession
+### AR.startSession
 
-`Martins.startSession(options: object): SpeedyPromise<Session>`
+`AR.startSession(options: object): SpeedyPromise<Session>`
 
 Start a new session.
 

docs/api/settings.md

@@ -6,7 +6,7 @@ Engine settings.
 
 ### powerPreference
 
-`Martins.Settings.powerPreference: string`
+`AR.Settings.powerPreference: string`
 
 Power profile. One of the following: `"default"`, `"low-power"`, `"high-performance"`.
 

docs/api/speedy.md

@@ -12,4 +12,4 @@ In this documentation, I provide a quick reference of some of the classes used i
 
 `Speedy: Speedy, read-only`
 
-The `Speedy` namespace is provided in global scope. It's also available as `Martins.Speedy`.
+The `Speedy` namespace is provided in global scope. It's also available as `AR.Speedy`.

docs/api/video-source.md

@@ -4,9 +4,9 @@ A [source of data](source.md) linked to a `<video>` element.
 
 ## Instantiation
 
-### Martins.Source.Video
+### AR.Source.Video
 
-`Martins.Source.Video(video: HTMLVideoElement): VideoSource`
+`AR.Source.Video(video: HTMLVideoElement): VideoSource`
 
 Create a new source of data linked to the provided `video`.
 

docs/api/viewport.md

@@ -4,9 +4,9 @@ The viewport is the area of the web page in which the augmented scene is display
 
 ## Instantiation
 
-### Martins.Viewport
+### AR.Viewport
 
-`Martins.Viewport(settings: object): Viewport`
+`AR.Viewport(settings: object): Viewport`
 
 Create a new viewport with the specified `settings`.
 
@@ -26,7 +26,7 @@ A new viewport.
 **Example**
 
 ```js
-const viewport = Martins.Viewport({
+const viewport = AR.Viewport({
     container: document.getElementById('ar-viewport'),
     resolution: 'lg'
 });

docs/getting-started/activate-your-webcam.md

@@ -9,28 +9,28 @@ Instead of using a video file, we're going to use your webcam. We simply need to
 ```js title="ar-demo.js" hl_lines="20-22"
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport')
     });
 
     //const video = document.getElementById('my-video'); // comment this line
-    //const source = Martins.Source.Video(video); // comment this line
-    const source = Martins.Source.Camera();
+    //const source = AR.Source.Video(video); // comment this line
+    const source = AR.Source.Camera();
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],
@@ -154,29 +154,29 @@ In order to display that scan gimmick, we need to create a HUD (<em>Heads-Up Dis
 ```js title="ar-demo.js" hl_lines="17-18"
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport'),
         hudContainer: document.getElementById('ar-hud')
     });
 
     //const video = document.getElementById('my-video');
-    //const source = Martins.Source.Video(video);
-    const source = Martins.Source.Camera();
+    //const source = AR.Source.Video(video);
+    const source = AR.Source.Camera();
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],
@@ -200,29 +200,29 @@ A simple way to know whether or not we're tracking a target image is to use even
 ```js title="ar-demo.js" hl_lines="34-42"
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport'),
         hudContainer: document.getElementById('ar-hud')
     });
 
     //const video = document.getElementById('my-video');
-    //const source = Martins.Source.Video(video);
-    const source = Martins.Source.Camera();
+    //const source = AR.Source.Video(video);
+    const source = AR.Source.Camera();
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],
@@ -247,36 +247,36 @@ async function startARSession()
 
 ## Hide the gizmos
 
-Let's polish our work even more by hiding the gizmos. You may just set `gizmos` to `false` in `Martins.startSession()` and there will be no more gizmos. Do the same to hide the stats panel.
+Let's polish our work even more by hiding the gizmos. You may just set `gizmos` to `false` in `AR.startSession()` and there will be no more gizmos. Do the same to hide the stats panel.
 
 Let me show you a different approach. Instead of getting rid of the gizmos completely, we're going to hide them partially. They will be displayed when the tracker is scanning the physical scene, but not when the physical scene is being augmented. That's easy to do with the event listeners we have just set up:
 
 ```js title="ar-demo.js" hl_lines="38 43"
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport'),
         hudContainer: document.getElementById('ar-hud')
     });
 
     //const video = document.getElementById('my-video');
-    //const source = Martins.Source.Video(video);
-    const source = Martins.Source.Camera();
+    //const source = AR.Source.Video(video);
+    const source = AR.Source.Camera();
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],

docs/getting-started/next-steps.md

@@ -6,36 +6,36 @@ Let me tell you some of the steps you can take from now on.
 
 ## Change the power preference
 
-Image tracking is no trivial task: lots of computations are being performed behind the scenes. The WebAR engine prioritizes processing performance over power consumption by default. You may reduce power consumption by reducing processing performance. This is simple to do: just set `Martins.Settings.powerPreference` to `"low-power"`.
+Image tracking is no trivial task: lots of computations are being performed behind the scenes. The WebAR engine prioritizes processing performance over power consumption by default. You may reduce power consumption by reducing processing performance. This is simple to do: just set `AR.Settings.powerPreference` to `"low-power"`.
 
 ```js title="ar-demo.js" hl_lines="10"
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    Martins.Settings.powerPreference = 'low-power'; // OPTIONAL
+    AR.Settings.powerPreference = 'low-power'; // OPTIONAL
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport'),
         hudContainer: document.getElementById('ar-hud')
     });
 
     //const video = document.getElementById('my-video');
-    //const source = Martins.Source.Video(video);
-    const source = Martins.Source.Camera();
+    //const source = AR.Source.Video(video);
+    const source = AR.Source.Camera();
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],

docs/getting-started/set-up-the-session.md

@@ -32,20 +32,20 @@ We begin by creating the viewport. Remember that the viewport is the area in whi
 window.onload = async function()
 {
     try {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport')
         });
     }
@@ -63,25 +63,25 @@ Let's set up our source of data. We get the `HTMLVideoElement` corresponding to
 window.onload = async function()
 {
     try {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport')
         });
 
         const video = document.getElementById('my-video');
-        const source = Martins.Source.Video(video);
+        const source = AR.Source.Video(video);
     }
     catch(error) {
         alert(error.message);
@@ -91,33 +91,33 @@ window.onload = async function()
 
 ## Start the session
 
-The session is a central component of a WebAR experience. The `Martins` namespace has a very special method called `startSession`. It receives a settings dictionary that lets us configure the new session in different ways. Add the following code to `ar-demo.js`:
+The session is a central component of a WebAR experience. The `AR` namespace has a very special method called `startSession`. It receives a settings dictionary that lets us configure the new session in different ways. Add the following code to `ar-demo.js`:
 
 ```js title="ar-demo.js" hl_lines="24-31"
 window.onload = async function()
 {
     try {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
         }]);
 
-        const viewport = Martins.Viewport({
+        const viewport = AR.Viewport({
             container: document.getElementById('ar-viewport')
         });
 
         const video = document.getElementById('my-video');
-        const source = Martins.Source.Video(video);
+        const source = AR.Source.Video(video);
 
-        const session = await Martins.startSession({
+        const session = await AR.startSession({
             mode: 'immersive',
             viewport: viewport,
             trackers: [ tracker ],
@@ -160,27 +160,27 @@ window.onload = async function()
 
 async function startARSession()
 {
-    if(!Martins.isSupported()) {
+    if(!AR.isSupported()) {
         throw new Error(
             'This device is not compatible with this AR experience.\n\n' +
             'User agent: ' + navigator.userAgent
         );
     }
 
-    const tracker = Martins.Tracker.ImageTracker();
+    const tracker = AR.Tracker.ImageTracker();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
     }]);
 
-    const viewport = Martins.Viewport({
+    const viewport = AR.Viewport({
         container: document.getElementById('ar-viewport')
     });
 
     const video = document.getElementById('my-video');
-    const source = Martins.Source.Video(video);
+    const source = AR.Source.Video(video);
 
-    const session = await Martins.startSession({
+    const session = await AR.startSession({
         mode: 'immersive',
         viewport: viewport,
         trackers: [ tracker ],

docs/getting-started/set-up-the-tracker.md

@@ -137,14 +137,14 @@ Create a new file called `ar-demo.js` and store it in the `ar-demo/` folder. Wri
 window.onload = async function()
 {
     try {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
     }
     catch(error) {
         alert(error.message);
@@ -152,7 +152,7 @@ window.onload = async function()
 };
 ```
 
-The `Martins` namespace holds the various elements featured by the engine. We'll be using it extensively.
+The `AR` namespace holds the various elements featured by the engine. We'll be using it extensively.
 
 encantAR.js only requires standard web technologies that have been around for a while. Still, it's a good practice to check if those technologies are supported by the target system. If they are not, we display a message and quit. If they are, we instantiate an Image Tracker.
 
@@ -178,14 +178,14 @@ Let's link the image to the tracker. Add the following code to `ar-demo.js`:
 window.onload = async function()
 {
     try {
-        if(!Martins.isSupported()) {
+        if(!AR.isSupported()) {
             throw new Error(
                 'This device is not compatible with this AR experience.\n\n' +
                 'User agent: ' + navigator.userAgent
             );
         }
 
-        const tracker = Martins.Tracker.ImageTracker();
+        const tracker = AR.Tracker.ImageTracker();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')

mkdocs.yml

@@ -64,10 +64,10 @@ nav:
     - 'Demo gallery': 'demos.md'
   - 'API':
     - 'General':
+      - 'AR': 'api/ar.md'
       - 'Session': 'api/session.md'
       - 'Frame': 'api/frame.md'
       - 'Time': 'api/time.md'
-      - 'Martins': 'api/martins.md'
       - 'Settings': 'api/settings.md'
       - 'Resolution': 'api/resolution.md'
     - 'Trackers':

src/core/stats-panel.ts

@@ -26,7 +26,7 @@ import { Viewport } from './viewport';
 import { Tracker } from '../trackers/tracker';
 import { Source } from '../sources/source';
 import { Utils, Nullable } from '../utils/utils';
-import Martins from '../main';
+import AR from '../main';
 
 
 /** Update interval, in ms */
@@ -195,7 +195,7 @@ export class StatsPanel
         container.style.fontSize = '14px';
 
         // all sanitized
-        container.innerText = 'encantAR.js ' + Martins.version;
+        container.innerText = 'encantAR.js ' + AR.version;
 
         print('<br>');
         print('FPS: <span class="_ar_fps"></span> | ');

src/main.ts

@@ -35,7 +35,7 @@ declare const __AR_WEBSITE__: string;
 /**
  * GPU-accelerated Augmented Reality for the web
  */
-export default class Martins
+export default class AR
 {
     /**
      * Start a new session
@@ -111,14 +111,14 @@ export default class Martins
 }
 
 // Freeze the namespace
-Object.freeze(Martins);
+Object.freeze(AR);
 
 // Add Speedy Vision to global scope
 ((window: any) => window.Speedy = window.Speedy || Speedy)(window);
 
 // Display a notice
 Utils.log(
-    `encantAR.js version ${Martins.version}. ` +
+    `encantAR.js version ${AR.version}. ` +
     `GPU-accelerated Augmented Reality for the web by Alexandre Martins. ` +
     __AR_WEBSITE__
 );

webpack.config.js

@@ -13,7 +13,7 @@ module.exports = (env, argv) => ({
         path: path.resolve(__dirname, 'dist'),
         publicPath: '/dist/',
         library: {
-            name: 'Martins',
+            name: 'AR',
             type: 'umd',
             export: 'default',
         },