Back to Adaptive Vision Library website

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

TestShapeInShape


Tests whether a shape lies inside another one.

Syntax

C++
C#
 
void avl::TestShapeInShape
(
	const avl::Path& inSubShape,
	const avl::Path& inShape,
	bool& outIsContained
)

Parameters

Name Type Default Description
inSubShape const Path& Shape the position of which will be tested
inShape const Path& Shape against which the position will be tested
outIsContained bool& True if whole shape lies inside the other one, false otherwise

Description

The operation tests if inSubShape lies (in its entirety) 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.

Errors

Error type Description
DomainError Open path on input in TestShapeInShape.
DomainError Empty path on input (inSubShape) in TestShapeInShape.

See Also