PreviewCalculationResult

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1

public class PreviewCalculationResult

Summary

Result of preview calculation containing footprint and visual data. This is a pure Core DTO that can be used without Godot dependencies.

Metadata

Namespace: GridPlacement.Core.Data.Placement

Source File: cs/Core/Data/Placement/PreviewCalculationResult.cs

Assembly: GridPlacement.Core

Type: class

Properties

FootprintData

1

public FootprintData FootprintData { get; set; }

The footprint data used for this calculation.

FootprintPositions

1

public List<CoreVector2I> FootprintPositions { get; set; }

Calculated footprint positions for the preview.

Bounds

1

public CoreRect2I Bounds { get; set; }

Bounding rectangle of the preview in grid coordinates.

IsValidPlacement

1

public bool IsValidPlacement { get; set; }

Whether the preview placement is valid at the calculated position.

Transparency

1

public float Transparency { get; set; }

Recommended transparency for the preview (0.0 to 1.0).

TintColor

1

public CoreColor TintColor { get; set; }

Recommended color tint for the preview.

ShapeData

1

public PreviewShapeData ShapeData { get; set; }

Shape configuration for the preview.

Issues

1

public List<string> Issues { get; set; }

Issues encountered during calculation.

Notes

1

public List<string> Notes { get; set; }

Additional diagnostic information.

Methods

HasIssues

1

public bool HasIssues()

Gets whether the calculation has any issues.

AddIssue

1

public void AddIssue(string issue)

Adds an issue to the result.

AddNote

1

public void AddNote(string note)

Adds a note to the result.