Bitbybit Docs
    Preparing search index...

    Class SpicyBox

    A spice box with a many-sided wall ornamented in zig-zag ridges that bulge out in bands up its height. Only the inner and outer wall surfaces are built so far: the texts, base, cover and rounding in its inputs are not used yet. It is computed for members of the Silver and Gold plans.

    Index

    Constructors

    create

    get shapes

    Constructors

    create

    • Builds the ornamented inner and outer wall surfaces of the spice box, standing on Y.

      The wall is a polygon with nrSides corners whose zig-zag ridges bulge out by radiusOffset in nrOffsets bands. The surfaces come back as a compound, not a closed solid, and the inputs are not checked. It throws when the caller is not on the Silver or Gold plan.

      Parameters

      • inputs: SpicyBoxDto

        Sides, bands, sizes, ornament settings, scale and placement

      Returns Promise<SpicyBoxData<TopoDSShapePointer>>

      The box data with the wall surfaces in compound and the inputs they were built from

    get shapes