AR Room Simulator 🪑

AR Room Simulator is a Unity-based application designed to create an augmented reality environment for simulating room layouts. This tool allows users to place and manipulate 3D objects within a real-world space using AR technology. It's ideal for interior designers, architects, or anyone looking to visualize how furniture and decor will look in a given room.

✍ Features

• Spatial Recognition: Creates augmented reality objects by recognizing planes in reality with a camera.
• Object Placement: Add and place 3D objects within the augmented reality environment.
• Object Recognition(Select): Select an object created within the augmented reality environment.
• Object Manipulation: Move, rotate, and resize the selected object as desired.
• Object Occlusion: AR objects naturally disappear when in an invisible area, creating a more realistic and deep expression.

⭐ Getting Started

Prerequisites

• Unity: Version 2022.3.29f1
  • important!! If the Unity version is different, it will not run.
• AR Foundation: Version 5.1.4
  • Unity's AR Foundation package for AR functionality.

For Android

• Google ArCore XR Plugin: Version 5.1.4
  • Always same as AR Foundation version
  • Package to enable ARCore support in AR Foundation projects

Installation

1. Clone the Repository:

git clone https://github.com/nodb/ARRoomSimulator.git

2. Open the Project in Unity:

• Open Unity Hub.
• Click on "Add" and navigate to the cloned repository folder.
• Select the project and open it.

3. Install Required Packages:

• In Unity, go to Window > Package Manager.
• Ensure AR Foundation, Google ArCore XR Plugin (for Android) are installed.

📁 Scripts

📄 ARMultipleObjectController.cs

This script is responsible for managing multiple AR objects within the AR environment. It allows users to place, select, and manipulate 3D objects using touch input.

Object Placement Method

1. Save the prefab of the pressed button each time the button is pressed.
2. Instantiate with saved Prefab

• Serialized Fields:

  • ARRaycastManager arRaycastManager: Manages AR raycasting to detect surfaces in the AR environment.
  • Camera arCamera: The AR camera used to cast rays for detecting touch positions.

• Private Fields:

  • GameObject selectedPrefab: The prefab to instantiate when placing new AR objects.
  • ARObject selectedObject: The currently selected AR object.
  • List<ARRaycastHit> arHits: Stores AR raycast hit results.
  • RaycastHit physicsHit: Stores physics raycast hit results.
  • float scale: Stores the current scale factor for AR objects.
  • float angle: Stores the current rotation angle for AR objects.

• Public Methods:

  • void SetSelectedPrefab(GameObject selectedPrefab): Sets the prefab to be instantiated.
  • void UpdateScale(float sliderValue): Updates the scale of the selected AR object based on slider input.
  • void UpdateRotation(float sliderValue): Updates the rotation of the selected AR object based on slider input.

• Private Methods:

  • void Awake(): Initializes the selected prefab with the default AR raycast prefab.
  • void Update(): Handles touch input for selecting and placing AR objects.
  • bool SelectARObject(Vector2 touchPosition): Selects an AR object if touched.
  • void SelectARPlane(Vector2 touchPosition): Places a new AR object if an AR plane is touched.
  • bool IsPointOverUIObject(Vector2 pos): Checks if the touch position is over a UI element to prevent interference.

📄 ARObject.cs

This script handles the selection state and material management for AR objects. When an object is selected, it changes its material to indicate selection and reverts to the original material when deselected.

Object Recognition(Select) Method

1. Shoot a ray at a touch position centered on the camera
2. Receive the value of the AR object that collided with the ray and set the selected value of the AR object to true.
3. The setter of the AR object is called and the Meterial color changes.

• Private Fields:

  • bool IsSelected: Indicates whether the object is selected.
  • List<MeshRenderer> childMeshRenderers: Stores the mesh renderers of all child objects.
  • List<Material> originalMaterials: Stores the original materials of all child objects.
  • Material unlitBlackMaterial: The material to apply when the object is selected.

• Public Properties:

  • bool Selected: Gets or sets the selection state of the object and updates the material accordingly.

• Private Methods:

  • void Awake(): Initializes the mesh renderers and original materials of all child objects and loads the UnlitBlack material.
  • void UpdateMaterialColor(): Updates the material of all child objects based on the selection state.

📁 Scenes

📄 MultipleObjectControl

Hierachy

• Directional Light
• AR Session
• XR Origin
  • Camera Offset
    • Main Camera
• AR Default Plane
• UI
  • Canvas
    • Scroll View
      • Viewport
        • Content
          • ChairBtn1
          • ChairBtn2
          • TableBtn1
          • ...
    • Sliders
      • ScaleSlider
      • Rotation Slider
  • EventSystem
  • ARSceneManager
• ARObjectManager

AR Session

• Manages the overall Ligecycle of AR, whether AR is supported, and whether or not the session is run.
• Perform image analysis and algorithms by receiving camera image data/motion data from hardware devices
• Establish a connection between the real world and the virtual world modeling AR content

XR Origin

• Components needed to transform AR elements into Unity space, used to adjust the scale of all elements, actual camera position
• Object for mapping AR contents rendered in the virtual world to the real world coordinate space

AR Default Plane

• A component that finds a plane based on feature points obtained from the camera.

Scroll View

• An object that represents a horizontal scrollbar. Allows users to scroll content left and right.
• Contains buttons that connect each object.

Sliders

• This is an object that controls the size and rotation of the selected object.
• Size
  • minimum : 0.1, maximum: 1
• Rotation
  • minimum : 0, maximum: 360

🪑 Example Scene

UI

• in Unity

• in Reality

Spatial Recognition

Spatial.Recognition.mp4

• Take enough time to let the camera recognize the space.
• Find a plane based on feature points in the AR Default Plane.

Object Placement

Object.Placement.mp4

• Click the button for the desired object and then click in the AR space to place the object.
• Object buttons can be moved to Scroll View.

Object Recognition(Select)

Object.Recognition.Select.mp4

• You can select an object by clicking on it.
• Selected objects can be identified through color.
• You can move the selected object to another location by dragging it.

Object Manipulation

Object.Manipulation.mp4

• You can adjust the size and rotation of the selected object through Sliders.
  • Above: Size
  • Bottom: Rotation

Object Occlusion

Object.Occlusion.mp4

• The distance to the recognized object is calculated through the main camera's AR Occlusion Environment Depth, so that if the object in the AR space becomes farther away, it will be obscured and will not appear.

▶️ Demonstration of all features

▶️ Full video on YouTube

ShortDemo.mp4

🐞 Error Correction

The latest version of the Android API is too high and is not compatible with Unity apps.

"This app isn't compatible with the latest version of Android. Check for an update or contact the apps developer."

• Modify target architecture(https://discussions.unity.com/t/unity-game-not-compatible-with-latest-version-of-android-error/326763)

arRaycast operates when touching the UI

Blocks arRaycastManager's raycast from working.

• AR Foundation, never blocking raycaster on UI(https://forum.unity.com/threads/ar-foundation-never-blocking-raycaster-on-ui.986688/)

Press and hold, objects will continue to be created.

Modified to create an object by recognizing it only once when pressed

• touchCount: Number of fingers in contact with the screen

🔗 Reference

• Unity Hub
  • Install Unity Hub - https://docs.unity3d.com/kr/2021.2/Manual/GettingStartedInstallingHub.html
• Unity GameObject
  • class-GameObject - https://docs.unity3d.com/kr/2023.2/Manual/class-GameObject.html
• Unity AR Foundation
  • AR Foundation - https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@6.0/manual/index.html
  • Plane detection - https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@6.0/manual/features/plane-detection/plane-detection.html
  • AR Foundation(AR core) - https://developers.google.com/ar/develop/unity-arf/getting-started-ar-foundation?hl=ko
  • Create an AR game using Unity's AR Foundation - https://codelabs.developers.google.com/arcore-unity-ar-foundation#0
  • Unity AR Foundation AR 개발 초기 설정 & 평면 인식 - https://vrworld.tistory.com/2
  • 유니티로 AR 앱 만들기 - https://youtu.be/gi9iHTY9z1o?si=01zQGklYNrS8Y87C
• unity android build
  • Android SDK Setup - https://docs.unity3d.com/kr/2023.2/Manual/android-sdksetup.html
  • 유니티 강좌 & 팁, 안드로이드 빌드 세팅 - https://blog.naver.com/whatsuppapa/222300384734
  • Android와 Unity 간 버전 호환성 관리 - https://velog.io/@maratangsoft/Android%EC%99%80-Unity-%EA%B0%84-Gradle-%EB%B2%84%EC%A0%84-%EA%B4%80%EB%A6%AC

🗂️ Asset Package Used

• Big Furniture Pack
• HDRP Furniture Pack

📲 Install the application

ARRoomSimulator_v1.0.0 (Android)

‍💻 Developer

nodb

💳 License

This project is released under the MIT License.
Detailed license information can be found in the LICENSE file.