Bitbybit Docs
    Preparing search index...

    Class SpicyBoxDto (Things.ThreeDPrinting.Boxes.SpicyBox)

    Parameters of things.threeDPrinting.boxes.spicyBox.create. The sides, radii, heights and bands shape the wall, the ornament values set its zig-zag ridges, and rotation, scale, direction and origin place it. The texts, baseHeight and fillet are not used yet.

    Implements

    Index

    Constructors

    • Parameters

      • OptionaltextTop: string
      • OptionaltextFront: string
      • OptionalnrSides: number
      • OptionalnrOffsets: number
      • Optionalheight: number
      • OptionalcoverHeight: number
      • OptionalbaseHeight: number
      • OptionalradiusBottom: number
      • OptionalradiusTopOffset: number
      • Optionalthickness: number
      • OptionalornamentalThickness: number
      • OptionalnrOrnamnetsPerSide: number
      • OptionalinvertOrnaments: boolean
      • Optionalfillet: number
      • Optionalprecision: number
      • Optionalrotation: number
      • Optionalscale: number
      • Optionalorigin: Bit.Inputs.Base.Point3
      • Optionaldirection: Vector3

      Returns SpicyBoxDto

    Properties

    textTop: string

    Text meant for the lid. The current build does not use it.

    Pepper
    
    textFront: string

    Text meant for the front. The current build does not use it.

    For Your Spicy Needs
    
    nrSides: number

    Number of sides of the wall polygon.

    4
    

    3

    16

    1

    nrOffsets: number

    Number of bands stacked up the wall. In each band the wall bulges out by radiusOffset and comes back in.

    1
    

    0

    Infinity

    1

    height: number

    Height of the box in model units. The ornamented wall fills it except for the top coverHeight.

    6
    

    0.1

    Infinity

    0.1

    radiusBase: number

    Radius of the inner wall polygon, from its center to a corner, in model units.

    4
    

    0

    Infinity

    0.1

    radiusOffset: number

    How far each band of the wall bulges out beyond radiusBase, in model units.

    2
    

    0

    Infinity

    0.1

    coverHeight: number

    Height at the top of the box left free of the ornamented wall, in model units.

    1
    

    0

    Infinity

    0.1

    baseHeight: number

    Height meant for the base. The current build does not use it.

    1
    

    0

    Infinity

    0.1

    thickness: number

    Distance between the inner and outer wall surfaces, in model units, added to every radius.

    0.6
    

    0.05

    Infinity

    0.01

    ornamentalThickness: number

    Depth of the zig-zag ridges, in model units: the zig-zag runs between two polygons this far apart.

    0.1
    

    0.05

    Infinity

    0.01

    nrOrnamnetsPerSide: number

    Number of zig-zags along each side of the polygon.

    10
    

    1

    Infinity

    1

    invertOrnaments: boolean

    When true, the zig-zags start on the outer polygon instead of the inner one, so the ridges swap places with the valleys.

    false
    
    fillet: number

    Radius meant for rounding the edges. The current build does not use it.

    0.2
    

    0.01

    Infinity

    0.01

    precision: number

    Meshing precision that drawModel uses, multiplied by scale. Building the shape ignores it.

    0.01
    

    0.000001

    5

    0.001

    rotation: number

    Turn of the box around the Y axis, in degrees, applied before it is scaled, aligned to direction and moved to origin.

    0
    

    0

    Infinity

    10

    scale: number

    Uniform scale factor applied to the whole box before it is placed. drawModel multiplies its edge width and meshing precision by it too.

    1
    

    0

    Infinity

    10

    Point the center of the box's bottom is moved to.

    [0, 0, 0]
    
    direction: Vector3

    Direction the box's up axis points along after placement. The default keeps it upright along Y.

    [0, 1, 0]