Merge pull request #59 from artoolkitx/phil-trackables-internal-rework

Phil trackables internal rework

Author: philip-lamb

.gitignore

@@ -55,15 +55,15 @@ Source/Package/UserSettings
 
 #### Plugin source packages and binaries
 Source/artoolkit[xX]-*.zip
-Source/artoolKitX.*.dmg
-Source/Package/Assets/Plugins/ARX.bundle
-Source/Package/Assets/Plugins/ARX.bundle.meta
-Source/Package/Assets/Plugins/Android/libs/arm64-v8a/*.so
-Source/Package/Assets/Plugins/Android/libs/armeabi-v7a/*.so
-Source/Package/Assets/Plugins/Android/libs/x86/*.so
-Source/Package/Assets/Plugins/Android/libs/x86_64/*.so
-Source/Package/Assets/Plugins/iOS/*.a
-Source/Package/Assets/Plugins/x86/*.dll
-Source/Package/Assets/Plugins/x86_64/*.dll
+Source/artoolkit[xX]*.dmg
+Source/Package/Assets/artoolkitX-Unity/Plugins/ARX.bundle
+Source/Package/Assets/artoolkitX-Unity/Plugins/ARX.bundle.meta
+Source/Package/Assets/artoolkitX-Unity/Plugins/Android/libs/arm64-v8a/*.so
+Source/Package/Assets/artoolkitX-Unity/Plugins/Android/libs/armeabi-v7a/*.so
+Source/Package/Assets/artoolkitX-Unity/Plugins/Android/libs/x86/*.so
+Source/Package/Assets/artoolkitX-Unity/Plugins/Android/libs/x86_64/*.so
+Source/Package/Assets/artoolkitX-Unity/Plugins/iOS/*.a
+Source/Package/Assets/artoolkitX-Unity/Plugins/x86/*.dll
+Source/Package/Assets/artoolkitX-Unity/Plugins/x86_64/*.dll
 
 #### Other

Documentation/README (ARToolKit5-5.3-utils).txt

@@ -0,0 +1,75 @@
+Read me for artoolkitX utilities package.
+========================================
+
+
+Contents.
+---------
+
+About this archive.
+Running the utilities.
+Usage information.
+
+About this archive.
+-------------------
+
+This archive contains the artoolkitX utilities.
+
+artoolkitX utilities are made available to you under the GNU Lesser General Public License, version 3 (LGPLv3).
+
+artoolkitX utilities package is designed to run on Windows and Macintosh OS X platforms.
+
+
+Running the utilities
+---------------------
+
+artoolkitX includes a set of utilities to perform essential functions required by artoolkitX and/or arunityX. After installation, the executables for these utilities can be found in the SDK/bin directory inside your artoolkitX directory.
+
+  Windows:
+
+	Each utility can be opened by double-clicking its icon in the artoolkitX\SDK\bin directory. Alternately, you can run it from the command line:
+
+	* Open a command-line window (cmd.exe).
+	* Navigate to your artoolkitX\SDK\bin directory.
+	* Type (for example): artoolkitx_mk_patt.exe
+
+  Mac OS X:
+  
+    The utilities should be launched from a Terminal window:
+  
+    * Open a Terminal window (/Applications/Utilties/Terminal).
+	* Navigate to your artoolkitX/SDK/bin directory.
+	* Type (for example): ./artoolkitx_mk_patt
+
+
+Which utilities are included:
+-----------------------------
+
+Camera calibration utilities:
+ * artoolkitx_calib_camera
+ * artoolkitx_calib_optical
+ 
+Square marker utilities:
+ * artoolkitx_mk_patt
+ * artoolkitx_check_id
+ * artoolkitx_genMarkerSet
+
+2D texture trackable utilities:
+ * artoolkitx_check_image_2d_tracking
+ * artoolkitx_image_database2d
+ 
+Legacy natural feature tracking (NFT) utilities:
+ * artoolkitx_genTexData
+ * artoolkitx_dispImageSet
+ * artoolkitx_dispFeatureSet
+ * artoolkitx_checkResolution
+ 
+Required patterns for the utilities, which you can print out, are found in the folder "patterns" inside the "doc" folder. Images for sample 2D trackables and NFT markers are in the folder "Marker images" inside the "doc" folder.
+
+
+Usage information
+-----------------
+Documentation for the utilities is held in the artoolkitX documentation wiki: https://github.com/artoolkitx/artoolkitx/wiki
+        
+
+--
+EOF

Documentation/README (artoolkitX utils).txt

@@ -0,0 +1,6 @@
+[InternetShortcut]
+URL=https://au.gmented.com/app/marker/marker.php
+IDList=
+HotKey=0
+IconFile=C:\Users\phil\AppData\Local\Mozilla\Firefox\Profiles\xu4hvgla.dev-edition-default\shortcutCache\U0txz335RpHtDaQqUQoLtw==.ico
+IconIndex=0

Documentation/patterns/Marker generator (online).url

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>URL</key>
+	<string>https://au.gmented.com/app/marker/marker.php</string>
+</dict>
+</plist>

Documentation/patterns/Marker generator (online).webloc

@@ -9,17 +9,25 @@ As a quick start with Unity and artoolkitX you can use one of the example scenes
 
 - [Unity](https://store.unity.com/) - the free, Personal Edition, is sufficient for a start. Version 2021.3 was used at the time of this writing. The Unity Editor is supported on the desktop platforms of macOS and Windows.
 
-### Build arunityX
-You need to run the build script before you can use this repository. The reason for this is, that arunityX does not ship with the artoolkitX libraries, but it downloads them when you run the build script. It is designed this way to assure arunityX always uses a stable and up to date release of artoolkitX libraries. The version in question is noted in the artoolkitx-version.txt in the root of this repository.
+### Build or fetch artoolkitX libraries
+
+If using the artoolkitX for Unity package from source, please note that the source repository does not include the compiled artoolkitX native plugins, so it is necessary to fetch the artoolkitX libraries, or alternately build artoolkitX from source. The `build.sh` script controls this. Normally it downloads the version of artoolkitX as listed in the artoolkitx-version.txt in the root of this repository:
 
 1. Open Terminal on macOS or Git Bash on Windows
-2. ```cd Source```
-3. Run ```./build.sh [Target platform]```. ```[Target platform]``` can be one or several of *macos, ios, android, windows*
+2. `cd Source`
+3. Run `./build.sh [Target platform(s)]`, where `[Target platform(s)]` is one or more of *macos, ios, android, windows*.
 
 This will fetch all the dependencies and place them inside the ```Plugins``` directory.
 
+Alernately, if you wish to build artoolkitX from source (e.g. if modifying the native plugin source, or doing native debugging), then you can get artoolkitX via the git submodule and build it as below:
+1. Open Terminal on macOS or Git Bash on Windows
+2. `cd Source`
+3. `git submodule init`
+4. `git submodule update`
+5. `./build.sh --dev [Target platform(s)]`, where `[Target platform(s)]` is one or more of *macos, ios, android, windows*. Note that you will only be able to build for mac OS or iOS on a mac OS host, for Windows on a Windows host, and Linux on a Linux host. Android can be built on any host platform. 
+
 ### Bundle the arunityX.unitpackage
-To create a arunityX.unitypackage, which can be imported into other Unity3D projects, one needs to run ```./package.sh``` located inside the ```packaging``` directory.
+To create a arunityX.unitypackage, which can be imported into other Unity3D projects, one needs to run `./package.sh` located inside the `packaging` directory.
 
 
 ### Import the arunityX.unitypackge Plugin
@@ -46,7 +54,3 @@ Navigate to:
 * Select the 'Play'-Button to run the scene inside the Unity3D Editor
 * Present on or multiple of the trackables to the camera. A cube should appear on the trackable.
 
-### Building for iOS with XCode
-
-You may get `Error: Undefined symbols for architecture arm64:   "_vImageRotate90_ARGB8888"` which means you need to add the Accelerate.framework to your build:
-In the project settings editor, select the "Build Phases" tab, and click the small triangle next to "Link Binary With Libraries" to view all of the frameworks in your application. Click the "+" below the list of frameworks and add the `Accelerate.framework`

Quick start.md

@@ -0,0 +1,67 @@
+# artoolkitX for Unity Release Notes
+------------------------------------
+
+## Version 1.1.7
+### 2023-05-08
+
+Changes:
+ * The native plugins folder has been moved inside the artoolkitX-Unity subfolder of the Unity package.
+ * Added support for runtime auto-detection of barcode (matrix code) markers. When enabled, a new
+ callback in ARTrackable will auto-add a new ARTrackable for each matrix code trackable detected.
+ * Improved support for GlobalID barcode markers.
+
+## Version 1.1.6
+### 2023-04-21
+ 
+Bug fixes:
+ * Fix ARControllerEditor serialization; changes made to ARController in the Unity Editor should be saved now.
+ * Correct origin on 2D trackable gizmos. Correct prototype for plugin function for pattern image retrieval. Unload when changing trackable properties.
+
+## Version 1.1.5
+### 2023-04-12
+
+Changes:
+ * Refactored ARTrackable to add factory methods for creating new trackables at run time, plus one-shot config for different trackable types.
+ * Change ARController to be findable by singleton instance.
+ * Corrected 2D planar tracker orientation and scaling issues.
+ * Clarified that "2D tracker scale factor" specifies image width, not height. 
+ * Overhauled ARPattern handling, including new support for 2D and NFT surfaces, plus barcodes. 
+
+## Version 1.1.4
+### 2023-03-30
+
+Changes:
+ * Corrected a long-standing Windows bug that affected 2D planar tracking with 32-bit video formats.
+ * Updated the OpenCV build used by the 2D planar tracker on Windows and switched to static OpenCV libraries. This saves users from having to deploy the OpenCV DLLs alongside built apps.
+
+## Version 1.1.3
+### 2023-03-23
+
+Changes:
+ * Added support for setting the number of 2D planar tracker markers that can be simultaneously tracked.
+
+## Version 1.1.2
+### 2023-03-16
+
+This is the first official artoolkitX for Unity release in some time. As the project is now using continuous integration and deployment (CI/CD) releases will be a lot more frequent.
+
+Changes:
+ * Added some extra tracking example images.
+ * Video source input config is now automatically fetched and can be configured in the Unity Editor or at runtime using the new ARVideoConfig component. This component will automatically be added when first adding an ARController to a new scene.
+ * A new native video input module (Camera2) on Android removes the requirement for pushing of video frames from Java code over JNI. Some video configuration options have changed. artoolkiX for Unity will automatically add "-native" to the video configuration string to use the new module.
+ * Updated artoolkitX dependency. Now downloads release artoolkitX packages; special Unity-only packages  are no longer required. Also better support for developer mode building of artoolkitX.
+ * Only runs tracking update on new frames.
+ * Added pinball image and 2D tracker scene.
+ * Updated Unity download/install scripts.
+ * 64-bit libs on Android are now in the Unity package.
+ * Unity settings update for Unity 2021.3.
+ * Android projects update to target API 33, minimum API 21 (Android 5.0), with Gradle 7.6, Android Gradle plugin 7.2.2.
+ * On Android, the minimum supported OS is now Android 7.0 (API level 24).
+ * On iOS, the minimum supported OS is now iOS v11.0.
+ * On mac OS, full support for the ARM64 (Apple Silicon) CPU. The minimum supported OS is now mac OS 10.13.
+ * On Windows, the default Visual Studio version is now VS 2019.
+ * On Linux, the system OpenCV implementation is preferred.
+ * Removed dependence on opencv imread(), and therefore highgui, imgcodecs, and various image libs.
+
+--
+EOF

Release Notes.md

@@ -246,7 +246,7 @@ public enum ARToolKitMatrixCodeType
         AR_MATRIX_CODE_5x5_BCH_22_12_5 = 0x05 | 0x400,
         AR_MATRIX_CODE_5x5_BCH_22_7_7 = 0x05 | 0x500,
         AR_MATRIX_CODE_6x6 = 0x06,
-        //        AR_MATRIX_CODE_GLOBAL_ID = 0x0e | 0xb00
+        AR_MATRIX_CODE_GLOBAL_ID = 0x0e | 0xb00
     };
 
     public enum ARToolKitImageProcMode
@@ -380,6 +380,10 @@ public struct ARVideoSourceInfoT
     private int currentTwoDMaxMarkersToTrack = 1;
     [SerializeField]
     private AR_LOG_LEVEL currentLogLevel = AR_LOG_LEVEL.AR_LOG_LEVEL_INFO;
+    [SerializeField]
+    private bool currentSquareMatrixModeAutocreateNewTrackables = false;
+    [SerializeField]
+    private float currentSquareMatrixModeAutocreateNewTrackablesDefaultWidth = 0.08f;
 
     private ARVideoConfig arvideoconfig = null;
 
@@ -752,6 +756,8 @@ public bool StartAR()
             ImageProcMode = currentImageProcMode;
             NFTMultiMode = currentNFTMultiMode;
             TwoDMaxMarkersToTrack = currentTwoDMaxMarkersToTrack;
+            SquareMatrixModeAutocreateNewTrackables = currentSquareMatrixModeAutocreateNewTrackables;
+            SquareMatrixModeAutocreateNewTrackablesDefaultWidth = currentSquareMatrixModeAutocreateNewTrackablesDefaultWidth;
 
             // Prevent display sleep.
             Screen.sleepTimeout = SleepTimeout.NeverSleep;
@@ -1351,6 +1357,32 @@ public bool UseVideoBackground
         }
     }
 
+    public bool SquareMatrixModeAutocreateNewTrackables
+    {
+        get => currentSquareMatrixModeAutocreateNewTrackables;
+        set
+        {
+            currentSquareMatrixModeAutocreateNewTrackables = value;
+            if (_running)
+            {
+                PluginFunctions.arwSetSquareMatrixModeAutocreateNewTrackables(value, currentSquareMatrixModeAutocreateNewTrackablesDefaultWidth, ARTrackable.OnTrackableEvent);
+            }
+        }
+    }
+
+    public float SquareMatrixModeAutocreateNewTrackablesDefaultWidth
+    {
+        get => currentSquareMatrixModeAutocreateNewTrackablesDefaultWidth;
+        set
+        {
+            currentSquareMatrixModeAutocreateNewTrackablesDefaultWidth = value;
+            if (_running)
+            {
+                PluginFunctions.arwSetSquareMatrixModeAutocreateNewTrackables(currentSquareMatrixModeAutocreateNewTrackables, value, ARTrackable.OnTrackableEvent);
+            }
+        }
+    }
+
     //
     // Internal methods.
     //