Loading...
Searching...
No Matches
meshkit::plan::QuadPlan Struct Reference

Result of planQuadRegions(); patches are delivered only when ok is true. More...

#include <meshkit/planning.hpp>

Collaboration diagram for meshkit::plan::QuadPlan:

Public Attributes

bool ok = false
 True when planning completed, even if every region fell back to triangles.
 
bool cancelled = false
 True when PatchLimits::cancelled stopped planning.
 
bool resourceLimited = false
 True when a work, workspace, cell or station budget stopped planning, including a required region refused for a resource reason.
 
Text error
 Why ok is false; empty on success.
 
Vector< PatchMesh > patches
 Delivered patches with CCW cells, required regions first and then by region index; empty unless ok.
 
Vector< int > patchRegions
 Region index of each entry of patches (parallel array).
 
Vector< PatchDecision > decisions
 One decision per input region, indexed by region; kept, possibly incomplete, when ok is false.
 
std::uint64_t sharedSides = 0
 Region sides found identical (same coordinates, either direction) to a side of an earlier region.
 
std::uint64_t workUsed = 0
 Work units consumed; compare QuadPlanningOptions::workBudget.
 
std::uint64_t plannedCells = 0
 Total cells in patches; 0 unless ok.
 

Detailed Description

Result of planQuadRegions(); patches are delivered only when ok is true.

Member Data Documentation

◆ cancelled

bool meshkit::plan::QuadPlan::cancelled = false

True when PatchLimits::cancelled stopped planning.

◆ decisions

Vector<PatchDecision> meshkit::plan::QuadPlan::decisions

One decision per input region, indexed by region; kept, possibly incomplete, when ok is false.

◆ error

Text meshkit::plan::QuadPlan::error

Why ok is false; empty on success.

◆ ok

bool meshkit::plan::QuadPlan::ok = false

True when planning completed, even if every region fell back to triangles.

◆ patches

Vector<PatchMesh> meshkit::plan::QuadPlan::patches

Delivered patches with CCW cells, required regions first and then by region index; empty unless ok.

◆ patchRegions

Vector<int> meshkit::plan::QuadPlan::patchRegions

Region index of each entry of patches (parallel array).

◆ plannedCells

std::uint64_t meshkit::plan::QuadPlan::plannedCells = 0

Total cells in patches; 0 unless ok.

◆ resourceLimited

bool meshkit::plan::QuadPlan::resourceLimited = false

True when a work, workspace, cell or station budget stopped planning, including a required region refused for a resource reason.

◆ sharedSides

std::uint64_t meshkit::plan::QuadPlan::sharedSides = 0

Region sides found identical (same coordinates, either direction) to a side of an earlier region.

Counted before acceptance, so refused candidates are included.

◆ workUsed

std::uint64_t meshkit::plan::QuadPlan::workUsed = 0

Work units consumed; compare QuadPlanningOptions::workBudget.


The documentation for this struct was generated from the following file: