A closed polygon whose interior should be meshed with quadrilaterals, with its holes, scheme, spacing and tagging policy. More...
#include <meshkit/regions.hpp>
Public Attributes | |
| std::int32_t | attribute = 0 |
| Cell region id (Cell::region) the native job writes on quads of patches planned from this region; 0 = none. | |
| Polygon | ring |
| Closed (last == first optional), simple, any orientation. | |
| Vector< Polygon > | holes |
| Areas subtracted from ring (QUAD_EVERYWHERE_PLAN_2026-09-07.md §3.1): domain hole rings, and the rings of any explicit region nested inside this one. | |
| bool | isBackground = false |
| True when ring IS a domain outline rather than a ring drawn inside one — the "toggle quads on for the whole model" case. | |
| QuadRegionMode | mode = QuadRegionMode::Auto |
| Requested scheme (default Auto). | |
| bool | requireMapped = false |
| Explicit hard requirement, used by unified planning. | |
| bool | automaticCandidate = false |
| Derived candidate; no outline constraint on fallback. | |
| double | spacing = 0.0 |
| Target quad edge length h; 0 = derive from the size field / max area. | |
| bool | directionalSpacing |
| Explicit Mapped spacing; failure must not fall back to isotropic cells. | |
| double | hAlong = 0.0 |
| Spacing for the pair of opposite mapped sides more nearly parallel to the mappedAlongAngleDeg axis; positive and finite in mesh units, used only when directionalSpacing. | |
| double | hAcross |
| Positive spacings in mesh CRS units, used only when directionalSpacing. | |
| double | mappedAlongAngleDeg |
| Physical undirected along-axis, degrees from +x CCW; independent of ring start. | |
| double | aspectMax |
| Free: opposite-side mean ratio cap; < 0 inherits global, 0 unbounded, >= 1 explicit. | |
| bool | hasAlignAngle = false |
| Free: constant cross field at alignAngleDeg (from +x, CCW). | |
| double | alignAngleDeg = 0.0 |
| Free: cross-field angle in degrees from +x, counterclockwise; meaningful only when hasAlignAngle. | |
| Vector< Point2 > | alignGuide |
| Free: optional polyline the field aligns to (streets, channels). | |
| Vector< int > | corners |
| Mapped: 4 ring vertex indices in ring order; empty = auto-pick. | |
| Text | tag |
| MeshTriangle::tag for every cell inside; empty = inherit region marker's. | |
A closed polygon whose interior should be meshed with quadrilaterals, with its holes, scheme, spacing and tagging policy.
Coordinates and lengths are in mesh XY units.
| double meshkit::plan::QuadRegion::alignAngleDeg = 0.0 |
Free: cross-field angle in degrees from +x, counterclockwise; meaningful only when hasAlignAngle.
No native MeshKit algorithm reads it; adapters carry it through.
Free: optional polyline the field aligns to (streets, channels).
| double meshkit::plan::QuadRegion::aspectMax |
Free: opposite-side mean ratio cap; < 0 inherits global, 0 unbounded, >= 1 explicit.
| std::int32_t meshkit::plan::QuadRegion::attribute = 0 |
Cell region id (Cell::region) the native job writes on quads of patches planned from this region; 0 = none.
The job then spreads nonzero ids to every cell of the same constrained component and fails on conflicting ids.
| bool meshkit::plan::QuadRegion::automaticCandidate = false |
Derived candidate; no outline constraint on fallback.
| Vector<int> meshkit::plan::QuadRegion::corners |
Mapped: 4 ring vertex indices in ring order; empty = auto-pick.
| bool meshkit::plan::QuadRegion::directionalSpacing |
Explicit Mapped spacing; failure must not fall back to isotropic cells.
| double meshkit::plan::QuadRegion::hAcross |
Positive spacings in mesh CRS units, used only when directionalSpacing.
| double meshkit::plan::QuadRegion::hAlong = 0.0 |
Spacing for the pair of opposite mapped sides more nearly parallel to the mappedAlongAngleDeg axis; positive and finite in mesh units, used only when directionalSpacing.
| bool meshkit::plan::QuadRegion::hasAlignAngle = false |
Free: constant cross field at alignAngleDeg (from +x, CCW).
| bool meshkit::plan::QuadRegion::isBackground = false |
True when ring IS a domain outline rather than a ring drawn inside one — the "toggle quads on for the whole model" case.
Two consequences: the ring is NOT re-emitted as constraint segments (the domain boundary is already in the PSLG, and duplicating it would double every boundary edge), and the "region lies inside exactly one domain ring" validation is skipped because the region is that ring.
| double meshkit::plan::QuadRegion::mappedAlongAngleDeg |
Physical undirected along-axis, degrees from +x CCW; independent of ring start.
| QuadRegionMode meshkit::plan::QuadRegion::mode = QuadRegionMode::Auto |
Requested scheme (default Auto).
The native joint planner (planQuadRegions()) treats every mode except TrianglesOnly as a four-sided mapped-patch candidate; validateQuadRegion() allows directional spacing only with Auto or Mapped.
| bool meshkit::plan::QuadRegion::requireMapped = false |
Explicit hard requirement, used by unified planning.
| Polygon meshkit::plan::QuadRegion::ring |
Closed (last == first optional), simple, any orientation.
| double meshkit::plan::QuadRegion::spacing = 0.0 |
Target quad edge length h; 0 = derive from the size field / max area.
| Text meshkit::plan::QuadRegion::tag |
MeshTriangle::tag for every cell inside; empty = inherit region marker's.