Руководство API скрипты

Scroller

класс в UnityEngine.UIElements / Наследует от: UIElements.VisualElement / Реализовано в: UnityEngine.UIElementsModule

Описание

Вертикальная или горизонтальная полоса прокрутки.

Статические Свойства

highButtonUssClassName Имя класса USS верхних кнопок в элементах этого типа.
horizontalVariantUssClassName Имя класса USS элементов этого типа, когда они отображаются горизонтально.
lowButtonUssClassName Имя класса USS нижних кнопок в элементах этого типа.
sliderUssClassName Имя класса USS элементов ползунка в элементах этого типа.
ussClassName Имя класса USS элементов этого типа.
verticalVariantUssClassName Имя класса USS элементов этого типа, когда они отображаются вертикально.

Свойства

direction Направление этой полосы прокрутки.
highButton Верхняя или правая кнопка прокрутки.
highValue Максимальное значение.
lowButton Нижняя или левая кнопка прокрутки.
lowValue Минимальное значение.
slider Ползунок, используемый этим скроллером.
value Значение, определяющее положение ползунка. Он находится между lowValue и highValue.

Конструкторы

Scroller Конструктор.

Публичные Методы

Adjust Обновляет размер элемента ползунка как отношение общего диапазона. Значение больше 1 отключит Scroller.
ScrollPageDown Изменит значение в соответствии с текущим размером страницы ползунка.
ScrollPageUp Изменит значение в соответствии с текущим размером страницы ползунка.

События

valueChanged Событие отправляется при изменении значения ползунка.

Унаследованные члены

Статические Свойства

disabledUssClassName Имя класса USS локальных отключенных элементов.

Свойства

canGrabFocus Вовращает true, если элемент может быть сфокусирован.
delegatesFocus Должен ли элемент делегировать фокус своим дочерним элементам.
focusable True, если элемент может быть сфокусирован.
focusController Вовращает контроллер фокуса для этого элемента.
tabIndex Целое число, используемое для сортировки объектов фокусировки в кольце фокусировки. Должно быть больше или равно нулю.
childCount Количество дочерних элементов в contentContainer объекта
contentContainer К этому элементу добавляются дочерние элементы
customStyle Возвращает метод доступа к свойствам пользовательского стиля для этого элемента.
enabledInHierarchy Возвращает true, если VisualElement включен в своей собственной иерархии.
enabledSelf Возвращает true, если VisualElement включен локально.
experimental Возвращает экспериментальные интерфейсы UIElement.
generateVisualContent Вызывается, когда необходимо (повторно) сгенерировать визуальное содержимое VisualElement.
hierarchy Доступ к физической иерархии этого элемента
pickingMode Определяет, можно ли выбрать этот элемент во время запросов mouseEvents или IPanel.Pick.
resolvedStyle Возвращает разрешенные значения стиля VisualElement.
schedule Извлекает IVisualElementScheduler этого VisualElement.
style Ссылка на объект стиля элемента.
styleSheets Возвращает VisualElementStyleSheetSet, управляющий таблицами стилей, прикрепленными к этому элементу.
this[int] Доступ к физической иерархии элемента
tooltip Текст, отображаемый внутри информационного поля после того, как пользователь наведет курсор на элемент в течение небольшого промежутка времени.
usageHints Комбинация значений подсказок, указывающих предполагаемые шаблоны использования высокого уровня для VisualElement. Это свойство можно задать только в том случае, если VisualElement еще не является частью панели. Будучи частью Panel, это свойство фактически становится доступным только для чтения, и попытки изменить его вызовут исключение. Спецификация надлежащих UsageHints побуждает систему принимать более эффективные решения о том, как обрабатывать или ускорять определенные операции на основе ожидаемого шаблона использования. Обратите внимание, что эти подсказки не влияют на поведенческие или визуальные результаты, а влияют только на общую производительность панели и элементов внутри. Как правило, рекомендуется всегда рассматривать вопрос об указании правильных UsageHints, но имейте в виду, что некоторые UsageHints могут игнорироваться внутри при определенных условиях (например, из-за аппаратных ограничений на целевой платформе).
userData Это свойство можно использовать для связывания пользовательских данных приложения с этим VisualElement.
viewDataKey Используется для сохранения данных просмотра (т. е. расширенных состояний дерева, положения прокрутки, уровня масштабирования).

Публичные Методы

HandleEvent Обработка события, чаще всего путем выполнения обратных вызовов, связанных с событием.
HasBubbleUpHandlers Возвращает true, если к этому объекту прикреплены обработчики событий для фазы распространения события BubbleUp.
HasTrickleDownHandlers Возвращает значение true, если к этому объекту присоединены обработчики событий для фазы распространения события TrickleDown.
RegisterCallback Добавляет обработчик событий в экземпляр. Если обработчик события уже зарегистрирован для той же фазы (TrickleDown или BubbleUp), то этот метод не действует.
SendEvent Отправляет событие обработчику событий.
UnregisterCallback Удаляет обратный вызов из экземпляра.
Blur Говорит элементу, чтобы освободить фокус.
Focus Пытается сосредоточить внимание на этом элементе.
Add Добавляет элемент в contentContainer этого элемента
BringToFront Помещает этот элемент в конец списка родительских дочерних элементов. Элемент будет визуально находиться перед любыми перекрывающимися одноуровневыми элементами.
Children Возвращает элементы из своего содержимогоконтейнера
Clear Удаляет все дочерние элементы из контейнера содержимого этого элемента.
Contains Возвращает true, если элемент является прямым дочерним элементом этого VisualElement.
ElementAt Извлекает дочерний элемент в позиции
EnableInClassList Включает или отключает класс с заданным именем.
FindAncestorUserData Находит иерархию этого визуального элемента и извлеките сохраненные пользовательские данные, если они будут найдены.
FindCommonAncestor Находит наименьшего общего предка между двумя элементами VisualElements внутри иерархии VisualTree.
GetClasses Получает классы для этого элемента.
GetFirstAncestorOfType Проходит вверх по иерархии, начиная с родительского элемента, и возвращает первый VisualElement этого типа.
GetFirstOfType Проходит вверх по иерархии, начиная с этого элемента, и возвращает первый VisualElement этого типа.
IndexOf Извлекает дочерний индекс указанного VisualElement.
Insert Вставьте элемент в contentContainer этого элемента
MarkDirtyRepaint Запускает перерисовку VisualElement в следующем кадре.
PlaceBehind Помещает элемент прямо перед родственным элементом в их родительском дочернем списке. Если элемент и позиция родственного элемента перекрываются, элемент будет визуально позади своего родственного элемента.
PlaceInFront Помещает элемент сразу после родственного элемента в список родительских дочерних элементов. Если элемент и позиция родственного элемента перекрываются, элемент будет визуально впереди своего родственного элемента.
Remove Удаляет дочерний элемент из иерархии
RemoveAt Удалите дочерний элемент, расположенный в этой позиции, из контейнера содержимого этого элемента.
RemoveFromHierarchy Удаляет элемент из его родительской иерархии
SendEvent Отправляет событие обработчику событий.
SendToBack Отправляет элемент в начало списка родительских дочерних элементов. Элемент будет визуально позади любых перекрывающихся элементов родственного уровня.
SetEnabled Изменяет состояние включения VisualElement. Отключенный VisualElement не получает большинство событий.
Sort Переупорядочивает дочерние элементы из этого контейнера содержимого VisualElement.
ToggleInClassList Переключает между добавлением и удалением данного имени класса из списка классов.
Вы можете отблагодарить автора, за перевод документации на русский язык. ₽ Спасибо
API скрипты 2021.3