Options
All
  • Public
  • Public/Protected
  • All
Menu
Logo of bit by bit developers

Class HexagonsInGridDto

Hierarchy

  • HexagonsInGridDto

Index

Constructors

Properties

Constructors

constructor

  • new HexagonsInGridDto(wdith?: number, height?: number, nrHexagonsInHeight?: number, nrHexagonsInWidth?: number, flatTop?: boolean, extendTop?: boolean, extendBottom?: boolean, extendLeft?: boolean, extendRight?: boolean, scalePatternWidth?: number[], scalePatternHeight?: number[], filletPattern?: number[], inclusionPattern?: boolean[]): HexagonsInGridDto

  • Parameters

    • Optional wdith: number
    • Optional height: number
    • Optional nrHexagonsInHeight: number
    • Optional nrHexagonsInWidth: number
    • Optional flatTop: boolean
    • Optional extendTop: boolean
    • Optional extendBottom: boolean
    • Optional extendLeft: boolean
    • Optional extendRight: boolean
    • Optional scalePatternWidth: number[]
    • Optional scalePatternHeight: number[]
    • Optional filletPattern: number[]
    • Optional inclusionPattern: boolean[]

    Returns HexagonsInGridDto

Properties

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 filletPattern

filletPattern: number[]

Hex fillet scale pattern - numbers between 0 and 1, if 0 is used, no fillet is applied, if 1 is used, the fillet will be exactly half of the length of the shorter side of the hex

default

undefined

optional

true

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 inclusionPattern

inclusionPattern: boolean[]

Inclusion pattern - true means that the hex will be included, false means that the hex will be removed

default

undefined

optional

true

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 scalePatternHeight

scalePatternHeight: number[]

Hex scale pattern on height direction - numbers between 0 and 1, if 1 or undefined is used, no scaling is applied

default

undefined

optional

true

Optional scalePatternWidth

scalePatternWidth: number[]

Hex scale pattern on width direction - numbers between 0 and 1, if 1 or undefined is used, no scaling is applied

default

undefined

optional

true

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