IGridMap2D

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 IGridMap2D

Summary

Represents a 2D grid map capable of converting between world and grid coordinates.

Metadata

Namespace: GridPlacement.Core.Interfaces.Grid

Source File: cs/Core/Interfaces/Grid/IGridMap2D.cs

Assembly: GridPlacement.Core

Type: interface

Methods

WorldToGrid

1

CoreVector2I WorldToGrid(CoreVector2 worldPosition)

Converts a world-space position to a grid-space position.

Parameters

NameDescription
worldPositionThe world-space position.

Returns

The corresponding grid-space position.

GridToWorld

1

CoreVector2 GridToWorld(CoreVector2I gridPosition)

Converts a grid-space position to a world-space position.

Parameters

NameDescription
gridPositionThe grid-space position.

Returns

The corresponding world-space position.

IsValidGridPosition

1

bool IsValidGridPosition(CoreVector2I gridPosition)

Returns whether a grid-space position is within the valid bounds of the map.

Parameters

NameDescription
gridPositionThe grid-space position.

Returns

true if valid; otherwise false.