An NSPanGestureRecognizer object implements a continuous gesture recognizer for panning (dragging) gestures. The gesture is recognized when the user clicks all of specified buttons, drags the mouse, and releases one or more of the buttons. Use the pan gesture recognizer object to retrieve the distance traveled during the pan and the location of the mouse as it pans.


Upon creation, the gesture recognizer is configured to recognize pan gestures involving only the primary button. It also delays sending primary button events to the view by setting the delaysPrimaryMouseButtonEvents property to true. To change the set of buttons to track, modify the buttonMask property.

In this gesture recognizer, the location(in:) method always reports the current mouse point, which changes as the user drags the mouse.


Configuring the Gesture Recognizer

var buttonMask: Int

A bit mask of the button (or buttons) required to recognize this gesture.

Tracking the Location and Velocity of the Gesture

func translation(in: NSView?)

The distance traveled by the mouse during the gesture.

func setTranslation(NSPoint, in: NSView?)

Changes the current translation value of the gesture recognizer.

func velocity(in: NSView?)

The velocity of the pan, measured in points per second.

Instance Properties

var numberOfTouchesRequired: Int

The number of touches required in an NSTouchBar object for the gesture recognizer to match.


Inherits From