Struct HexTerrainMetrics
Metrics of the HexTerrain. Contains information about the size of the terrain, chunk size, number of cells, etc.
Inherited Members
Namespace: Fwt.HexTerrains.Data
Assembly: fwt.hexterrains.dll
Syntax
public struct HexTerrainMetricsFields
CellsCount
Total number of cells in the terrain.
Declaration
public int CellsCountField Value
| Type | Description |
|---|---|
| int |
CellsCountInChunk
Total number of cells in one chunk.
Declaration
public int CellsCountInChunkField Value
| Type | Description |
|---|---|
| int |
ChunkSize_Cells
Size of the chunk in cells.
Declaration
public int2 ChunkSize_CellsField Value
| Type | Description |
|---|---|
| int2 |
ChunkSize_Units
Size of the chunk in units (meters).
Declaration
public float2 ChunkSize_UnitsField Value
| Type | Description |
|---|---|
| float2 |
ChunksCount
Total number of chunks in the terrain.
Declaration
public int ChunksCountField Value
| Type | Description |
|---|---|
| int |
ChunksGridSize
Size of the terrain in chunks.
Declaration
public int2 ChunksGridSizeField Value
| Type | Description |
|---|---|
| int2 |
HexAreaSize
Size of the hexagon area in meters (rect in which the hexagon fits).
Declaration
public float2 HexAreaSizeField Value
| Type | Description |
|---|---|
| float2 |
HexSideSize
Size of the hexagon side (radius) in units.
Declaration
public float HexSideSizeField Value
| Type | Description |
|---|---|
| float |
TerrainSize_Cells
Size of the terrain in cells.
Declaration
public int2 TerrainSize_CellsField Value
| Type | Description |
|---|---|
| int2 |
TerrainSize_Units
Size of the terrain in units (meters).
Declaration
public float2 TerrainSize_UnitsField Value
| Type | Description |
|---|---|
| float2 |
Methods
CreateMetrics(HexTerrainSettings)
Creates a new instance of HexTerrainMetrics based on the provided terrain settings.
Declaration
public static HexTerrainMetrics CreateMetrics(HexTerrainSettings terrainSettings)Parameters
| Type | Name | Description |
|---|---|---|
| HexTerrainSettings | terrainSettings | terrain settings to create a terrain metrics based on |
Returns
| Type | Description |
|---|---|
| HexTerrainMetrics | Terrain metrics calculated based on terrain settings |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |