Bitbybit Docs
    Preparing search index...

    Class HexagonsInGridDto (Inputs.OCCT)

    A rectangle, hexagon counts and optional patterns for shapes.wire.hexagonsInGrid and shapes.face.hexagonsInGrid, which fill the rectangle on the ground plane with a honeycomb.

    Index

    Constructors

    • Parameters

      • Optionalwidth: 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

    The width of the rectangle to fill, in model units; the hexagon size follows from it and the counts.

    10
    

    0

    Infinity

    0.1

    height?: number

    The height of the rectangle to fill, in model units.

    10
    

    0

    Infinity

    0.1

    nrHexagonsInWidth?: number

    How many hexagons fit across the width.

    10
    

    0

    Infinity

    1

    nrHexagonsInHeight?: number

    How many hexagons fit across the height.

    10
    

    0

    Infinity

    1

    flatTop?: boolean

    When true, the hexagons have a flat side 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, covering it without a jagged border.

    false
    
    extendBottom?: boolean

    When true, the grid is stretched so its bottom row reaches past the bottom edge, covering it without a jagged border.

    false
    
    extendLeft?: boolean

    When true, the grid is stretched so its left column reaches past the left edge, covering it without a jagged border.

    false
    
    extendRight?: boolean

    When true, the grid is stretched so its right column reaches past the right edge, covering it without a jagged border.

    false
    
    scalePatternWidth?: number[]

    Sizes of the hexagons along the width as fractions of their full size, applied in turn; 1 or no list means no scaling.

    undefined
    

    true

    scalePatternHeight?: number[]

    Sizes of the hexagons along the height as fractions of their full size, applied in turn; 1 or no list means no scaling.

    undefined
    

    true

    filletPattern?: number[]

    Corner rounding of the hexagons as fractions from 0 to 1 of the largest radius that fits, applied in turn; 0 leaves sharp corners.

    undefined
    

    true

    inclusionPattern?: boolean[]

    Which hexagons are built, applied in turn: true builds one, false skips it.

    undefined
    

    true