Function

NSPointInRect

Returns a Boolean value that indicates whether a given point is in a given rectangle.

Declaration

BOOL NSPointInRect(NSPoint aPoint, NSRect aRect);

Return Value

YES if aPoint is located within the rectangle represented by aRect, otherwise NO.

Discussion

Point-in-rectangle functions generally assume that the “upper” and “left” edges of a rectangle are inside the rectangle boundaries, while the “lower” and “right” edges are outside the boundaries. This method treats the “upper” and “left” edges of the rectangle as the ones containing the origin of the rectangle.

Special Considerations

The meanings of “upper” and “lower” (and “left” and “right”) are relative to the current coordinate system and the location of the rectangle. For a rectangle of positive height located in positive x and y coordinates:

  • In the default macOS desktop coordinate system—where the origin is at the bottom left—the rectangle edge closest to the bottom of the screen is the “upper” edge (and is considered inside the rectangle).

  • On iOS and in a flipped coordinate system in macOS desktop—where the origin is at the top left—the rectangle edge closest to the bottom of the screen is the “lower” edge (and is considered outside the rectangle).

See Also

Managing Rectangles

NSContainsRect

Returns a Boolean value that indicates whether one rectangle completely encloses another.

NSDivideRect

Divides a rectangle into two new rectangles.

NSEqualRects

Returns a Boolean value that indicates whether the two rectangles are equal.

NSIsEmptyRect

Returns a Boolean value that indicates whether a given rectangle is empty.

NSHeight

Returns the height of a given rectangle.

NSInsetRect

Insets a rectangle by a specified amount.

NSIntegralRect

Adjusts the sides of a rectangle to integer values.

NSIntegralRectWithOptions

Adjusts the sides of a rectangle to integral values using the specified options.

NSIntersectionRect

Calculates the intersection of two rectangles.

NSIntersectsRect

Returns a Boolean value that indicates whether two rectangles intersect.

NSMakeRect

Creates a new NSRect from the specified values.

NSMaxX

Returns the largest x coordinate of a given rectangle.

NSMaxY

Returns the largest y coordinate of a given rectangle.

NSMidX

Returns the x coordinate of a given rectangle’s midpoint.

NSMidY

Returns the y coordinate of a given rectangle’s midpoint.

NSMinX

Returns the smallest x coordinate of a given rectangle.

NSMinY

Returns the smallest y coordinate of a given rectangle.

NSMouseInRect

Returns a Boolean value that indicates whether the point is in the specified rectangle.

NSOffsetRect

Offsets the rectangle by the specified amount.

NSRectFromString

Returns a rectangle from a text-based representation.

NSStringFromRect

Returns a string representation of a rectangle.

NSRectFromCGRect

Returns an NSRect typecast from a CGRect.

NSRectToCGRect

Returns a CGRect typecast from an NSRect.

NSUnionRect

Calculates the union of two rectangles.

NSWidth

Returns the width of the specified rectangle.