You are here: Start » AVL.NET » AVL.TestPointInShape

AVL.TestPointInShape

Tests whether a point lies inside a shape.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void TestPointInShape
(
	AvlNet.Point2D inPoint,
	AvlNet.Path inShape,
	out bool outIsContained
)

Parameters

Name Type Range Default Description
inPointAvlNet.Point2DPoint the position of which will be tested.
inShapeAvlNet.PathShape against which the position will be tested.
outIsContainedboolTrue 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