RadioButton
A RadioButton позволяет пользователям выбирать один вариант, когда используется вместе с другими RadioButtons в группе. Вы можете использовать GroupBox к группе RadioButtonsВ противном случае панель является группой по умолчанию.
Примечание: Чтобы выравнить элемент с другими полями в окне Inspector, просто примените .unity-base-field__aligned USS-класс. Дополнительные сведения см. в BaseField.
Создать RadioButton
Вы можете создать RadioButton с помощью UI Builder, UXML или C#. В следующем примере C# создаются две новые радиокнопки в одном контейнере и логически группируются вместе на панели.
var choice1 = new RadioButton() { text = "Choice 1" };
choice1.RegisterValueChangedCallback(v => Debug.Log("Choice 1 is : " + v.newValue));
var choice2 = new RadioButton() { text = "Choice 2" };
choice2.RegisterValueChangedCallback(v => Debug.Log("Choice 2 is : " + v.newValue));
container.Add(choice1);
container.Add(choice2);
Примеры
Следующий пример UXML создает RadioButton:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
<GroupBox>
<RadioButton label="UXML Field 1" name="the-uxml-field1" />
<RadioButton label="UXML Field 2" name="the-uxml-field2" />
</GroupBox>
</UXML>
Следующий пример USS стилизует RadioButton:
.some-styled-field {
-unity-font-style: bold;
}
Следующий пример C# иллюстрирует некоторые из настраиваемых функций RadioButton:
// Note: See also RadioButtonGroup in the ChoiceField section of UI Toolkit Samples
// Get a reference to the first radio button from UXML and assign a value to it.
var uxmlField1 = container.Q<RadioButton>("the-uxml-field1");
var uxmlField2 = container.Q<RadioButton>("the-uxml-field2");
uxmlField1.value = true;
// Create two RadioButtons in a separate group, disable them, and give them a style class.
var groupBox = new GroupBox();
container.Add(groupBox);
var csharpField1 = new RadioButton("C# Field 1");
csharpField1.SetEnabled(false);
csharpField1.AddToClassList("some-styled-field");
groupBox.Add(csharpField1);
var csharpField2 = new RadioButton("C# Field 2");
csharpField2.SetEnabled(false);
csharpField2.AddToClassList("some-styled-field");
groupBox.Add(csharpField2);
csharpField1.value = uxmlField1.value;
// Mirror the value of the UXML field into the C# field.
uxmlField1.RegisterCallback<ChangeEvent<bool>>((evt) =>
{
csharpField1.value = evt.newValue;
});
uxmlField2.RegisterCallback<ChangeEvent<bool>>((evt) =>
{
csharpField2.value = evt.newValue;
});
Чтобы попробовать этот пример в Unity, перейдите в Окно > UI Toolkit > Образцы.
Класс C# и пространство имён
C# класс: RadioButton
Пространство имен: UnityEngine.UIElements
Базовый класс: BaseBoolField
Унаследованные атрибуты UXML
Этот элемент наследует от своего базового класса следующие атрибуты:
| Имя | Тип | Описание |
|---|---|---|
binding-path |
string |
Путь к целевому свойству для привязки. |
focusable |
boolean |
Если false, то элемент не может быть фокусирован. Элемент может быть фокусирован только в том случае, если его свойство canGrabFocus имеет значение true. |
label |
string |
Строка, представляющая метку, которая будет отображаться рядом с полем. Если строка пуста, элемент label удаляется из иерархии. Если строка не пуста, элемент label добавляется в иерархию. |
tabindex |
int |
Целое число, используемое для сортировки фокусируемых элементов в кольце фокуса. Должно быть больше или равно нулю. Установка значения tabIndex меньше 0 (например, −1) удаляет элемент из кольца фокуса и навигации по вкладкам. |
text |
string |
Необязательный текст, который появляется после BaseBoolField. Unity автоматически создает Label, если его не существует. |
toggle-on-label-click |
boolean |
Активировать или не активировать переключатель при щелчке пользователем метки. |
value |
boolean |
Значение, связанное с полем. |
Этот элемент также наследует следующие атрибуты от VisualElement:
| Имя | Тип | Описание |
|---|---|---|
content-container |
string |
Логический контейнер, в который добавляются дочерние элементы. Если к этому элементу добавляется дочерний элемент, то он добавляется в контейнер содержимого этого элемента. При итерации над VisualElement.Children При использовании элемента вместо самого элемента используется иерархия контейнера содержимого элемента. Это может привести к неожиданным результатам, например, к игнорированию элементов событиями навигации, если они не находятся непосредственно в иерархической структуре контейнера. См. IFocusRing для больше информации.Если контейнер содержимого совпадает с самим элементом, то дочерние элементы добавляются непосредственно к элементу. Это верно для большинства элементов, но может быть переопределено более сложными типами. ScrollView, например, имеет контейнер содержимого, отличающийся от самого себя. В этом случае дочерние элементы, добавленные к представлению прокрутки, добавляются вместо этого к его элементу контейнера содержа-VisualElement.Hierarchy.parent) дочерних элементов является элементом контейнера содержимого прокрутки, их логическим родителем (VisualElement.parentПоскольку некоторые фокусируемые дочерние объекты представления прокрутки не являются частью его логической иерархии, такие как его Scroller элементов, эти фокусируемые дочерние элементы не рассматриваются по умолчанию при использовании последовательной навигации. Как я могу изменить, какой элемент будет фокусироваться дальше для примера решения, если правила навигации по умолчанию не соответствуют вашим потребностям. |
data-source |
Object |
Назначает источник данных этому VisualElement, который переопределяет любой унаследованный источник данных. Этот источник данных наследуется всеми дочерними объектами. |
data-source-path |
string |
Путь от источника данных к значению. |
data-source-type |
System.Type |
Возможный тип источника данных, присваиваемый этому VisualElement. Эта информация используется UI Builder только как подсказка для определенного заполнения поля пути источника данных, когда эффективный источник данных не может быть указан во время проектирования. |
enabled |
boolean |
Возвращает true, если VisualElement разрешен локально.Этот флаг не изменяется, если VisualElement имплицитно отключен одним из родителей. Чтобы проверить это, используйте enabledInHierarchy. |
language-direction |
UIElements.LanguageDirection |
Указывает направленность текста элемента. Значение будет распространяться на дочерей элемента. Установка languageDirection на RTL может получить только базовую поддержку RTL, такую как инверсия текста. Чтобы получить более полную поддержку RTL, такую как перерыв строки, перенос слов или формирование текста, вы должны включить Усовершенствованный текстовый генератор. |
name |
string |
Имя этого VisualElement. Используйте это свойство для написания селекторов USS, которые нацелены на определенный элемент. Стандартная практика заключается в том, чтобы дать элементу уникальное имя. |
picking-mode |
UIElements.PickingMode |
Определяет, может ли этот элемент быть целью событий указателя или выбран IPanel.Pick запросов.Элементы не могут быть выбраны, если: - Они невидимы. style.display установлен на DisplayStyle.NoneЭлементы с режимом подбора PickingMode.Ignore никогда не получать псевдо-state. |
style |
string |
Задает значения стиля на VisualElement.Возвращаемые данные стиля, рассчитанные из USS файлы или встроенные стили, записанные в этот объект в C#, не представляет полностью разрешенные стили, такие как окончательная высота и ширина VisualElement. Чтобы получить доступ к этим полностью разрешенным стилям, используйте resolvedStyle.Дополнительные сведения об использовании этого свойства и всех поддерживаемых USS свойства, см. Применить стили в C# сценарии и USS ссылка на свойства страницы руководства. |
tooltip |
string |
Текст, который будет отображаться внутри информационного поля после того, как пользователь задержится над элементом небольшое время. Это поддерживается только в Редакторе UI. |
usage-hints |
UIElements.UsageHints |
Комбинация значений подсказки, которые указывают высокоуровневые предполагаемые схемы использования для VisualElement. Это свойство может быть установлено только тогда, когда VisualElement еще не является частью Panel. Как только оно становится частью Panel, это свойство становится эффективно только для чтения, и попытки изменить его будут вызывать исключение. Указание правильного UsageHints заставляет систему принимать более правильные решения о том, как обрабатывать или ускорять определенные операции на основе предполагаемой схемы использования. Обратите внимание, что эти подсказки не влияют на поведение или визуальные результаты, а только влияют на общую производительность панели и элементов внутри нее. Рекомендуется всегда рассматривать возможность указания правильного UsageHints, но помните, что некоторые UsageHints могут быть внутренне проигнорированы при определенных условиях (e.g. из-за аппаратных ограничений на целевой платформе). |
view-data-key |
string |
Используется для устойчивости данных представления, таких как развернутые состояния дерева, положение прокрутки или уровень масштаба. Этот ключ используется для сохранения и загрузки данных представления из хранилища данных представления. Если этот ключ не установлен, устойчивость отключена для связанного VisualElement. Дополнительные сведения см. в разделе Устойчивость данных представления в руководстве Unity. |
Классы USS
В таблице ниже перечислены все открытые имена свойств C# и связанные с ними селекторы USS.
| C# собственность | USS выбор | Описание |
|---|---|---|
ussClassName |
.unity-radio-button |
Имя USS-класса для элементов RadioButton. Unity добавляет этот USS-класс к каждому экземпляру элемента RadioButton. Любые стили, применённые к этому классу, влияют на все RadioButton, расположенные рядом с таблицей стилей или ниже неё в визуальном дереве. |
labelUssClassName |
.unity-radio-button__label |
Имя USS-класса для меток Label в элементах RadioButton. Unity добавляет этот USS-класс к Label подэлемента RadioButton если у RadioButton есть метка. |
inputUssClassName |
.unity-radio-button__input |
Имя USS-класса для элементов ввода в элементах RadioButton. Unity добавляет этот USS-класс к подэлементу ввода RadioButton. Вводный субэлемент обеспечивает отклики на манипулятор. |
checkmarkBackgroundUssClassName |
.unity-radio-button__checkmark-background |
Имя USS-класса для фона галочки в элементах RadioButton. Unity добавляет этот USS-класс к подэлементу фона галочки RadioButton. |
checkmarkUssClassName |
.unity-radio-button__checkmark |
Имя USS-класса для галочки в элементах RadioButton. Unity добавляет этот USS-класс к подэлементу галочки RadioButton. |
textUssClassName |
.unity-radio-button__text |
Имя USS-класса для текстовых элементов Text в элементах RadioButton. Unity добавляет этот USS-класс к текстовым подэлементам RadioButton. |
ussClassName |
.unity-base-field |
Имя USS-класса для элементов этого типа. |
labelUssClassName |
.unity-base-field__label |
Имя USS-класса для меток в элементах этого типа. |
inputUssClassName |
.unity-base-field__input |
Имя USS-класса для элементов ввода в элементах этого типа. |
noLabelVariantUssClassName |
.unity-base-field--no-label |
Имя USS-класса для элементов этого типа, когда метка отсутствует. |
labelDraggerVariantUssClassName |
.unity-base-field__label--with-dragger |
Имя USS-класса для меток в элементах этого типа, когда к ним прикреплён ползунок перетаскивания. |
mixedValueLabelUssClassName |
.unity-base-field__label--mixed-value |
Имя USS-класса для элементов, отображающих смешанные значения |
alignedFieldUssClassName |
.unity-base-field__aligned |
Имя USS-класса для элементов, выровненных внутри элемента инспектора |
disabledUssClassName |
.unity-disabled |
Имя USS-класса для локально отключённых элементов. |
Вы также можете использовать раздел Соответствующие селекторы в отладчике Inspector или UI Toolkit, чтобы увидеть, какие селекторы USS влияют на компоненты VisualElement на каждом уровне его иерархии.