class in UnityEngine.UIElements
/
Inherits from:UIElements.PointerEventBase_1
/
Implemented in:UnityEngine.UIElementsModule
The event sent when the left mouse button is clicked.
A click consists of a mouse down event followed by a mouse up event on the same VisualElement. The mouse might move between the two events.
| ClickEvent | Constructor. |
| bubbles | Whether this event type bubbles up in the event propagation path. |
| currentTarget | The current target of the event. This is the VisualElement, in the propagation path, for which event handlers are currently being executed. |
| dispatch | Whether 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. |
| eventTypeId | Retrieves the type ID for this event instance. |
| imguiEvent | The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI. |
| isDefaultPrevented | Return true if the default actions should not be executed for this event. |
| isImmediatePropagationStopped | Whether StopImmediatePropagation() was called for this event. |
| isPropagationStopped | Whether StopPropagation() was called for this event. |
| originalMousePosition | The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates. |
| pooled | Whether the event is allocated from a pool of events. |
| propagationPhase | The current propagation phase. |
| target | The 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. |
| timestamp | The time when the event was created. |
| tricklesDown | Whether this event is sent down the event propagation path during the TrickleDown phase. |
| eventTypeId | Retrieves the type ID for this event instance. |
| actionKey | Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. |
| altitudeAngle | Angle of the stylus relative to the surface, in radians |
| altKey | Returns true if the Alt key is pressed. |
| azimuthAngle | Angle of the stylus relative to the x-axis, in radians. |
| button | Integer that indicates which mouse button is pressed: 0 is the left button, 1 is the right button, 2 is the middle button. |
| clickCount | The number of times the button is pressed. |
| commandKey | Returns true if the Windows/Cmd key is pressed. |
| ctrlKey | Returns true if the Ctrl key is pressed. |
| currentTarget | The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. |
| deltaPosition | The difference between the pointer's position during the previous mouse event and its position during the current mouse event. |
| deltaTime | The amount of time that has passed since the last recorded change in pointer values, in seconds. |
| isPrimary | Returns true if the pointer is a primary pointer |
| localPosition | The pointer position in the current target coordinate system. |
| modifiers | Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd). |
| pointerId | Identifies the pointer that sends the event. |
| pointerType | The type of pointer that created this event. This value is taken from the value defined in `PointerType`. |
| position | The pointer position in the Screen or World coordinate system. |
| pressedButtons | A bitmask that describes the currently pressed buttons. |
| pressure | The amount of pressure currently applied by a touch. If the device does not report pressure, the value of this property is 1.0f. |
| radius | An estimate of the radius of a touch. Add `radiusVariance` to get the maximum touch radius, subtract it to get the minimum touch radius. |
| radiusVariance | Determines the accuracy of the touch radius. Add this value to the radius to get the maximum touch radius, subtract it to get the minimum touch radius. |
| shiftKey | Returns true if the Shift key is pressed. |
| tangentialPressure | The pressure applied to an additional pressure-sensitive control on the stylus. |
| twist | The rotation of the stylus around its axis, in radians. |
| Dispose | Implementation of IDisposable. |
| PreventDefault | Whether the default actions are prevented from being executed for this event. |
| StopImmediatePropagation | Immediately 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. |
| StopPropagation | Stops 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. |
| Dispose | Implementation of IDispose. |
| Init | Resets all event members to their initial values. |
| Init | Resets all event members to their initial values. |
| Init | Resets the event members to their initial values. |
| RegisterEventType | Registers an event class to the event type system. |
| GetPooled | Gets an event from the event pool. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use `Dispose()` to release them. |
| TypeId | Gets the type ID for the event class. |
| GetPooled | Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use `Dispose()` to release them. |