Version: 2021.1
LanguageEnglish
  • C#

ManipulatorActivationFilter

struct in UnityEngine.UIElements

/

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

Used by manipulators to match events against their requirements.

using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;

public class ClickableTest { public void CreateClickable() { var clickable = new Clickable(() => { Debug.Log("Clicked!"); }); clickable.activators.Add(new ManipulatorActivationFilter { button = MouseButton.LeftMouse }); clickable.activators.Add(new ManipulatorActivationFilter { button = MouseButton.RightMouse, clickCount = 2, modifiers = EventModifiers.Control }); } }

Properties

buttonThe button that activates the manipulation.
clickCountNumber of mouse clicks required to activate the manipulator.
modifiersAny modifier keys (ie. ctrl, alt, ...) that are needed to activate the manipulation.

Public Methods

MatchesChecks whether the current mouse event satisfies the activation requirements.