Files
XRLib/Assets/Scripts/UVC/UIToolkit/Dropdown/UTKDropdown.cs
2026-01-23 19:04:12 +09:00

247 lines
8.0 KiB
C#

#nullable enable
using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UIElements;
namespace UVC.UIToolkit
{
/// <summary>
/// 드롭다운 메뉴 컴포넌트.
/// Unity DropdownField를 래핑하여 커스텀 스타일을 적용합니다.
/// 여러 옵션 중 하나를 선택할 수 있는 UI 컨트롤입니다.
/// </summary>
/// <remarks>
/// <para><b>드롭다운(Dropdown)이란?</b></para>
/// <para>
/// 드롭다운은 클릭하면 펼쳐지는 옵션 목록에서 하나를 선택하는 UI 컴포넌트입니다.
/// 많은 옵션을 작은 공간에 담을 수 있어 화면 공간을 효율적으로 사용합니다.
/// 라디오 버튼과 비슷하지만, 옵션이 많을 때 더 적합합니다.
/// </para>
///
/// <para><b>주요 속성:</b></para>
/// <list type="bullet">
/// <item><description><c>choices</c> - 선택 가능한 옵션 목록 (List<string>)</description></item>
/// <item><description><c>index</c> - 현재 선택된 인덱스 (0부터 시작)</description></item>
/// <item><description><c>value</c> - 현재 선택된 텍스트 값</description></item>
/// <item><description><c>SelectedIndex</c> - index의 별칭</description></item>
/// <item><description><c>SelectedValue</c> - value의 별칭 (읽기 전용)</description></item>
/// </list>
///
/// <para><b>주요 메서드:</b></para>
/// <list type="bullet">
/// <item><description><c>SetOptions(List<string>)</c> - 전체 옵션 목록 교체</description></item>
/// <item><description><c>AddOption(string)</c> - 옵션 하나 추가</description></item>
/// <item><description><c>SetSelectedValue(string, bool)</c> - 값으로 선택 (notify: 이벤트 발생 여부)</description></item>
/// </list>
///
/// <para><b>실제 활용 예시:</b></para>
/// <list type="bullet">
/// <item><description>정렬 옵션 - 이름순, 날짜순, 크기순</description></item>
/// <item><description>언어 선택 - 한국어, English, 日本語</description></item>
/// <item><description>국가/지역 선택</description></item>
/// <item><description>해상도, 품질 설정</description></item>
/// <item><description>파일 형식 선택</description></item>
/// </list>
/// </remarks>
/// <example>
/// <para><b>C# 코드에서 사용:</b></para>
/// <code>
/// // 국가 선택 드롭다운
/// var countryDropdown = new UTKDropdown();
/// countryDropdown.label = "국가 선택";
/// countryDropdown.SetOptions(new List<string> { "한국", "미국", "일본", "중국" });
///
/// // 선택 변경 이벤트 (인덱스와 값 모두 전달)
/// countryDropdown.OnSelectionChanged += (index, value) => {
/// Debug.Log($"선택: [{index}] {value}");
/// };
///
/// // 생성자로 한 번에 설정
/// var sortDropdown = new UTKDropdown("정렬", new List<string> { "이름", "날짜", "크기" });
///
/// // 기본값 설정 (인덱스로)
/// sortDropdown.index = 0; // 첫 번째 항목 선택
///
/// // 기본값 설정 (값으로)
/// sortDropdown.SetSelectedValue("날짜");
///
/// // 동적으로 옵션 추가
/// countryDropdown.AddOption("독일");
///
/// // 이벤트 없이 값 변경 (초기화 시 유용)
/// sortDropdown.SetSelectedValue("크기", notify: false);
/// </code>
/// <para><b>UXML에서 사용:</b></para>
/// <code>
/// <!-- 기본 드롭다운 (쉼표로 구분) -->
/// <utk:UTKDropdown label="정렬" choices="이름,날짜,크기" />
///
/// <!-- 기본값 지정 (index로) -->
/// <utk:UTKDropdown label="언어"
/// choices="한국어,English,日本語"
/// index="0" />
///
/// <!-- 비활성화 상태 -->
/// <utk:UTKDropdown label="선택" is-enabled="false"
/// choices="옵션1,옵션2,옵션3" />
/// </code>
/// </example>
[UxmlElement]
public partial class UTKDropdown : DropdownField, IDisposable
{
#region Constants
private const string USS_PATH = "UIToolkit/Dropdown/UTKDropdown";
#endregion
#region Fields
private bool _disposed;
private bool _isEnabled = true;
#endregion
#region Events
/// <summary>선택 변경 이벤트</summary>
public event Action<int, string>? OnSelectionChanged;
#endregion
#region Properties
/// <summary>선택된 인덱스</summary>
public int SelectedIndex
{
get => index;
set => index = value;
}
/// <summary>선택된 값</summary>
public string? SelectedValue => value;
/// <summary>활성화 상태</summary>
[UxmlAttribute("is-enabled")]
public bool IsEnabled
{
get => _isEnabled;
set
{
_isEnabled = value;
SetEnabled(value);
EnableInClassList("utk-dropdown--disabled", !value);
}
}
#endregion
#region Constructor
public UTKDropdown() : base()
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
var uss = Resources.Load<StyleSheet>(USS_PATH);
if (uss != null)
{
styleSheets.Add(uss);
}
SetupStyles();
SetupEvents();
SubscribeToThemeChanges();
}
public UTKDropdown(string label, List<string>? options = null) : this()
{
this.label = label;
if (options != null)
{
choices = options;
}
}
#endregion
#region Setup
private void SetupStyles()
{
AddToClassList("utk-dropdown");
}
private void SetupEvents()
{
this.RegisterValueChangedCallback(OnDropdownValueChanged);
}
private void SubscribeToThemeChanges()
{
UTKThemeManager.Instance.OnThemeChanged += OnThemeChanged;
RegisterCallback<DetachFromPanelEvent>(_ =>
{
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
});
}
private void OnThemeChanged(UTKTheme theme)
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
}
#endregion
#region Event Handlers
private void OnDropdownValueChanged(ChangeEvent<string> evt)
{
OnSelectionChanged?.Invoke(index, evt.newValue);
}
#endregion
#region Methods
/// <summary>
/// 옵션 목록 설정
/// </summary>
public void SetOptions(List<string> options)
{
choices = options ?? new List<string>();
}
/// <summary>
/// 옵션 추가
/// </summary>
public void AddOption(string option)
{
var list = new List<string>(choices) { option };
choices = list;
}
/// <summary>
/// 값으로 선택
/// </summary>
public void SetSelectedValue(string? selectedValue, bool notify = true)
{
if (selectedValue == null)
{
index = -1;
return;
}
var idx = choices.IndexOf(selectedValue);
if (idx >= 0)
{
if (notify)
{
index = idx;
}
else
{
SetValueWithoutNotify(selectedValue);
}
}
}
#endregion
#region IDisposable
public void Dispose()
{
if (_disposed) return;
_disposed = true;
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
OnSelectionChanged = null;
}
#endregion
}
}