Merge branch 'dev' into features-other-classes

kalwalt · kalwalt · commit bbd54344dd03 · 2024-03-23T13:19:24.000+01:00
diff --git a/README.md b/README.md
@@ -1,6 +1,28 @@
 # AR.js-threejs
 
-Testing repository for the AR.js core module. I'm converting AR.js code to the Typescript langauge but providing the same classes and structures as much as possible.
+Testing repository for the AR.js core module. I'm converting AR.js code to the Typescript language but providing the same classes and structures as much as possible.
+The module export two namespaces as in the old implementation: **THREEx** and **ARjs**.
+
+## List of classes in the namespaces
+### THREEx:
+- [x] ArBaseControls
+- [x] ArClickability
+- [x] ArMarkerCloak
+- [x] ArMarkerHelper
+- [x] ArMarkerControls
+- [x] ArSmoothedControls
+- [x] ArToolkitContext
+- [x] ArToolkitSource
+- [x] ArToolkitProfile
+- [x] ArVideoinwebgl
+- [x] HittestingPlane
+
+### ARjs:
+
+- [x] Source
+- [x] Context
+- [x] Profile
+- [x] Utils
 
 ## Examples
-For now, you can find one **example** in vanilla JS and another one in Typescript in the **example-ts** folder. More examples will be added in a near future.
+For now, you can find two vanilla JS examples in the **examples** folder and another one in Typescript in the **example-ts** folder. More examples will be added in a near future.
diff --git a/dist/ar.js b/dist/ar.js
diff --git a/example-ts/dist/bundle.js b/example-ts/dist/bundle.js
diff --git a/example-ts/package-lock.json b/example-ts/package-lock.json
diff --git a/example-ts/package.json b/example-ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "example-ts",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "simple ar.js-threejs typescript example",
   "main": "index.ts",
   "scripts": {
diff --git a/examples/basic.html b/examples/basic.html
@@ -8,7 +8,7 @@
 
 <body style='font-family: Monospace;'>
 	<div style='position: absolute; top: 10px; width:100%; text-align: center; z-index: 1;'>
-		<a href="https://github.com/AR-js-org/AR.js/" target="_blank">AR.js</a> - three.js camera transform
+		<a href="https://github.com/AR-js-org/AR.js-threejs/" target="_blank">AR.js</a> - three.js camera transform
 		<br />
 		Contact me any time at <a href='https://twitter.com/nicolocarp' target='_blank'>@nicolocarp</a>
 	</div>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ar-js-org/ar.js-threejs",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "AR.js (THREEx, ARjs) modular package - Typescript version",
   "main": "dist/ar.js",
   "types": "types/index.d.ts",
diff --git a/src/ArMarkerCloak.ts b/src/ArMarkerCloak.ts
@@ -173,8 +173,8 @@ export class ArMarkerCloak {
             opacity: 0.5,
             side: THREE.DoubleSide,
         });
-        var geometry = new THREE.PlaneGeometry(1, 1);
-        var orthoMesh = new THREE.Mesh(geometry, material);
+        var ortoGeometry = new THREE.PlaneGeometry(1, 1);
+        var orthoMesh = new THREE.Mesh(ortoGeometry, material);
         this.orthoMesh = orthoMesh;
         //return;
     }
diff --git a/src/ArToolkitContext.ts b/src/ArToolkitContext.ts
@@ -114,7 +114,7 @@ export class ArToolkitContext implements IArToolkitContext {
     removeEventListener = EventDispatcher.prototype.removeEventListener;
 
     static baseURL = "https://ar-js-org.github.io/AR.js/three.js/";
-    static REVISION = "3.4.3-threejs-0.1.1";
+    static REVISION = "3.4.3-threejs-0.2.0";
 
     /**
      * Create a default Camera 
diff --git a/src/CommonInterfaces/THREEx-interfaces.ts b/src/CommonInterfaces/THREEx-interfaces.ts
@@ -97,6 +97,15 @@ export interface IDefaultMarkerParameters {
     markersAreaEnabled: boolean
 }
 
+export interface ISmoothedControlsParameters {
+    lerpPosition: number,
+    lerpQuaternion: number,
+    lerpScale: number,
+    lerpStepDelay: number,
+    minVisibleDelay: number,
+    minUnvisibleDelay: number
+}
+
 export interface ISourceParameters {
     sourceType?: string,
     sourceUrl?: string,
diff --git a/src/index.ts b/src/index.ts
@@ -11,14 +11,14 @@ import { HitTestingPlane as _HitTestingPlane } from "./HitTestingPlane";
 import { Context as _Context } from "./Context";
 import { Profile as _Profile } from "./Profile";
 import { Source as _Source } from "./Source";
-
 import { Anchor as _Anchor } from "./new-api/Anchor";
 import { Session as _Session } from "./new-api/Session";
 import { SessionDebugUI as _SessionDebugUI } from "./new-api/SessionDebugUI";
 import { AnchorDebugUI as _AnchorDebugUI } from "./new-api/SessionDebugUI";
 import { Utils as _Utils } from "./new-api/Utils";
 import { HitTesting as _HitTesting } from "./new-api/HitTesting";
 
+
 export namespace THREEx {
   export const ArClickability = _ArClickability;
   export const ArSmoothedControls = _ArSmoothedControls;
@@ -34,6 +34,7 @@ export namespace THREEx {
 
 export namespace ARjs {
   export const Anchor = _Anchor;
+  export const Context = _Context;
   export const Profile = _Profile;
   export const Session = _Session;
   export const SessionDebugUI = _SessionDebugUI;
diff --git a/types/CommonInterfaces/THREEx-interfaces.d.ts b/types/CommonInterfaces/THREEx-interfaces.d.ts
@@ -13,6 +13,10 @@ export interface IArSmoothedControls {
     parameters: ISmoothedControlsParameters;
     update(targetObject3d: any): void;
 }
+export interface IArSmoothedControls {
+    parameters: ISmoothedControlsParameters;
+    update(targetObject3d: any): void;
+}
 export interface IArToolkitContext {
     parameters: IContextParameters;
     arController: any;
@@ -88,6 +92,14 @@ export interface IDefaultMarkerParameters {
     changeMatrixMode: string;
     markersAreaEnabled: boolean;
 }
+export interface ISmoothedControlsParameters {
+    lerpPosition: number;
+    lerpQuaternion: number;
+    lerpScale: number;
+    lerpStepDelay: number;
+    minVisibleDelay: number;
+    minUnvisibleDelay: number;
+}
 export interface ISourceParameters {
     sourceType?: string;
     sourceUrl?: string;
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -28,6 +28,7 @@ export declare namespace THREEx {
 }
 export declare namespace ARjs {
     const Anchor: typeof _Anchor;
+    const Context: typeof _ArToolkitContext;
     const Profile: typeof _ArToolkitProfile;
     const Session: typeof _Session;
     const SessionDebugUI: typeof _SessionDebugUI;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "example-ts",`
`3`		`- "version": "0.1.0",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"description": "simple ar.js-threejs typescript example",`
`5`	`5`	`"main": "index.ts",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@ar-js-org/ar.js-threejs",`
`3`		`- "version": "0.1.1",`
	`3`	`+ "version": "0.2.0",`
`4`	`4`	`"description": "AR.js (THREEx, ARjs) modular package - Typescript version",`
`5`	`5`	`"main": "dist/ar.js",`
`6`	`6`	`"types": "types/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ export declare namespace THREEx {`
`28`	`28`	`}`
`29`	`29`	`export declare namespace ARjs {`
`30`	`30`	`const Anchor: typeof _Anchor;`
	`31`	`+ const Context: typeof _ArToolkitContext;`
`31`	`32`	`const Profile: typeof _ArToolkitProfile;`
`32`	`33`	`const Session: typeof _Session;`
`33`	`34`	`const SessionDebugUI: typeof _SessionDebugUI;`