Files
dungeons/Assets/UltimateXR/Runtime/Scripts/UI/Helpers/Keyboard/UxrToggleSymbolsPage.cs
2024-08-06 21:58:35 +02:00

53 lines
1.7 KiB
C#

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="UxrToggleSymbolsPage.cs" company="VRMADA">
// Copyright (c) VRMADA, All rights reserved.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
using System;
using UnityEngine;
namespace UltimateXR.UI.Helpers.Keyboard
{
/// <summary>
/// Symbols page for keyboard symbols. A keyboard may have multiple symbol pages.
/// </summary>
[Serializable]
public class UxrToggleSymbolsPage
{
#region Inspector Properties/Serialized Fields
[SerializeField] private GameObject _keysRoot;
[SerializeField] private string _label;
#endregion
#region Public Types & Data
/// <summary>
/// Gets the root <see cref="GameObject" /> where all the keys in the page hang from.
/// </summary>
public GameObject KeysRoot => _keysRoot;
/// <summary>
/// Gets the label that describes the symbols in the page.
/// </summary>
public string Label => _label;
#endregion
#region Constructors & Finalizer
/// <summary>
/// Constructor.
/// </summary>
/// <param name="keysRoot">Root where are symbols in the page hang from</param>
/// <param name="label">Label that describes the symbols in the page</param>
public UxrToggleSymbolsPage(GameObject keysRoot, string label)
{
_keysRoot = keysRoot;
_label = label;
}
#endregion
}
}