Bitbybit Docs
    Preparing search index...

    Class BuildRecipeDocumentDtoBeta (Inputs.OCCT)

    A recipe for recipes.buildDocument, with the name of the top assembly, the tag that groups roots into products, whether a failed root stops the build, and how large a mesh is built. Experimental: the recipe format may still change.

    Index

    Constructors

    • Beta

      Parameters

      • Optionalrecipe: Recipe
      • Optionalname: string
      • OptionalgroupBy: string
      • OptionalemptyWhenFailed: boolean
      • OptionalfacetedMeshes: boolean
      • OptionalmaxTriangles: number

      Returns BuildRecipeDocumentDto

    Properties

    recipe: Recipe

    The recipe: steps such as polygons, extrusions and cuts, and the roots to build from them, as a package that describes geometry as data writes it.

    undefined
    
    name?: string

    The name of the assembly at the top of the document, which holds every product.

    Recipe
    
    groupBy?: string

    The tag whose value gathers roots into one product, such as the pieces of one element in different colours. Roots without it are each a product of their own.

    globalId
    
    emptyWhenFailed?: boolean

    When true, a root that cannot be built is left out of the document and an opening that cannot is left uncut; when false, either stops the build.

    false
    
    facetedMeshes?: boolean

    When true, triangle meshes become faceted solids, flat faces that cut and fillet like any shape; when false they keep their triangles, which draw, measure and export to STEP faster.

    false
    
    maxTriangles?: number

    The most triangles a mesh built as a faceted solid may hold; a larger one is not built and counts as a step that failed.

    100000
    

    0

    Infinity

    10000