bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Class HexagonsInGridDto

    Index

    Constructors

    constructor

    Properties

    width? height? nrHexagonsInWidth? nrHexagonsInHeight? flatTop? extendTop? extendBottom? extendLeft? extendRight? scalePatternWidth? scalePatternHeight? filletPattern? inclusionPattern?

    Constructors

    • Parameters

      • Optionalwdith: number
      • Optionalheight: number
      • OptionalnrHexagonsInHeight: number
      • OptionalnrHexagonsInWidth: number
      • OptionalflatTop: boolean
      • OptionalextendTop: boolean
      • OptionalextendBottom: boolean
      • OptionalextendLeft: boolean
      • OptionalextendRight: boolean
      • OptionalscalePatternWidth: number[]
      • OptionalscalePatternHeight: number[]
      • OptionalfilletPattern: number[]
      • OptionalinclusionPattern: boolean[]

      Returns HexagonsInGridDto

    Properties

    width?: number

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

    10

    0

    Infinity

    0.1

    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.

    10

    0

    Infinity

    0.1

    nrHexagonsInWidth?: number

    Number of hexagons desired in width.

    10

    0

    Infinity

    1

    nrHexagonsInHeight?: number

    Number of hexagons desired in height.

    10

    0

    Infinity

    1

    flatTop?: boolean

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

    false
    extendTop?: boolean

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

    false
    extendBottom?: boolean

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

    false
    extendLeft?: boolean

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

    false
    extendRight?: boolean

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

    false
    scalePatternWidth?: number[]

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

    undefined

    true

    scalePatternHeight?: number[]

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

    undefined

    true

    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

    undefined

    true

    inclusionPattern?: boolean[]

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

    undefined

    true

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties