Back to FabImage Library website

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

TestShapeInShape


Header:FIL.h
Namespace:fil

Tests whether a shape lies inside another one.

Syntax

C++
C#
 
void fil::TestShapeInShape
(
	const fil::Path& inSubShape,
	const fil::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

List of possible exceptions:

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

See Also