AutoMovie API
    Preparing search index...

    Function autoMoviePlanarRegionFailure

    • Return the first deterministic hygiene failure in one planar region, or null when every ring describes one unambiguous bounded region.

      The result is a message rather than repaired geometry. Drawing, triangulation, and support decomposition need different outputs, but they must agree on whether their shared input has an interior. A caller that can report a gap may retain the message; a constructor can throw it verbatim.

      Each ring is checked in declaration order, outer ring first, for at least three points, finite coordinates, no point repeated beside itself, a nonzero area, no spike doubling back along its own edge, and no crossing between non-neighbouring edges. Then every ring pair is checked for any shared point, and finally every hole must lie inside the outer ring and outside every other hole. Zero means within the absolute PLANAR_EPSILON (1e-12) of square metres or metres. Messages name rings as <label> outer ring and <label> hole[i], with label defaulting to polygon.

      Parameters

      • props: IAutoMoviePlanarRegionFailure.IProps

        Rings for deterministic planar-region hygiene checks. The checking function returns null when they describe one unambiguous bounded region.

        The result is a message rather than repaired geometry. Drawing, triangulation, and support decomposition need different outputs, but they must agree on whether their shared input has an interior. A caller that can report a gap may retain the message; a constructor can throw it verbatim.

        Each ring is checked in declaration order, outer ring first, for at least three points, finite coordinates, no point repeated beside itself, a nonzero area, no spike doubling back along its own edge, and no crossing between non-neighbouring edges. Then every ring pair is checked for any shared point, and finally every hole must lie inside the outer ring and outside every other hole. Zero means within the absolute PLANAR_EPSILON (1e-12) of square metres or metres. Messages name rings as <label> outer ring and <label> hole[i], with label defaulting to polygon.

        • Optionalholes?: ReadonlyArray<readonly IAutoMoviePlanarPoint[]>

          Borrowed simple rings strictly inside outer and outside one another, with no touching or crossing; omitted or empty means no voids.

        • Optionallabel?: string

          Diagnostic region name; omitted defaults to polygon and an explicitly empty string stays empty.

        • outer: readonly IAutoMoviePlanarPoint[]

          Borrowed finite x/y metre outer ring with at least three points and implicit closure; simple, nonzero-area and either winding.

      Returns string | null

      The first failure message, or null for an admissible region.