IIndicatorService

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 interface IIndicatorService

Summary

Service interface for indicator management.

This service handles the creation and management of visual indicators that show placement validity and other feedback to the user.

Metadata

Namespace: GridPlacement.Core.Services.Placement

Source File: cs/Core/Services/Placement/IIndicatorService.cs

Assembly: GridPlacement.Core

Type: interface

Properties

IsReady

1
public abstract bool IsReady { get; }

Gets whether the indicator service is ready for operations.


Methods

CreateIndicatorModel

1
2
3
4
IndicatorModel CreateIndicatorModel(
    PreviewModel previewModel,
    PlacementReport report
)

Creates an indicator model based on the preview model and placement report.

Parameters

NameDescription
previewModelThe preview model containing placement data.
reportThe placement report containing validation results.

Returns

An indicator model with visual feedback data.


UpdateIndicatorModel

1
2
3
4
5
void UpdateIndicatorModel(
    IndicatorModel indicatorModel,
    PreviewModel previewModel,
    PlacementReport report
)

Updates existing indicators with new data.

Parameters

NameDescription
indicatorModelThe indicator model to update.
previewModelThe updated preview model.
reportThe updated placement report.

ClearIndicators

1
void ClearIndicators()

Clears all active indicators.