Instance Method

alignmentFeedbackTokenForHorizontalMovement(in:previousX:alignedX:defaultX:)

Requests a feedback token for the alignment of an object requiring horizontal movement only.

Declaration

func alignmentFeedbackTokenForHorizontalMovement(in view: NSView?, previousX: CGFloat, alignedX: CGFloat, defaultX: CGFloat) -> NSAlignmentFeedbackToken?

Parameters

view

The view (NSView) in which the object was moved.

previousPoint

The horizontal location (CGFloat) of the object prior to its move.

alignedPoint

The new horizontal location (CGFloat) of the object if alignment occurs.

defaultPoint

The current horizontal location (CGFloat) of the object. This is where the user actually moved the object. This location may be offset from the location of the cursor.

Return Value

If the system determines that the alignment should not occur, a null value is returned. Otherwise, a feedback token of type NSAlignmentFeedbackToken is returned.

Discussion

This method requests a feedback token for the alignment of an object requiring horizontal movement only.

If a feedback token is returned, call performFeedback(_:performanceTime:) to initiate haptic feedback. Then, move the object to its aligned location.

If no feedback token is returned, don’t perform the horizontal alignment or request haptic feedback. Even if this horizontal alignment fails, be sure to check other alignments. For example, a vertical alignment may still be allowed. If no alignments will occur, move the object to its default location.

See Also

Preparing Haptic Feedback for Alignment

func alignmentFeedbackTokenForMovement(in: NSView?, previousPoint: NSPoint, alignedPoint: NSPoint, defaultPoint: NSPoint)

Requests a feedback token for the alignment of an object requiring horizontal and vertical movement.

func alignmentFeedbackTokenForVerticalMovement(in: NSView?, previousY: CGFloat, alignedY: CGFloat, defaultY: CGFloat)

Requests a feedback token for the alignment of an object requiring vertical movement only.