Unity 커스텀 인스펙터 만들기 가이드

이 문서는 Unity에서 커스텀 인스펙터를 만드는 방법을 설명합니다. UI 툴킷과 함께 커스텀 인스펙터를 작성하여 더 나은 사용자 경험을 제공할 수 있습니다.

목차

• 커스텀 인스펙터 개요
• 커스텀 인스펙터 생성
• UXML 사용
• 속성 필드 추가
• 커스텀 프로퍼티 드로어 생성
• 기본 인스펙터 추가

커스텀 인스펙터 개요

Unity는 기본 인스펙터를 제공하지만, 커스텀 인스펙터를 만드는 것이 좋습니다. - 스크립트 프로퍼티를 사용자 친화적으로 표시 - 프로퍼티 정리 및 그룹화 - UI 섹션의 표시/숨기기 - 추가 정보 제공

커스텀 인스펙터 생성

먼저 MonoBehaviour 또는 ScriptableObject를 상속받은 클래스, 예를 들어 아래와 같은 Car 클래스 생성합니다.

using UnityEngine;

public class Car : MonoBehaviour
{
  public string m_Make = "Toyota";
  public int m_YearBuilt = 1980;
  public Color m_Color = Color.black;
}

씬에 Car 스크립트를 부착한 게임 오브젝트를 만듭니다.

커스텀 인스펙터 스크립트 생성

Editor 폴더에 Car_Inspector.cs 파일을 생성하고 다음 코드를 추가합니다.

using UnityEditor;
using UnityEditor.UIElements;
using UnityEngine.UIElements;

[CustomEditor(typeof(Car))]
public class Car_Inspector : Editor
{
}

UXML 사용

UI 툴킷에서는 UI 컨트롤을 UXML 파일에 정의하고 해당 파일을 로드하는 것이 가능합니다.

1. UI 빌더 열기: Window > UI Toolkit > UI Builder를 선택합니다.
2. 새 UXML 파일 생성: 파일 메뉴에서 File > New를 클릭합니다.

UI 빌더에서 라벨을 추가하고, 생성한 UXML을 저장합니다.

public override VisualElement CreateInspectorGUI()
{
  VisualElement myInspector = new VisualElement();
  myInspector.Add(new Label("This is a custom inspector"));

  // UXML 로드 및 클로닝
  VisualTreeAsset visualTree = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/Scripts/Editor/Car_Inspector_UXML.uxml");
  visualTree.CloneTree(myInspector);

  return myInspector;
}

속성 필드 추가

각 프로퍼티를 위해 UI 요소를 생성하여 사용자가 쉽게 값을 수정할 수 있도록 합니다. UI 빌더에서 TextField, PropertyField를 추가하여 프로퍼티를 바인딩합니다.

<ui:TextField label="Make of the car" text="<not set>" binding-path="m_Make" />
<uie:PropertyField label="Year Built" binding-path="m_YearBuilt" />
<uie:PropertyField binding-path="m_Color" label="Paint Color" />
<uie:PropertyField binding-path="m_Tires" label="Tires" />

커스텀 프로퍼티 드로어 생성

Tire 클래스를 정의한 후, Car 클래스에서 이를 사용합니다.

[System.Serializable]
public class Tire
{
  public float m_AirPressure = 21.5f;
  public int m_ProfileDepth = 4;
}

Tire 프로퍼티를 가져오기 위해 Tire_PropertyDrawer 클래스를 생성합니다.

using UnityEditor;
using UnityEditor.UIElements;
using UnityEngine.UIElements;

[CustomPropertyDrawer(typeof(Tire))]
public class Tire_PropertyDrawer : PropertyDrawer
{
  public override VisualElement CreatePropertyGUI(SerializedProperty property)
  {
    var container = new VisualElement();

    // UI 구성
    var popup = new UnityEngine.UIElements.PopupWindow();
    popup.text = "Tire Details";
    popup.Add(new PropertyField(property.FindPropertyRelative("m_AirPressure"), "Air Pressure (psi)"));
    popup.Add(new PropertyField(property.FindPropertyRelative("m_ProfileDepth"), "Profile Depth (mm)"));
    container.Add(popup);

    return container;
  }
}

기본 인스펙터 추가

커스텀 인스펙터에 기본 인스펙터 UI를 추가하여 사용자에게 자연스러운 경험을 제공합니다. UI 빌더에서 Foldout 컨트롤을 추가한 후, CreateInspectorGUI 메소드 내에서 기본 인스펙터를 폴드아웃에 부착합니다.

최종 코드 스니펫

모든 코드를 통합하여 최종 커스텀 인스펙터를 구성합니다.

public override VisualElement CreateInspectorGUI()
{
    VisualElement myInspector = new VisualElement();
    m_InspectorXML.CloneTree(myInspector);

    VisualElement inspectorFoldout = myInspector.Q("Default_Inspector");
    InspectorElement.FillDefaultInspector(inspectorFoldout, serializedObject, this); 

    return myInspector;
}

결론

이 가이드를 통해 Unity에서 커스텀 인스펙터를 작성하는 방법을 배웠습니다. UI 툴킷을 통해 더 나은 사용자 경험을 제공하고, 복잡한 데이터를 직관적으로 관리할 수 있습니다.