AR ColorMapping

[![GitHub release (latest by date)](https://camo.githubusercontent.com/efe1a70b0d09ae62c4921cf83c960f6a08e79d480890cc07f72ad9eff337045c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d346363353165)](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/) [![GitHub top language](https://camo.githubusercontent.com/96a859ada0adc4809e831c374e50cdbe27fe07b6133bfac57b5b4e5148d4cc3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d313038316332)](https://github.com/airar-dev/Unity-AR-ColorMapping/search?l=c%23) [![GitHub License](https://camo.githubusercontent.com/023105ab7cc38ebac8285f09fe5754f32a2ff3df59fa764e666e1c5804abc2eb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d663438303431)](https://opensource.org/licenses/BSD-3-Clause) [![GitHub Watchers](https://camo.githubusercontent.com/d530debeea4badd7774c2b671f48584ef97c0c49c83ace9495b5cd5633b620fd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f77617463686572732f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d346363353165)](https://github.com/airar-dev/Unity-AR-ColorMapping/watchers) [![GitHub Repo stars](https://camo.githubusercontent.com/3b71b5cd2f3132cc2d773523cee7d44e8a7a803a5dc7d0ddf2dd0ffc470ef84c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d346363353165)](https://github.com/airar-dev/Unity-AR-ColorMapping/stargazers) [![GitHub Forks](https://camo.githubusercontent.com/d37a31ac292eaab9bb31d93159c721ddbabce5bc6993e8f465ccf976a7cd930d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f61697261722d6465762f556e6974792d41522d436f6c6f724d617070696e673f636f6c6f723d346363353165)](https://github.com/airar-dev/Unity-AR-ColorMapping/network/members)
[![Unity Badge](https://camo.githubusercontent.com/7b674d7cddb3890fba2bb2b759a40afc7b7ff701d8f6c94a1ded010b3b448562/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d556e69747933445f323032322e332e3466312d3030303f6c6f676f3d756e697479266c696e6b3d68747470733a2f2f756e6974792e636f6d2f)](https://unity.com/) [![Visual Studio Badge](https://camo.githubusercontent.com/bae00d9c3b241b62828ddf246b2d58d98e4d59219ce174a2278c6c3b7b0448a2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d56697375616c5f53747564696f5f323032322d3543324439313f6c6f676f3d76697375616c2d73747564696f266c696e6b3d68747470733a2f2f76697375616c73747564696f2e6d6963726f736f66742e636f6d2f)](https://visualstudio.microsoft.com/) [![OS And Badge](https://camo.githubusercontent.com/90f2d8bd2be96cb6356f4040907ece7b19aa01d628118d4bee4fc6a27af27757/687474703a2f2f696d672e736869656c64732e696f2f62616467652f2d6f70656e63765f332e342e31305f616e64726f69645f73646b2d3344444338343f6c6f676f3d416e64726f6964266c6f676f436f6c6f723d666666266c696e6b3d68747470733a2f2f6f70656e63762e6f72672f72656c65617365732f)](https://opencv.org/releases/) [![OS IOS Badge](https://camo.githubusercontent.com/0289bd2313cc4a022ccf92341380a48f864aab4abafdf0f95c6846cd6458d49c/687474703a2f2f696d672e736869656c64732e696f2f62616467652f2d6f70656e63762e6672616d65776f726b2d3966396639663f6c6f676f3d694f53266c6f676f436f6c6f723d666666266c696e6b3d68747470733a2f2f6f70656e63762e6f72672f72656c65617365732f)](https://opencv.org/releases/)

This project is an easy-to-apply AR Coloring Library for Unity.
This project can be applied to AR Engines of MaxstAR, EasyAR, Vuforia, ARFoundation(ARkit, ARcore).
To use it for business projects, you need to purchase a separate license for the AR Engine.

View Demo

## Table of Contents * [Requirements](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#requirements) * [Installation](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#installation) * [Quick Start](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#quick-start) * [with MaxstAR](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#with-maxstar) * [with EasyAR](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#with-easyar) * [with Vuforia](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#with-vuforia) * [with ARFoundation(ARkit, ARcore)](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#with-arfoundationarkit-arcore) * [Release](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#release) * [Future Release](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#Future-release) * [Trouble Shooting](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#Trouble-shooting) * [Known Issues](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#known-issues) * [Contributing](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#contributing) * [License](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#license) * [Contact](https://github.com/airar-dev/Unity-AR-ColorMapping/raw/master/#contact)
## Requirements * Unity3D 2019.3.14f1 * MaxstAR 5.0.2v * EasyAR 3.1.0v * Vuforia Engine AR Unity Package 9.5.4v * ARFoundation 2.1.8v * Visual Studio 2019 * opencv-3.4.10-android-sdk * opencv.framework(*3.4.11 version)
The opencv library can be downloaded from the official website.
Download the opencv from this link (https://opencv.org/releases/).

**\* As of August 3, 2021, the latest version of Unity3D and the latest version of each AR engine have been tested.** * Unity3D 2021.1.6f1 * MaxstAR 5.0.5v * EasyAR 4.3.0v * Vuforia Engine AR Unity Package 10.0v * ARFoundation 4.1.7v

**\* As of July 21, 2023, the latest version of Unity3D and the latest version of each AR engine have been tested.** * Unity3D 2022.3.4f1 * MaxstAR 6.0.1v * EasyAR 4.6.2v * Vuforia Engine AR Unity Package 10.16.3v * ARFoundation 5.0.6v
## Installation 　1. Clone a repository or download it as zip. ``` git clone https://github.com/airar-dev/ColorMapping.git ``` 　2. Importing the AR Engine SDK to be used together.
　　(You can use MaxstAR, EasyAR, Vuforia, ARFoundation(ARkit, ARcore))

## 3D Guide https://youtu.be/2-h8aBLddjY

## Quick Start ### with MaxstAR **Create Android App Project Demo(https://youtu.be/JhixOsRKQ5k)**
**Create iOS App Project Demo(https://youtu.be/h3YQMaf7R-E)**

　**1. Create Project**
　-　Create an empty Unity3D project.

　**2. Import [MaxstAR](https://developer.maxst.com/MD/downloadsdk)**
　-　Import MaxstAR SDK(5.0.2v +).

　**3. Import Sample Package**
　-　After extracting the downloaded file,
　　 import ColorMappingWithMaxstARSample.unitypackage from
　　 ColorMapping-master -> Sample folder.

　**4. Import Native Library**
　-　Import ‘libAirarColorMap.so, libopencv_java3.so’ file for Android.
　　(Set the CPU to ARM64 in the platform settings of the libAirarColorMap.so, libopencv_java3.so files.)
　-　Import ‘libAirarColorMap.a, opencv2.framework’ file for iOS.

　**5. Player Settings for Android**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add ‘USE_MAXSTAR’ into Scripting Define Symbols

　**6. Player Settings for iOS**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add ‘USE_MAXSTAR’ into Scripting Define Symbols

　**7. Setting for 3D Contents**

‘coloring’ tag　　　　　

Set ‘coloring’ tag for Object containing the material
to which the colored texture is applied

　**8. MaxstARColorMapping.cs**

![masxtar-1]

trackableBehaviour	MaxstAR ImageTrackableBehaviour
ARContents	3D object to augment
RealWidth	Actual horizontal size of the marker image
RealHeight	Actual vertical size of the marker image

　**9. Build**
　-　Build by selecting the MaxstARSample scene under ColorMapping -> Scenes.

### with EasyAR **Create Android App Project Demo(https://youtu.be/elk7-E3LDYc)**
**Create iOS App Project Demo(https://youtu.be/bcKe0nKg5fg)**

　**1. Create Project**
　-　Create an empty Unity3D project.

　**2. Initialize [EasyAR](https://www.easyar.com/view/download.html)**
　-　EasyAR 3.1.0 Version + required.
　-　For EasyAR to work, a license key is required.

　**3. Import Sample Package**
　-　After extracting the downloaded file,
　　 import ColorMappingWithEasyARSample.unitypackage from
　　 ColorMapping-master -> Sample folder.

　**4. Import Native Library**
　-　Import ‘libAirarColorMap.so, libopencv_java3.so’ file for Android.
　　(Set the CPU to ARM64 in the platform settings of the libAirarColorMap.so, libopencv_java3.so files.)
　-　Import ‘libAirarColorMap.a, opencv2.framework’ file for iOS.

　**5. Player Settings for Android**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Graphics APIs	Remove Vulkan from the Graphic API list
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_EASYAR' into Scripting Define Symbols

　**6. Player Settings for iOS**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Graphics APIs	Remove Metal from the Graphic API list
Scripting Backend	Select IL2CPP
Architecture	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_EASYAR' into Scripting Define Symbols

　**7. Setting for 3D Contents**

‘coloring’ tag　　　　　

Set ‘coloring’ tag for Object containing the material
to which the colored texture is applied

　**8. EasyARColorMapping.cs**

![easyar-1]

ImageTargetController	EasyAR ImageTargetController
ARContents	3D object to augment
RealWidth	Actual horizontal size of the marker image
RealHeight	Actual vertical size of the marker image

　**9. Build**
　-　Build by selecting the EasyARSample scene under ColorMapping -> Scenes.

### with Vuforia **Create Android App Project Demo(https://youtu.be/b5zSwDiwE4Q)**
**Create iOS App Project Demo(https://youtu.be/s1TcKE2PzXk)**

　**1. Create Project**
　-　Create an empty Unity3D project.

　**2. Import Vuforia Unity Package**
　-　Importing the Vuforia Engine AR Unity Package(9.5.4v +).

　**3. Import Sample Package**
　-　After extracting the downloaded file,
　　 import ColorMappingWithVuforiaSample.unitypackage from
　　 ColorMapping-master -> Sample folder.

　**4. Import Native Library**
　-　Import ‘libAirarColorMap.so, libopencv_java3.so’ file for Android.
　　(Set the CPU to ARM64 in the platform settings of the libAirarColorMap.so, libopencv_java3.so files.)
　-　Import ‘libAirarColorMap.a, opencv2.framework’ file for iOS.

　**5. Player Settings for Android**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_VUFORIA' into Scripting Define Symbols

　**6. Player Settings for iOS**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_VUFORIA' into Scripting Define Symbols

　**7. Setting for 3D Contents**

‘coloring’ tag　　　　　

Set ‘coloring’ tag for Object containing the material
to which the colored texture is applied

　**8. VuforiaColorMapping.cs**

![vuforia-1]

ImageTaget	Vuforia ImageTargetBehaviour
ARContents	3D object to augment
RealWidth	Actual horizontal size of the marker image
RealHeight	Actual vertical size of the marker image

　**9. Build**
　-　Build by selecting the VuforiaSample scene under ColorMapping -> Scenes.

### with ARFoundation(ARkit, ARcore) **Create Android App Project Demo(https://youtu.be/nR0D5B6s6dA)**
**Create iOS App Project Demo(https://youtu.be/lzDVS_dOwV4)**

　**1. Create Project**
　-　Create an empty Unity3D project.

　**2. Import ARFoundation Unity Package**
　-　Importing the ARFoundation(2.1.8v +),
　　 ARCore(for Android)(2.1.11v +), ARKit(for iOS)(2.1.9v +) Unity Package.

　**3. Import Sample Package**
　-　After extracting the downloaded file,
　　 import ColorMappingWithARFoundationSample.unitypackage from
　　 ColorMapping-master -> Sample folder.

　**4. Import Native Library**
　-　Import ‘libAirarColorMap.so, libopencv_java3.so’ file for Android.
　　(Set the CPU to ARM64 in the platform settings of the libAirarColorMap.so, libopencv_java3.so files.)
　-　Import ‘libAirarColorMap.a, opencv2.framework’ file for iOS.

　**5. Player Settings for Android**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Target Architectures	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_ARFOUNDATION' into Scripting Define Symbols
Minimum API Level	Android 7.0(API Level 24)+

　**6. Player Settings for iOS**

Allow 'unsafe' code	Check the Allow 'unsafe' code
Scripting Backend	Select IL2CPP
Architecture	Check Arm64 architecture(uncheck ARM7)
Scripting Define Symbols	Add 'USE_ARFOUNDATION' into Scripting Define Symbols
Target minimum iOS Version	11.0+

　**7. Setting for 3D Contents**

‘coloring’ tag　　　　　

Set ‘coloring’ tag for Object containing the material
to which the colored texture is applied

　**8. ARFoundationColorMapping.cs**

![arfoundation-1]

ImageManager	ARTrackedImageManager
ARContents	3D object to augment
RealWidth	Actual horizontal size of the marker image
RealHeight	Actual vertical size of the marker image

　**7. Build**
　-　Build by selecting the ARFoundationSample scene under ColorMapping -> Scenes.

## Release | Version | New Features | Date | |:---:|---|:---:| | 　v1.3.4　 | [the latest version of Unity3D and the latest version of each AR engine have been tested.](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.3.4) | 　2023.07.21　 | | 　v1.3.3　 | [Upload samples compatible with the latest version of Vuforia](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.3.3) | 　2023.05.31　 | | 　v1.3.2　 | [Upload samples compatible with the latest version of Vuforia](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.3.2) | 　2022.11.30　 | | 　v1.3.1　 | [the latest version of Unity3D and the latest version of each AR engine have been tested.](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.3.1) | 　2021.08.03　 | | 　v1.3.0　 | [update all sample for Android/iOS](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.3.0) | 　2020.10.27　 | | 　v1.2.1　 | [modify sample unitypackages for android](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/1.2.1) | 　2020.10.23　 | | v1.2.0 | [update android sample](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/v1.2.0) | 2020.10.23 | | v1.1.0 | [add iOS Library](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/3) | 2020.10.21 | | v1.0.1 | [add EasyAR sample](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/2) | 2020.10.07 | | v1.0.0 | [Apply MaxstAR, EasyAR](https://github.com/airar-dev/Unity-AR-ColorMapping/releases/tag/v1.0.0) | 2020.09.09 |
## Future Release * We will add a method for creating coloring 3D content in the near future.
## Trouble Shooting * If an error such as "Undefined symbols for architecture arm64" occurs.
　　example:
``` Undefined symbols for architecture arm64: "cv::getPerspectiveTransform(cv::Point_ const*, cv::Point_ const*)", referenced from: _ImageProc in libAirarColorMap.a(AirarColorMap.o) (maybe you meant: cv::getPerspectiveTransform(cv::Point_ const*, cv::Point_ const*, int)) ld: symbol(s) not found for architecture arm64 clang: error: linker command failed with exit code 1 (use -v to see invocation) ```
　　solutions:
　　Be sure to use **version 3.4.11 of the opencv framework.**

## Known issues * The coloring is not very accurate when used with the MaxstAR engine.
## Contributing * Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

　1.　Fork the Project.
　2.　Create your Feature Branch.
　3.　Commit your Changes.
　4.　Push to the Branch.
　5.　Open a Pull Request.

## License * The 3-Clause BSD License. (see the LICENSE file inside this repo)
## Contact * oh@airar.co (sung hoon oh)

[masxtar-1]: https://camo.githubusercontent.com/cc0b1fb5c7c8d7485684e9e71cff2742bdf2a858a3f99146b2cb23e9fd9596f4/687474703a2f2f61697261722e636f2e6b722f436f6c6f724d617070696e672f496d672f4d61787374415253616d706c65496d675f30312e6a7067 [easyar-1]: https://camo.githubusercontent.com/1f5c052690adae2618fc904a4fb01adf3f705ecd361162527d0b19b675e9f575/687474703a2f2f61697261722e636f2e6b722f436f6c6f724d617070696e672f496d672f45617379415253616d706c65496d675f30312e6a7067 [vuforia-1]: https://camo.githubusercontent.com/6702b3a357553b5e797c32076066c690e64f33cc0afd62d8d3f37590f2142437/687474703a2f2f61697261722e636f2e6b722f436f6c6f724d617070696e672f496d672f5675666f72696153616d706c65496d675f30315f3232313133302e6a7067 [arfoundation-1]: https://camo.githubusercontent.com/c63023b3180f8d3ae0a641f048af0b243cdb96f7250ab399371b3f91568df208/687474703a2f2f61697261722e636f2e6b722f436f6c6f724d617070696e672f496d672f4152466f756e646174696f6e53616d706c65496d675f30312e6a7067