Version: 2019.1
Experimental: this API is experimental and might be changed or removed in the future.

MouseEventBase<T0>

class in UnityEngine.Experimental.UIElements

/

Inherits from:Experimental.UIElements.EventBase_1


Implements interfaces:IMouseEvent

Switch to Manual

Description

The base class for mouse events.

Variables

actionKeyReturns true if the platform specific action key is pressed. This key is Command on macOS and Control otherwise.
altKeyReturns true if the Alt key is pressed.
buttonInteger representing the pressed mouse button: 0 is left, 1 is right, 2 is center.
clickCountNumber of clicks.
commandKeyReturns true if the Windows/Command key is pressed.
ctrlKeyReturns true if the Control key is pressed.
currentTargetThe current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.
localMousePositionThe mouse position in the current target coordinate system.
modifiersFlags holding the pressed modifier keys (Alt, Control, Shift, Windows/Command).
mouseDeltaThe difference of the mouse position between the previous mouse event and the current mouse event.
mousePositionThe mouse position in the screen coordinate system.
shiftKeyReturns true if the Shift key is pressed.

Protected Functions

InitResets the event members to their initial values.

Static Functions

GetPooledGets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose().

Inherited members

Variables

bubblesWhether this event type bubbles up in the event propagation path.
currentTargetThe current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.
dispatchWhether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event.
flagsFlags for the event.
imguiEventThe IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI.
isDefaultPreventedReturn true if the default actions should not be executed for this event.
isImmediatePropagationStoppedWhether StopImmediatePropagation() was called for this event.
isPropagationStoppedWhether StopPropagation() was called for this event.
originalMousePositionThe original mouse position of the IMGUI event, before it is transformed to the current target local coordinates.
pooledWhether the event is allocated from a pool of events.
propagationPhaseThe current propagation phase.
targetThe target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path.
timestampThe time when the event was created.
tricklesDownWhether this event is sent down the event propagation path during the TrickleDown phase.

Public Functions

DisposeImplementation of IDisposable.
GetEventTypeIdRetrieves the type id for this event instance.
PreventDefaultWhether the default actions are prevented from being executed for this event.
StopImmediatePropagationImmediately stops the propagation of the event. The event is not sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target.
StopPropagationStops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target.
DisposeImplementation of IDispose.
GetEventTypeIdRetrieves the type id for this event instance.

Static Functions

RegisterEventTypeRegisters an event class to the event type system.
GetPooledGets an event from the event pool. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose().
TypeIdGets the type id for the event class.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961