Vixen
dd8b0a81
csharp
public readonly record struct RemeshReport

Everything measured about a remesh, which is the answer ZRemesher does not give.

Read the guide page for this →

Remarks

⚠ A remesher that cannot tell you it went wrong will be trusted until it embarrasses somebody. docs/plan/41 § Part 4. The report is what makes this usable in an unattended content build, and it is the difference between a build step and a button somebody watches.

⚠ Deviation is a fraction of the diagonal and never an absolute distance. The same lesson doc 24's Vixen.Geometry row records twice — the capsule's degenerate poles and the weld tolerance — because a fixed number is a claim about how big a model is, and the answer has to compare across models.

Fields and properties (13)

  • public int QuadCount

    How many four-sided faces came out.

  • public int NonQuadCount

    How many did not. ⚠ Must be zero; a non-zero is a bug rather than a setting.

  • public IReadOnlyList<Singularity> Singularities

    Every irregular vertex, with its valence.

  • public int SingularitiesOnFeatures

    How many landed on a feature polyline. Must be zero.

  • public float MaxDeviation

    The furthest the output strays from the source, as a fraction of the bounding-box diagonal.

  • public float MeanDeviation

    The average, on the same scale.

  • public float MinScaledJacobian

    The worst quad's shape quality. A negative one is inverted.

  • public float FeatureReproductionError

    The furthest a feature polyline sits from the nearest output edge.

  • public ConditioningReport Conditioning

    What stage one changed.

  • public MeshReport Mesh

    Doc 24's report on the output, unchanged.

  • public IReadOnlyList<RemeshStageTiming> Stages

    Time and element counts, per stage.

  • public IReadOnlyList<string> Warnings

    The shrinkwrap fired · N components dropped · a patch collapsed · the budget was not met.

  • public bool IsAllQuad

    Whether every face has four sides, which is what keeps doc 24's verbs working.

Methods (1)

  • public RemeshReport(int QuadCount, int NonQuadCount, IReadOnlyList<Singularity> Singularities, int SingularitiesOnFeatures, float MaxDeviation, float MeanDeviation, float MinScaledJacobian, float FeatureReproductionError, ConditioningReport Conditioning, MeshReport Mesh, IReadOnlyList<RemeshStageTiming> Stages, IReadOnlyList<string> Warnings)

    Everything measured about a remesh, which is the answer ZRemesher does not give.

Used by (19)

  • AttributeTransferTestsVixen.Geometry.Remeshing.Tests
  • BudgetWarningTestsVixen.Geometry.Remeshing.Tests
  • FacetedSurfaceTestsVixen.Geometry.Remeshing.Tests
  • LayoutAtlasTestsVixen.Geometry.Remeshing.Tests
  • QuadQualityTestsVixen.Geometry.Remeshing.Tests
  • RemeshBytesTestsVixen.Geometry.Remeshing.Tests
  • RemeshDeterminismTestsVixen.Geometry.Remeshing.Tests
  • RemeshDumpTestsVixen.Geometry.Remeshing.Tests
  • RemeshPipelinePropertyTestsVixen.Geometry.Remeshing.Tests
  • RemeshReportTestsVixen.Geometry.Remeshing.Tests
  • RemesherVixen.Geometry.Remeshing
  • RemesherTestsVixen.Geometry.Remeshing.Tests
  • SettingsHonouredTestsVixen.Geometry.Remeshing.Tests
  • SymmetryPassVixen.Geometry.Remeshing
  • SymmetryTestsVixen.Geometry.Remeshing.Tests
  • SymmetryTransferTestsVixen.Geometry.Remeshing.Tests
  • BlockoutRetopologyVixen.Editor.Blockout
  • GeometryRunnerVixen.Cli
  • ModelRetopologyVixen.Editor.Assets