Files
XRLib/Assets/Scripts/UVC/UIToolkit/Input/UTKFloatField.cs
2026-02-19 18:40:37 +09:00

329 lines
11 KiB
C#

#nullable enable
using System;
using UnityEngine;
using UnityEngine.UIElements;
namespace UVC.UIToolkit
{
/// <summary>
/// 실수(float) 입력 필드 컴포넌트.
/// Unity FloatField를 래핑하여 커스텀 스타일을 적용합니다.
/// 소수점이 포함된 숫자(단정밀도 부동소수점)를 입력받습니다.
/// </summary>
/// <remarks>
/// <para><b>float(실수)란?</b></para>
/// <para>float는 32비트 단정밀도 부동소수점 타입으로, 소수점이 있는 숫자를 저장합니다.</para>
/// <list type="bullet">
/// <item><description>위치, 회전, 크기 등 Transform 값에 주로 사용</description></item>
/// <item><description>가격, 속도, 거리 등 실수 값에 적합</description></item>
/// <item><description>더 높은 정밀도가 필요하면 UTKDoubleField 사용</description></item>
/// <item><description>정수만 필요하면 UTKIntegerField 사용</description></item>
/// <item><description>Validation 함수를 통한 입력 검증 (FocusOut 시 자동 호출)</description></item>
/// <item><description>에러 상태 시 붉은 외곽선 + 에러 메시지 표시</description></item>
/// </list>
/// <para><b>주의:</b> float 리터럴은 숫자 뒤에 'f'를 붙여야 합니다 (예: 3.14f)</para>
/// </remarks>
/// <example>
/// <para><b>C# 코드에서 사용:</b></para>
/// <code>
/// // 기본 실수 필드 생성
/// var floatField = new UTKFloatField();
/// floatField.label = "이동 속도";
/// floatField.Value = 5.5f;
///
/// // 값 변경 이벤트
/// floatField.OnValueChanged += (value) => {
/// Debug.Log($"속도: {value}");
/// };
///
/// // 라벨과 기본값을 지정하는 생성자
/// var speedField = new UTKFloatField("속도", 10.0f);
///
/// // 현재 값 읽기/쓰기
/// float currentSpeed = floatField.Value;
/// floatField.Value = 7.5f;
///
/// // 비활성화
/// floatField.IsEnabled = false;
/// </code>
/// <para><b>Validation (입력 검증):</b></para>
/// <code>
/// // 검증 함수 설정 (Func<bool>)
/// var speedField = new UTKFloatField("속도", 0f);
/// speedField.ErrorMessage = "속도는 0보다 커야 합니다.";
/// speedField.Validation = () => speedField.Value > 0f;
/// // → FocusOut 시 자동으로 검증
/// // → 실패 시 붉은 외곽선 + 에러 메시지 표시, 통과 시 자동 해제
///
/// // 범위 검증
/// var temperatureField = new UTKFloatField("온도", 20f);
/// temperatureField.ErrorMessage = "온도는 -40 ~ 60 사이여야 합니다.";
/// temperatureField.Validation = () => temperatureField.Value >= -40f &amp;&amp; temperatureField.Value <= 60f;
///
/// // 강제 검증 호출 (예: 폼 제출 버튼 클릭 시)
/// bool isValid = speedField.Validate();
/// if (!isValid) return; // 검증 실패
///
/// // 에러 수동 해제
/// speedField.ClearError();
///
/// // 에러 메시지 직접 설정 (Validation 없이, 서버 오류 등)
/// floatField.ErrorMessage = "서버 오류가 발생했습니다.";
/// floatField.ErrorMessage = ""; // 오류 제거
/// </code>
/// <para><b>UXML에서 사용:</b></para>
/// <code><![CDATA[
/// <!-- 기본 실수 필드 -->
/// <utk:UTKFloatField label="속도" value="10.5" />
///
/// <!-- 비활성화 상태 -->
/// <utk:UTKFloatField label="고정 값" value="3.14" is-enabled="false" />
/// ]]></code>
/// <para><b>실제 활용 예시 (캐릭터 스탯):</b></para>
/// <code>
/// // 캐릭터 이동 속도 편집
/// var moveSpeedField = new UTKFloatField("이동 속도", character.MoveSpeed);
/// moveSpeedField.ErrorMessage = "이동 속도는 0 이상이어야 합니다.";
/// moveSpeedField.Validation = () => moveSpeedField.Value >= 0f;
/// moveSpeedField.OnValueChanged += (newSpeed) => {
/// character.MoveSpeed = Mathf.Clamp(newSpeed, 0f, 100f);
/// };
/// </code>
/// </example>
[UxmlElement]
public partial class UTKFloatField : FloatField, IDisposable
{
#region Constants
private const string USS_PATH = "UIToolkit/Input/UTKFloatField";
#endregion
#region Fields
private bool _disposed;
private bool _isEnabled = true;
private string _errorMessage = "";
private Func<bool>? _validation;
private Label? _errorLabel;
#endregion
#region Events
/// <summary>값 변경 이벤트</summary>
public event Action<float>? OnValueChanged;
#endregion
#region Properties
/// <summary>현재 값</summary>
public float Value
{
get => value;
set => this.value = value;
}
/// <summary>에러 메시지. 비어있지 않으면 에러 상태로 표시</summary>
[UxmlAttribute("error-message")]
public string ErrorMessage
{
get => _errorMessage;
set
{
_errorMessage = value;
var hasError = !string.IsNullOrEmpty(value);
EnableInClassList("utk-float-field--error", hasError);
UpdateErrorLabel(hasError ? value : null);
}
}
/// <summary>검증 함수. FocusOut 시 호출되어 false 반환 시 ErrorMessage 표시</summary>
public Func<bool>? Validation
{
get => _validation;
set => _validation = value;
}
/// <summary>활성화 상태</summary>
[UxmlAttribute("is-enabled")]
public bool IsEnabled
{
get => _isEnabled;
set
{
_isEnabled = value;
SetEnabled(value);
EnableInClassList("utk-float-field--disabled", !value);
}
}
/// <summary>읽기 전용</summary>
public new bool isReadOnly
{
get => base.isReadOnly;
set
{
base.isReadOnly = value;
EnableInClassList("utk-float-field--readonly", value);
}
}
#endregion
#region Constructor
public UTKFloatField() : base()
{
UTKThemeManager.Instance.ApplyThemeToElement(this);
var uss = Resources.Load<StyleSheet>(USS_PATH);
if (uss != null)
{
styleSheets.Add(uss);
}
SetupStyles();
SetupEvents();
SubscribeToThemeChanges();
}
public UTKFloatField(string label, float defaultValue = 0f) : this()
{
this.label = label;
value = defaultValue;
}
#endregion
#region Setup
private void SetupStyles()
{
AddToClassList("utk-float-field");
}
private void SetupEvents()
{
RegisterCallback<ChangeEvent<float>>(OnFieldValueChanged);
RegisterCallback<FocusOutEvent>(OnFocusOut);
RegisterCallback<KeyDownEvent>(OnKeyDown, TrickleDown.TrickleDown);
}
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 OnFieldValueChanged(ChangeEvent<float> evt)
{
OnValueChanged?.Invoke(evt.newValue);
}
private void OnFocusOut(FocusOutEvent evt)
{
RunValidation();
}
private void OnKeyDown(KeyDownEvent evt)
{
if (evt.keyCode == KeyCode.Return)
{
RunValidation();
}
}
#endregion
#region Methods
/// <summary>
/// 강제로 Validation을 실행하여 에러 상태를 업데이트합니다.
/// </summary>
/// <returns>Validation이 null이면 true, 아니면 Validation 결과</returns>
public bool Validate()
{
return RunValidation();
}
/// <summary>에러 상태를 수동으로 해제합니다.</summary>
public void ClearError()
{
ErrorMessage = "";
}
private bool RunValidation()
{
if (_validation == null) return true;
var isValid = _validation.Invoke();
if (isValid)
{
// 검증 통과 시 에러 상태 해제
EnableInClassList("utk-float-field--error", false);
UpdateErrorLabel(null);
}
else
{
// 검증 실패 시 에러 상태 표시
EnableInClassList("utk-float-field--error", true);
UpdateErrorLabel(_errorMessage);
}
return isValid;
}
private void UpdateErrorLabel(string? message)
{
if (string.IsNullOrEmpty(message))
{
// 에러 라벨 숨기기 (존재하면)
if (_errorLabel != null)
{
_errorLabel.style.display = DisplayStyle.None;
}
return;
}
// 에러 라벨 생성 (지연 생성 - 필요할 때만)
if (_errorLabel == null)
{
_errorLabel = new Label();
_errorLabel.AddToClassList("utk-float-field__error-message");
_errorLabel.style.display = DisplayStyle.None;
Add(_errorLabel);
}
_errorLabel.text = message;
_errorLabel.style.display = DisplayStyle.Flex;
}
#endregion
#region IDisposable
public void Dispose()
{
if (_disposed) return;
_disposed = true;
UTKThemeManager.Instance.OnThemeChanged -= OnThemeChanged;
UnregisterCallback<AttachToPanelEvent>(OnAttachToPanelForTheme);
UnregisterCallback<DetachFromPanelEvent>(OnDetachFromPanelForTheme);
UnregisterCallback<ChangeEvent<float>>(OnFieldValueChanged);
UnregisterCallback<FocusOutEvent>(OnFocusOut);
UnregisterCallback<KeyDownEvent>(OnKeyDown);
OnValueChanged = null;
_validation = null;
_errorLabel = null;
}
#endregion
}
}