Back to FabImage Library website

You are here: Start » Function Reference » Shape Relations » TestPointInShape

TestPointInShape


Header:FIL.h
Namespace:fil

Tests whether a point lies inside a shape.

Syntax

C++
C#
 
void fil::TestPointInShape
(
	const fil::Point2D& inPoint,
	const fil::Path& inShape,
	bool& outIsContained
)

Parameters

Name Type Default Description
inPoint const Point2D& Point the position of which will be tested
inShape const Path& Shape against which the position will be tested
outIsContained bool& True if point lies inside the shape, false otherwise

Description

The operation tests if inPoint lies inside inShape.

Due to inaccuracy of floating point representation a point lying extremely close to a path may considered to be on either of the sides of the path or exactly on the path itself.

Examples

TestPointInShape run on the sample data produces the outIsContained = true

TestPointInShape run on the sample data produces the outIsContained = false

Errors

List of possible exceptions:

Error type Description
DomainError Empty shape on input in TestPointInShape.
DomainError Open path on input in TestPointInShape.

See Also