Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • HexGridScaledToFitDto

Index

Constructors

constructor

  • new HexGridScaledToFitDto(wdith?: number, height?: number, nrHexagonsU?: number, nrHexagonsV?: number, centerGrid?: boolean, pointsOnGround?: boolean): HexGridScaledToFitDto
  • Parameters

    • Optional wdith: number
    • Optional height: number
    • Optional nrHexagonsU: number
    • Optional nrHexagonsV: number
    • Optional centerGrid: boolean
    • Optional pointsOnGround: boolean

    Returns HexGridScaledToFitDto

Properties

Optional centerGrid

centerGrid: boolean

If true, the grid center (based on totalWidth/totalHeight) will be at [0,0,0].

default

false

Optional extendBottom

extendBottom: boolean

If true, shift the entire grid down by half hex height.

default

false

Optional extendLeft

extendLeft: boolean

If true, shift the entire grid left by half hex width.

default

false

Optional extendRight

extendRight: boolean

If true, shift the entire grid right by half hex width.

default

false

Optional extendTop

extendTop: boolean

If true, shift the entire grid up by half hex height.

default

false

Optional flatTop

flatTop: boolean

If true, the hexagons will be oriented with their flat sides facing up and down.

default

false

Optional height

height: number

Total desired height for the grid area. Note: due to hexagon geometry, the actual grid height might differ slightly if maintaining regular hexagons based on width.

default

10

minimum

0

maximum

Infinity

step

0.1

Optional nrHexagonsInHeight

nrHexagonsInHeight: number

Number of hexagons desired in height.

default

10

minimum

0

maximum

Infinity

step

1

Optional nrHexagonsInWidth

nrHexagonsInWidth: number

Number of hexagons desired in width.

default

10

minimum

0

maximum

Infinity

step

1

Optional pointsOnGround

pointsOnGround: boolean

If true, swaps Y and Z coordinates and sets Y to 0, placing points on the XZ ground plane.

default

false

Optional width

width: number

Total desired width for the grid area. The hexagon size will be derived from this and nrHexagonsU.

default

10

minimum

0

maximum

Infinity

step

0.1

Generated using TypeDoc