Instance Method

contains(_:)

Returns a Boolean value indicating whether the area enclosed by the receiver contains the specified point.

Declaration

func contains(_ point: CGPoint) -> Bool

Parameters

point

The point to test against the path, specified in the path object's coordinate system.

Return Value

true if the point is considered to be within the path’s enclosed area or false if it is not.

Discussion

The receiver contains the specified point if that point is in a portion of a closed subpath that would normally be painted during a fill operation. This method uses the value of the usesEvenOddFillRule property to determine which parts of the subpath would be filled.

A point is not considered to be enclosed by the path if it is inside an open subpath, regardless of whether that area would be painted during a fill operation. Therefore, to determine mouse hits on open paths, you must create a copy of the path object and explicitly close any subpaths (using the close() method) before calling this method.

See Also

Hit Detection

var isEmpty: Bool

A Boolean value indicating whether the path has any valid elements.

var bounds: CGRect

The bounding rectangle of the path.