ModeService

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 ModeService : IModeService

Summary

Default implementation of IModeService. Owns a single Mode value and raises ModeChangedEvent when it changes.

Metadata

Namespace: GridPlacement.Core.Services.Mode

Source File: cs/Core/Services/Mode/ModeService.cs

Assembly: GridPlacement.Core

Type: class

Implements

  • IModeService

Constructors

ModeService

1
public ModeService()

Properties

Current

1
public GridMode Current { get; }

Gets the current grid mode for the placement system.


Methods

SetMode

1
public void SetMode(GridMode mode)

Sets the current grid mode.

Parameters

NameDescription
modeThe grid mode to switch to.

Remarks

If the mode does not change, this method is a no-op and does not raise ModeChanged.


Events

ModeChanged

1
public event EventHandler<ModeChangedEvent>? ModeChanged

Occurs when the current grid mode changes.

Remarks

Raised only when SetMode updates the mode value.