Version: 2020.1
LanguageEnglish
  • C#

Clickable

class in UnityEngine.UIElements

/

Inherits from:UIElements.PointerManipulator

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Manipulator that tracks Mouse events on an element and callbacks when the elements is clicked.

Properties

activeThis property tracks the activation of the manipulator. Set it to true when the manipulator is activated.
lastMousePositionSpecifies the mouse position saved during the last mouse event on the target Element.

Constructors

ClickableConstructor.

Protected Methods

InvokeInvokes a click action.
OnMouseDownThis method is called when a MouseDownEvent is sent to the target element.
OnMouseMoveThis method is called when a MouseMoveEvent is sent to the target element.
OnMouseUpThis method is called when a MouseUpEvent is sent to the target element.
ProcessDownEventThis method processes the down event sent to the target Element.
ProcessMoveEventThis method processes the move event sent to the target Element.
ProcessUpEventThis method processes the up event sent to the target Element.
RegisterCallbacksOnTargetCalled to register mouse event callbacks on the target element.
UnregisterCallbacksFromTargetCalled to unregister event callbacks from the target element.

Events

clickedCallback triggerred when the target element is clicked.
clickedWithEventInfoCallback triggerred when the target element is clicked.

Inherited Members

Properties

targetVisualElement being manipulated.
activatorsList of Activationfilters.

Protected Methods

CanStartManipulationChecks whether MouseEvent satisfies all of the ManipulatorActivationFilter requirements.
CanStopManipulationChecks whether the MouseEvent is related to this Manipulator.
CanStartManipulationChecks whether PointerEvent satisfies all of the ManipulatorActivationFilter requirements.
CanStopManipulationChecks whether the PointerEvent is related to this Manipulator.

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