Files

197 lines
6.6 KiB
C#

#nullable enable
using System;
using UnityEngine;
using UnityEngine.UIElements;
namespace UVC.UIToolkit
{
/// <summary>
/// 슬라이더 컴포넌트.
/// Unity Slider를 래핑하여 커스텀 스타일을 적용합니다.
/// 드래그 또는 클릭으로 범위 내의 연속적인 값을 선택할 수 있습니다.
/// </summary>
/// <remarks>
/// <para><b>슬라이더(Slider)란?</b></para>
/// <para>
/// 슬라이더는 사용자가 지정된 범위 내에서 연속적인 값을 선택할 수 있는 UI 컨트롤입니다.
/// 볼륨, 밝기, 속도 등 수치 조절에 널리 사용되며, 시각적으로 현재 값의 위치를 확인할 수 있습니다.
/// </para>
///
/// <para><b>주요 속성:</b></para>
/// <list type="bullet">
/// <item><description><c>lowValue</c> - 슬라이더의 최소값 (왼쪽 끝)</description></item>
/// <item><description><c>highValue</c> - 슬라이더의 최대값 (오른쪽 끝)</description></item>
/// <item><description><c>value</c> - 현재 선택된 값</description></item>
/// <item><description><c>showInputField</c> - 숫자 입력 필드 표시 여부 (Unity 기본 속성)</description></item>
/// <item><description><c>direction</c> - 슬라이더 방향 (Horizontal/Vertical)</description></item>
/// </list>
///
/// <para><b>실제 활용 예시:</b></para>
/// <list type="bullet">
/// <item><description>게임 설정 - 볼륨, 밝기, 마우스 감도 조절</description></item>
/// <item><description>이미지 편집 - 색상 조정, 필터 강도</description></item>
/// <item><description>애니메이션 - 타임라인 스크러빙, 재생 속도</description></item>
/// <item><description>3D 에디터 - 오브젝트 스케일, 회전 각도</description></item>
/// </list>
/// </remarks>
/// <example>
/// <para><b>C# 코드에서 사용:</b></para>
/// <code>
/// // 기본 슬라이더 생성
/// var slider = new UTKSlider();
/// slider.label = "볼륨";
/// slider.lowValue = 0;
/// slider.highValue = 100;
/// slider.value = 50;
///
/// // 값 변경 이벤트
/// slider.OnValueChanged += (value) => {
/// Debug.Log($"볼륨: {value}%");
/// AudioListener.volume = value / 100f;
/// };
///
/// // 생성자로 한 번에 설정
/// var brightnessSlider = new UTKSlider("밝기", 0, 100, 75);
///
/// // 0~1 범위 슬라이더 (투명도)
/// var alphaSlider = new UTKSlider("투명도", 0f, 1f, 1f);
/// alphaSlider.OnValueChanged += (alpha) => {
/// material.SetFloat("_Alpha", alpha);
/// };
/// </code>
/// <para><b>UXML에서 사용:</b></para>
/// <code>
/// <!-- 기본 슬라이더 -->
/// <utk:UTKSlider label="밝기" low-value="0" high-value="100" value="50" />
///
/// <!-- 값 입력 필드 표시 -->
/// <utk:UTKSlider label="투명도" low-value="0" high-value="1" value="0.5"
/// show-input-field="true" />
///
/// <!-- 비활성화 상태 -->
/// <utk:UTKSlider label="잠금" is-enabled="false" value="75" />
/// </code>
/// </example>
[UxmlElement]
public partial class UTKSlider : Slider, IDisposable
{
#region Constants
private const string USS_PATH = "UIToolkit/Slider/UTKSlider";
#endregion
#region Fields
private bool _disposed;
private bool _isEnabled = true;
#endregion
#region Events
/// <summary>값 변경 이벤트</summary>
public event Action<float>? OnValueChanged;
#endregion
#region Properties
/// <summary>활성화 상태</summary>
[UxmlAttribute("is-enabled")]
public bool IsEnabled
{
get => _isEnabled;
set
{
_isEnabled = value;
SetEnabled(value);
EnableInClassList("utk-slider--disabled", !value);
}
}
/// <summary>현재 값</summary>
public float Value
{
get => value;
set => this.value = value;
}
#endregion
#region Constructor
public UTKSlider() : base()
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
var uss = Resources.Load<StyleSheet>(USS_PATH);
if (uss != null)
{
styleSheets.Add(uss);
}
SetupStyles();
SetupEvents();
SubscribeToThemeChanges();
}
public UTKSlider(string label, float minValue = 0f, float maxValue = 100f, float defaultValue = 0f) : this()
{
this.label = label;
this.lowValue = minValue;
this.highValue = maxValue;
this.value = defaultValue;
}
#endregion
#region Setup
private void SetupStyles()
{
AddToClassList("utk-slider");
}
private void SetupEvents()
{
RegisterCallback<ChangeEvent<float>>(OnSliderValueChanged);
}
private void SubscribeToThemeChanges()
{
UTKThemeManager.Instance.OnThemeChanged += OnThemeChanged;
RegisterCallback<AttachToPanelEvent>(OnAttachToPanelForTheme);
RegisterCallback<DetachFromPanelEvent>(OnDetachFromPanelForTheme);
}
private void OnAttachToPanelForTheme(AttachToPanelEvent evt)
{
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
UTKThemeManager.Instance.OnThemeChanged += OnThemeChanged;
UTKThemeManager.Instance.ApplyThemeToElement(this);
}
private void OnDetachFromPanelForTheme(DetachFromPanelEvent evt)
{
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
}
private void OnThemeChanged(UTKTheme theme)
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
}
#endregion
#region Event Handlers
private void OnSliderValueChanged(ChangeEvent<float> evt)
{
OnValueChanged?.Invoke(evt.newValue);
}
#endregion
#region IDisposable
public void Dispose()
{
if (_disposed) return;
_disposed = true;
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
UnregisterCallback<AttachToPanelEvent>(OnAttachToPanelForTheme);
UnregisterCallback<DetachFromPanelEvent>(OnDetachFromPanelForTheme);
OnValueChanged = null;
UnregisterCallback<ChangeEvent<float>>(OnSliderValueChanged);
}
#endregion
}
}