PointerEventBase<T0>
класс в UnityEngine.UIElements
Наследуется от:UIElements.EventBase_1
Выполнено в:UnityEngine.UIElementsModule
Интерфейсы приспособлений:IPointerEvent
Описание
Базовый класс для всех событий, связанных с указателем.
События указателя отправляются, когда пользователь взаимодействует с мышью, сенсорным экраном или цифровой ручкой.
По умолчанию события указателя просачиваются вниз по иерархии визуальных элементов, а затем возвращаются в корень.
Цикл событий указателя происходит следующим образом:
- Пользователь нажимает кнопку мыши, касается экрана или иным образом вызывает отправку PointerDownEvent.
- Если пользователь меняет состояние указателя, отправляется событие PointerMoveEvent. Несколько событий PointerMove отправляются, если изменяются несколько свойств указателя.
- Если пользователь отменяет цикл, то отправляется PointerCancelEvent.
- Если пользователь не отменяет цикл, и либо отпускает последнюю нажатую кнопку, либо отпускает последнее прикосновение, отправляется PointerUpEvent.
- Если начальные PointerDownEvent и PointerUpEvent встречаются на одном и том же визуальном элементе, отправляется ClickEvent.
См. События указателя для получения дополнительной информации и примеров см. страницу руководства.
Свойства
| Свойство | Описание |
|---|---|
| actionKey | Получает логическое значение, указывающее, нажата ли клавиша действия для конкретной платформы. |
| altitudeAngle | Получает угол наклона стилуса относительно поверхности в радианах |
| altKey | Получает логическое значение, указывающее, нажата ли клавиша Alt. |
| azimuthAngle | Получает угол наклона стилуса относительно оси x в радианах. |
| button | Возвращает значение, указывающее, какая кнопка мыши была нажата или отпущена (если таковая была нажата или отпущена), чтобы вызвать это событие: 0 — левая кнопка, 1 — правая кнопка, 2 — средняя кнопка. Отрицательное значение означает, что во время этого события ни одна кнопка мыши не меняла своего состояния. |
| clickCount | Получает число последовательных последовательностей вниз-вверх, выполненных за короткое время с одним и тем же указателем ID и кнопкой. |
| commandKey | Получает логическое значение, указывающее, нажата ли клавиша Windows/Cmd. |
| ctrlKey | Получает логическое значение, указывающее, нажата ли клавиша Ctrl. |
| currentTarget | Получает текущий конечный объект события. |
| deltaPosition | Получает разницу между положением указателя во время предыдущего события указателя и его положением во время текущего события указателя. |
| deltaTime | Получает время, прошедшее с момента последнего записанного изменения значений указателя, в секундах. |
| isPrimary | Получает логическое значение, указывающее, является ли указатель основным указателем. True означает, что указатель является основным указателем. False означает, что это не так. |
| localPosition | Получает позицию указателя в системе координат текущего объекта. |
| modifiers | Получает флаги, указывающие, нажаты ли клавиши модификаторов (Alt, Ctrl, Shift, Windows/Cmd). |
| penStatus | Указывает состояние пера. Например, касается ли перо экрана или планшета, перевёрнуто ли оно и нажаты ли кнопки. На macOS penStatus не отражает изменения в назначении кнопок. |
| pointerId | Получает идентификатор указателя, который отправил событие. |
| pointerType | Получает тип указателя, создавшего событие. |
| position | Получает позицию указателя в системе координат панели. |
| pressedButtons | Получает битмаску, описывающую кнопки, которые в данный момент нажаты. |
| pressure | Получает величину давления, которое в настоящее время применяется при прикосновении. |
| radius | Получает оценку радиуса касания. |
| radiusVariance | Получает точность радиуса касания. |
| shiftKey | Получает логическое значение, указывающее, нажата ли клавиша Shift. |
| tangentialPressure | Получает давление, приложенное к дополнительному чувствительному к давлению элементу управления на стилусе. |
| tilt | Указывает угол ручки относительно осей X и Y соответственно, в радианах. |
| twist | Получает поворот стилуса вокруг своей оси в радианах. |
Защищенные методы
| Метод | Описание |
|---|---|
| Init | Сброс членов события до их исходных значений. |
Статические методы
| Метод | Описание |
|---|---|
| GetPooled | Получает событие из пула событий и инициализирует его с указанными значениями. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, должны быть выпущены обратно в пул. Вы можете использовать Dispose() для их выпуска. |
Унаследованные члены 4
Свойства
| Свойство | Описание |
|---|---|
| bubbles | Возвращает информацию о том, появляется ли этот тип события в пути распространения событий во время фазы BubbleUp. |
| currentTarget | Текущий объект события. Это VisualElement в пути распространения, для которого в настоящее время выполняются обработчики событий. |
| dispatch | Показывает, отправляется ли событие в визуальный элемент. Событие не может быть переадресовано в процессе отправки. Если необходимо рекурсивно отправить событие, рекомендуется использовать копию события. |
| ignoreDisabledElements | Если это свойство установлено на true, обратные вызова для этого события не вызываются при отключении текущей цели, если только эти обратные вызова не зарегистрированы с помощью параметра CallbackOptions.IncludeDisabled. |
| imguiEvent | IMGUIEvent в источнике этого события. Источник может быть нулевым, поскольку не все события генерируются IMGUI. |
| isImmediatePropagationStopped | Указывает, был ли вызван StopImmediatePropagation для этого события. |
| isPropagationStopped | Возвращает true, если StopPropagation или StopImmediatePropagation были вызваны для этого события. |
| originalMousePosition | Первоначальное положение мыши в событии IMGUI до его преобразования в текущие целевые локальные координаты. |
| pooled | Выделяется ли событие из пула событий. |
| propagationPhase | Текущая фаза распространения этого события. |
| target | Конечный визуальный элемент, получивший это событие. В отличие от currentTarget, этот конечный элемент не изменяется, когда событие отправляется другим элементам по пути распространения. |
| timestamp | Время отправки события в миллисекундах. |
| tricklesDown | Возвращает информацию о том, отправляется ли это событие по пути распространения событий в фазе TrickleDown. |
| eventTypeId | См. EventBase.eventTypeId. |
Открытые методы
| Метод | Описание |
|---|---|
| StopImmediatePropagation | Остановка распространения события на другие конечные объекты и предотвращение получения события другими подписчиками события на этом конечном объекте. |
| StopPropagation | Прекращает распространение события на другие конечные объекты. Все подписчики на событие на этом конечном объекте по-прежнему получают событие. |
| Dispose | Осуществление IDispose. |
Защищенные методы
| Метод | Описание |
|---|---|
| PostDispatch | Позволяет подклассам выполнять настраиваемую логику после отправки события. |
| PreDispatch | Позволяет подклассам выполнять настраиваемую логику до отправки события. |
Статические методы
| Метод | Описание |
|---|---|
| RegisterEventType | Регистрирует класс события в системе типов событий. |
| GetPooled | Получает событие из пула событий. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, должны быть выпущены обратно в пул. Вы можете использовать Dispose() для их выпуска. |
| SetCreateFunction | Позволяет предоставить функцию для создания экземпляра события без зависимости от Activator.CreateInstance. |
| TypeId | Получает тип ID для этого экземпляра события. |