Within
Namespace: Digi21.DigiNG.Entities.Relations
Assembly: Digi21.DigiNG
Indicates whether the first area is inside the second and shares at least one vertex with it.


public static bool Within(ReadOnlyLine a, ReadOnlyLine b)
public static bool Within(ReadOnlyLine a, ReadOnlyPolygon b)
public static bool Within(ReadOnlyPolygon a, ReadOnlyLine b)
public static bool Within(ReadOnlyPolygon a, ReadOnlyPolygon b)
| Parameter | Description |
|---|---|
a |
Area to test for containment in b: a closed ReadOnlyLine or a ReadOnlyPolygon. |
b |
Containing area. |
Return value
true if all three conditions are met:
- No vertex of
ais outsideb. A vertex inside a hole ofbis outsideb. - At least one vertex of
acoincides with a vertex ofb. - No vertex of
b, including holes, is insidea.
If no vertex of a is inside b (all are common or lie on edges of b), the method calculates an interior point of a and returns true if that point is inside b.
If a is inside b without common vertices, this method returns false and CompletelyWithin(a, b) returns true. To cover both cases, combine Within(a, b) || CompletelyWithin(a, b). The method is asymmetric: to find whether b is inside a, call Within(b, a).
Exceptions
| Exception | When |
|---|---|
ArgumentNullException |
a or b is null. |
SEHException |
An area has an unclosed ring, a ring with zero area or a spike. See AreaArea exceptions. |
Example
See the AreaArea example.