Export_3DOptions parameters

• download : [boolean] (default: true) Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR.
  They are downloaded to a temporal directory and discarded.
  If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.

• format : [string] (default: 'step') (choices: “step”, “glb”, “stl”, “xao”, “brep”, “ply”, “u3d”, “pdf”) 3D format used.

  • STEP: ISO 10303-21 Clear Text Encoding of the Exchange Structure

  • GLB: Binary version of the glTF, Graphics Library Transmission Format or GL Transmission Format and formerly

  known as WebGL Transmissions Format or WebGL TF.
  

  • STL: 3D printer format, from stereolithography CAD software created by 3D Systems.
    

  • XAO: XAO (SALOME/Gmsh) format, used for FEM and simulations.
    

  • BRep: Part of Open CASCADE Technology (OCCT)

  • PLY: Polygon File Format or the Stanford Triangle Format (KiCad 10+).
    

  • U3D: Universal 3D (ECMA-363) primarily used to embed interactive 3D models into PDF documents. (KiCad 10+)

  • PDF: Portable Document Format with the 3D model (KiCad 10+).

• no_virtual : [boolean] (default: false) Used to exclude 3D models for components with ‘virtual’ attribute.

• origin : [string] (default: 'grid') (choices: “grid”, “drill”, “center”) (also accepts any string) Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet.
  The drill option uses the auxiliary reference defined by the user.
  Using center you’ll get the center of the board as origin.
  You can define any other origin using the format ‘X,Y’, i.e. ‘3.2,-10’. Don’t put units here.
  The units used here are the ones specified by the units option.

• output : [string] (default: '%f-%i%I%v.%x') Name for the generated 3D file (%i=’3D’ %x=’step/glb/stl/xao/brep/ply/u3d/pdf’). Affected by global options.

• board_only : [boolean] (default: false) Only generate a board with no components.

• cut_vias_in_body : [boolean] (default: false) Cut via holes in board body even if conductor layers are not exported.

• dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
  Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

• download_lcsc : [boolean] (default: true) In addition to try to download the 3D models from KiCad git also try to get them from LCSC database. In order to work you’ll need to provide the LCSC part number. The field containing the LCSC part number is defined by the field_lcsc_part global variable.

• exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
  Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

• fill_all_vias : [boolean] (default: false) Don’t cut via holes in conductor layers.

• fuse_shapes : [boolean] (default: false) Fuse overlapping geometry together.

• include_inner_copper : [boolean] (default: false) Export elements on inner copper layers.

• include_pads : [boolean] (default: false) Export pads.

• include_silkscreen : [boolean] (default: false) Export silkscreen graphics as a set of flat faces.

• include_soldermask : [boolean] (default: false) Export soldermask layers as a set of flat faces.

• include_tracks : [boolean] (default: false) Export tracks and vias.

• include_zones : [boolean] (default: false) Export zones.

• kicad_3d_url : [string] (default: 'https://gitlab.com/api/v4/projects/21604637/repository/files/') Base URL for the KiCad 3D models.

• kicad_3d_url_suffix : [string] (default: '/raw?ref=VERSION') Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.

• kicad_3d_url_version : [boolean] (default: true) Replace the master subdir in the URL by the KiCad version. In this way we download the 3D model corresponding to the installed KiCad instead of the last available.

• min_distance : [number] (default: -1) The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm). The units for this option are controlled by the units option.

• net_filter : [string] (default: '') Only include copper items belonging to nets matching this wildcard.

• no_board_body : [boolean] (default: false) Exclude board body.

• no_components : [boolean] (default: false) Exclude 3D models for components.

• no_optimize_step : [boolean] (default: false) Do not optimize STEP file (enables writing parametric curves).

• pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
  Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

• subst_models : [boolean] (default: true) Substitute STEP or IGS models with the same name in place of VRML models.

• units : [string] (default: 'millimeters') (choices: “millimeters”, “inches”, “mils”) Units used for the custom origin and min_distance. Affected by global options.

• variant : [string] (default: '') Board variant to apply.