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

PointerEventBase<T0>

класс в UnityEngine.UIElements / Наследует от: UIElements.EventBase_1 / Реализовано в: UnityEngine.UIElementsModule / Реализует интерфейсы: IPointerEvent

Описание

Base class for pointer events.

События указателя отправляются мышью, сенсорным экраном или цифровым пером.

Свойства

actionKey Возвращает true, если нажата клавиша действия для конкретной платформы. Эта клавиша Cmd на macOS и Ctrl на всех других платформах.
altitudeAngle Угол щупа относительно поверхности, в радианах
altKey Возвращает true, если нажата клавиша Alt.
azimuthAngle Угол стилуса относительно оси x, в радианах.
button Целое число, указывающее, какая кнопка мыши нажата: 0 — левая кнопка, 1 — правая кнопка, 2 — средняя кнопка.
clickCount Количество нажатий кнопки.
commandKey Возвращает true, если нажата клавиша Windows/Cmd.
ctrlKey Возвращает true, если нажата клавиша Ctrl.
currentTarget Текущая цель события. Текущая цель — это элемент пути распространения, для которого в данный момент выполняются обработчики событий..
deltaPosition Разница между положением указателя во время предыдущего события мыши и его положением во время текущего события мыши.
deltaTime Время, прошедшее с момента последнего записанного изменения значений указателя, в секундах.
isPrimary Возвращает true, если указатель является первичным указателем
localPosition Положение указателя в текущей целевой системе координат.
modifiers Флаги, удерживающие нажатые клавиши-модификаторы (Alt, Ctrl, Shift, Windows/Cmd).
pointerId Идентифицирует указатель, который отправляет событие.
pointerType Тип указателя, который создал это событие. Это значение берется из значения, определенного в `PointerType`.
position Положение указателя в экранной или мировой системе координат.
pressedButtons Битовая маска, описывающая нажатые в данный момент кнопки.
pressure Величина давления, применяемого в настоящее время прикосновением. Если устройство не сообщает о давлении, значение этого свойства равно 1,0f.
radius Оценка радиуса касания. Добавьте `radiusVariance`, чтобы получить максимальный радиус касания, вычтите его, чтобы получить минимальный радиус касания.
radiusVariance Определяет точность радиуса касания. Добавьте это значение к радиусу, чтобы получить максимальный радиус касания, вычтите его, чтобы получить минимальный радиус касания.
shiftKey Возвращает true, если нажата клавиша Shift.
tangentialPressure Давление применяется к дополнительному чувствительному к давлению элементу управления на стилусе.
twist Вращение стилуса вокруг своей оси в радианах.

Защищенные методы

Init Сбрасывает элементы события к их начальным значениям.

Статические Методы

GetPooled Получает событие из пула событий и инициализирует его заданными значениями. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, необходимо отправить обратно в пул. Вы можете использовать `Dispose()`, чтобы освободить их.

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

Свойства

bubbles Всплывает ли этот тип события на пути распространения события.
currentTarget Текущая цель события. Это VisualElement на пути распространения, для которого в настоящее время выполняются обработчики событий.
dispatch Отправляется ли событие визуальному элементу. Событие не может быть повторно отправлено во время его отправки. Если вам нужно рекурсивно отправить событие, рекомендуется использовать копию события.
eventTypeId Получает идентификатор типа для этого экземпляра события.
imguiEvent Событие IMGUIEvent в источнике этого события. Источник может быть нулевым, так как не все события генерируются IMGUI.
isDefaultPrevented Возвращает значение true, если действия по умолчанию не должны выполняться для этого события.
isImmediatePropagationStopped Вызывалась ли функция StopImmediatePropagation() для этого события.
isPropagationStopped Вызывалась ли функция StopPropagation() для этого события.
originalMousePosition Исходное положение мыши для события IMGUI до того, как оно будет преобразовано в текущие целевые локальные координаты.
pooled Выделяется ли событие из пула событий.
propagationPhase Текущий этап распространения.
target Целевой визуальный элемент, получивший это событие. В отличие от currentTarget, эта цель не меняется, когда событие отправляется другим элементам по пути распространения.
timestamp Время создания события.
tricklesDown Отправляется ли это событие по пути распространения события во время фазы TrickleDown.
eventTypeId Получает идентификатор типа для этого экземпляра события.

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

Dispose Реализация IDisposable.
PreventDefault Предотвращено ли выполнение действий по умолчанию для этого события.
StopImmediatePropagation Немедленно останавливает распространение события. Событие не отправляется другим элементам по пути распространения. Этот метод предотвращает выполнение других обработчиков событий для текущей цели.
StopPropagation Прекращает распространение этого события. Событие не отправляется другим элементам по пути распространения. Этот метод не препятствует выполнению других обработчиков событий для текущей цели.
Dispose Реализация IDispose.

Статические Методы

RegisterEventType Регистрирует класс события в системе типов событий.
GetPooled Получает событие из пула событий. Используйте эту функцию вместо создания новых событий. События, полученные с помощью этого метода, необходимо отправить обратно в пул. Вы можете использовать `Dispose()`, чтобы освободить их.
TypeId Получает идентификатор типа для класса события.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3