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

MouseCaptureEventBase<T0>

class in UnityEngine.Experimental.UIElements

Implements interfaces:IMouseCaptureEvent

Description

Event sent when the handler capturing the mouse changes.

Init	Reset the event members to their initial value.

Retrieves an event from the event pool. Use this method to retrieve a mouse event and initialize the event, instead of creating a new mouse event.

bubbles	Returns whether this event type bubbles up in the event propagation path.
capturable	Return whether this event is sent down the event propagation path during the capture phase.
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.
dispatch	Return whether the event is currently being dispatched to visual element. An event can not be redispatched while being dispatched. If you need to recursively redispatch an event, you should use a copy.
flags	Flags for the event.
imguiEvent	The IMGUIEvent at the source of this event. This can be null as not all events are generated by IMGUI.
isDefaultPrevented	Return true if the default actions should not be executed for this event.
isImmediatePropagationStopped	Return true if StopImmediatePropagation() has been called for this event.
isPropagationStopped	Return true if StopPropagation() has been called for this event.
originalMousePosition	The original mouse position of the IMGUI event, before it is transformed to the local element coordinates.
propagationPhase	The current propagation phase.
target	The target for this event. The is the visual element that received the event. Unlike currentTarget, target does not change when the event is sent to elements along the propagation path.
timestamp	The time at which the event was created.

Dispose	Implementation of IDisposable.
GetEventTypeId	Get the type id for this event instance.
PreventDefault	Call this function to prevent the execution of the default actions for this event.
StopImmediatePropagation	Immediately stop the propagation of this event. The event will not be sent to any further event handlers on the current target or on any other element in the propagation path.
StopPropagation	Stop the propagation of this event. The event will not be sent to any further element in the propagation path. Further event handlers on the current target will be executed.
Dispose	Implementation of IDispose.
GetEventTypeId	Get the type id for this event instance.

RegisterEventType	Register an event class to the event type system.
GetPooled	Get an event from the event pool. Use this function instead of newing events. Events obtained from this function should be released back to the pool using ReleaseEvent().
ReleasePooled	Release an event obtained from GetPooled().
TypeId	Get the type id for this event instance.

Did you find this page useful? Please give it a rating: