Bitbybit Docs
    Preparing search index...

    Class HexGridScaledToFitDto (Inputs.Point)

    The area, counts and orientation for point.hexGridScaledToFit, which sizes hexagons so the given number of them fills the width and height.

    Index

    Constructors

    constructor

    Properties

    width? height? nrHexagonsInWidth? nrHexagonsInHeight? flatTop? extendTop? extendBottom? extendLeft? extendRight? centerGrid? pointsOnGround?

    Constructors

    • Parameters

      • Optionalwidth: number
      • Optionalheight: number
      • OptionalnrHexagonsInHeight: number
      • OptionalnrHexagonsInWidth: number
      • OptionalcenterGrid: boolean
      • OptionalpointsOnGround: boolean

      Returns HexGridScaledToFitDto

    Properties

    width?: number

    The total width to fill, in model units; the hexagon size follows from it and nrHexagonsInWidth.

    10

    0

    Infinity

    0.1

    height?: number

    The total height to fill, in model units. Regular hexagons may not tile it exactly, so the real height can differ slightly.

    10

    0

    Infinity

    0.1

    nrHexagonsInWidth?: number

    How many hexagons across.

    10

    0

    Infinity

    1

    nrHexagonsInHeight?: number

    How many hexagons from top to bottom.

    10

    0

    Infinity

    1

    flatTop?: boolean

    When true, the hexagons have a flat edge at the top and bottom; when false a corner points up.

    false
    extendTop?: boolean

    When true, the grid is stretched so its top row reaches past the top edge, filling the rectangle without a jagged border there.

    false
    extendBottom?: boolean

    When true, the grid is stretched so its bottom row reaches past the bottom edge, filling the rectangle without a jagged border there.

    false
    extendLeft?: boolean

    When true, the grid is stretched so its left column reaches past the left edge, filling the rectangle without a jagged border there.

    false
    extendRight?: boolean

    When true, the grid is stretched so its right column reaches past the right edge, filling the rectangle without a jagged border there.

    false
    centerGrid?: boolean

    When true, the middle of the grid sits at the origin instead of its corner.

    false
    pointsOnGround?: boolean

    When true, the grid lies on the XZ ground plane (Y becomes 0) instead of the XY plane.

    false

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties