Unity AR ColorMapping

<br /> <p align="center"> <a href="https://github.com/airar-dev/ColorMapping"> <img src="https://airar.co.kr/ColorMapping/Img/Default/logo_2023_N-01-W.png" alt="Logo" width="80" height="80"> </a> <h1 align="center"> AR ColorMapping </h1> <div align="center">

<br />

</div> <p align="center"> <br /> This project is an easy-to-apply AR Coloring Library for Unity. <br /> This project can be applied to AR Engines of MaxstAR, EasyAR, Vuforia, ARFoundation(ARkit, ARcore). <br /> To use it for business projects, you need to purchase a separate license for the AR Engine. <br /><br /> <a href="https://youtu.be/HaN_d2eDf2Q" target="_blank">View Demo</a> <br /><br /> <p align="center"> <a href="https://youtu.be/HaN_d2eDf2Q" rel="nofollow"> <img src="http://airar.co.kr/ColorMapping/Img/Default/demo_video.gif" alt="demo video" style="max-width:100%;"> </a> </p> </p> </p> <br />

Table of Contents

• Requirements
• Installation
• Quick Start
  • with MaxstAR
  • with EasyAR
  • with Vuforia
  • with ARFoundation(ARkit, ARcore)
• Release
• Future Release
• Trouble Shooting
• Known Issues
• Contributing
• License
• Contact

<br />

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)<br /> The opencv library can be downloaded from the official website. <br />Download the opencv from this link (https://opencv.org/releases/).<br /><br />

* 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<br /><br />

* 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<br /><br />

* As of July 29, 2024, the latest version of Unity3D and the latest version of ARFoundation have been tested.

• Unity3D 2023.2.0f1
• ARFoundation 5.1.5v<br /><br />

* As of July 30, 2024, the latest version of Unity3D and the latest version of Vuforia have been tested.

• Unity3D 2023.2.0f1
• Vuforia 10.25.4v<br /><br />

* As of Aug 9, 2024, multi-tracking supported ARFoundation samples have been updated.

• Unity3D 2023.2.0f1
• ARFoundation 5.1.5v

<br />

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. <br /> 　　(You can use MaxstAR, EasyAR, Vuforia, ARFoundation(ARkit, ARcore)) <br />

<br />

3D Guide

https://youtu.be/2-h8aBLddjY <br /><br />

Quick Start

with MaxstAR

Create Android App Project Demo(https://youtu.be/JhixOsRKQ5k)<br /> Create iOS App Project Demo(https://youtu.be/h3YQMaf7R-E)<br /><br />

　1. Create Project <br /> 　-　Create an empty Unity3D project. <br /> <br />

　2. Import MaxstAR <br /> 　-　Import MaxstAR SDK(5.0.2v +). <br /> <br />

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

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

　5. Player Settings for Android

<table> <tr><td>Allow 'unsafe' code</td><td>Check the Allow 'unsafe' code</td></tr> <tr><td>Scripting Backend</td><td>Select IL2CPP</td></tr> <tr><td>Target Architectures</td><td>Check Arm64 architecture(uncheck ARM7)</td></tr> <tr><td>Scripting Define Symbols</td><td>Add ‘USE_MAXSTAR’ into Scripting Define Symbols</td></tr> </table> <br />

　6. Player Settings for iOS

<table> <tr><td>Allow 'unsafe' code</td><td>Check the Allow 'unsafe' code</td></tr> <tr><td>Scripting Backend</td><td>Select IL2CPP</td></tr> <tr><td>Target Architectures</td><td>Check Arm64 architecture(uncheck ARM7)</td></tr> <tr><td>Scripting Define Symbols</td><td>Add ‘USE_MAXSTAR’ into Scripting Define Symbols</td></tr> </table> <br />

　7. Setting for 3D Contents

<table> <tr> <td>‘coloring’ tag　　　　　</td><td>Set ‘coloring’ tag for Object containing the material <br/> to which the colored texture is applied</td></tr> </table> <br />

　8. MaxstARColorMapping.cs <br /><br /> ![masxtar-1]

<table> <tr><td>trackableBehaviour　　</td><td>MaxstAR ImageTrackableBehaviour</td></tr> <tr><td>ARContents</td><td>3D object to augment</td></tr> <tr><td>RealWidth</td><td>Actual horizontal size of the marker image</td></tr> <tr><td>RealHeight</td><td>Actual vertical size of the marker image</td></tr> </table> <br />

　9. Build <br /> 　-　Build by selecting the MaxstARSample scene under ColorMapping -> Scenes.<br /><br /><br />

with EasyAR

Create Android App Project Demo(https://youtu.be/elk7-E3LDYc)<br /> Create iOS App Project Demo(https://youtu.be/bcKe0nKg5fg)<br /><br />

　1. Create Project <br /> 　-　Create an empty Unity3D project. <br /> <br />

　2. Initialize EasyAR <br /> 　-　EasyAR 3.1.0 Version + required. <br /> 　-　For EasyAR to work, a license key is required. <br /> <br />

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

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

　5. Player Settings for Android

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

　6. Player Settings for iOS

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

　7. Setting for 3D Contents

<table> <tr> <td>‘coloring’ tag　　　　　</td><td>Set ‘coloring’ tag for Object containing the material <br/> to which the colored texture is applied</td></tr> </table> <br />

　8. EasyARColorMapping.cs <br /><br /> ![easyar-1]

<table> <tr><td>ImageTargetController　</td><td>EasyAR ImageTargetController</td></tr> <tr><td>ARContents</td><td>3D object to augment</td></tr> <tr><td>RealWidth</td><td>Actual horizontal size of the marker image</td></tr> <tr><td>RealHeight</td><td>Actual vertical size of the marker image</td></tr> </table> <br />

　9. Build <br /> 　-　Build by selecting the EasyARSample scene under ColorMapping -> Scenes.<br /><br /><br />

with Vuforia

Create Android App Project Demo(https://youtu.be/b5zSwDiwE4Q)<br /> Create iOS App Project Demo(https://youtu.be/s1TcKE2PzXk)<br /><br />

　1. Create Project <br /> 　-　Create an empty Unity3D project. <br /> <br />

　**2. Import Vuforia