.. Automatically generated by KiBot, please don't edit this file

.. index::
   pair: 3D Printed Stencils; stencil_3d

3D Printed Stencils
~~~~~~~~~~~~~~~~~~~

Creates a 3D self-registering model of a stencil you can easily print on
SLA printer, you can use it to apply solder paste to your PCB. |br|
These stencils are quick solution when you urgently need a stencil but probably
they don't last long and might come with imperfections. |br|
It currently uses KiKit, so please read
`KiKit docs <https://github.com/yaqwsx/KiKit/blob/master/doc/stencil.md>`__. |br|
Note that we don't implement `--ignore` option, you should use a variant for this

Type: ``stencil_3d``

Category: **PCB/fabrication/assembly**

Parameters:

-  **comment** :index:`: <pair: output - stencil_3d; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
-  **dir** :index:`: <pair: output - stencil_3d; dir>` [string='./'] Output directory for the generated files.
   If it starts with `+` the rest is concatenated to the default dir.
-  **name** :index:`: <pair: output - stencil_3d; name>` [string=''] Used to identify this particular output definition.
   Avoid using `_` as first character. These names are reserved for KiBot.
-  **options** :index:`: <pair: output - stencil_3d; options>` [dict] Options for the `stencil_3d` output.

   -  Valid keys:

      -  **output** :index:`: <pair: output - stencil_3d - options; output>` [string='%f-%i%I%v.%x'] Filename for the output (%i='stencil_3d_top'|'stencil_3d_bottom'|'stencil_3d_edge',
         %x='stl'|'scad'|'dxf'|'png'). Affected by global options.
      -  **thickness** :index:`: <pair: output - stencil_3d - options; thickness>` [number=0.15] Stencil thickness [mm]. Defines amount of paste dispensed.
      -  ``create_preview`` :index:`: <pair: output - stencil_3d - options; create_preview>` [boolean=true] Creates a PNG showing the generated 3D model.
      -  ``cutout`` :index:`: <pair: output - stencil_3d - options; cutout>` [string|list(string)] List of components to add a cutout based on the component courtyard.
         This is useful when you have already pre-populated board and you want to populate more
         components.
      -  ``dnf_filter`` :index:`: <pair: output - stencil_3d - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.
         A short-cut to use for simple cases where a variant is an overkill.

      -  *enlarge_holes* :index:`: <pair: output - stencil_3d - options; enlarge_holes>` Alias for enlarge_holes.
      -  ``enlargeholes`` :index:`: <pair: output - stencil_3d - options; enlargeholes>` [number=0] Enlarge pad holes by x mm.
      -  *frame_clearance* :index:`: <pair: output - stencil_3d - options; frame_clearance>` Alias for frameclearance.
      -  *frame_width* :index:`: <pair: output - stencil_3d - options; frame_width>` Alias for framewidth.
      -  ``frameclearance`` :index:`: <pair: output - stencil_3d - options; frameclearance>` [number=0] Clearance for the stencil register [mm].
      -  ``framewidth`` :index:`: <pair: output - stencil_3d - options; framewidth>` [number=1] Register frame width.
      -  ``include_scad`` :index:`: <pair: output - stencil_3d - options; include_scad>` [boolean=true] Include the generated OpenSCAD files.
         Note that this also includes the DXF files.
      -  *pcb_thickness* :index:`: <pair: output - stencil_3d - options; pcb_thickness>` Alias for pcbthickness.
      -  ``pcbthickness`` :index:`: <pair: output - stencil_3d - options; pcbthickness>` [number=0] PCB thickness [mm]. If 0 we will ask KiCad.
      -  ``pre_transform`` :index:`: <pair: output - stencil_3d - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
         A short-cut to use for simple cases where a variant is an overkill.

      -  ``side`` :index:`: <pair: output - stencil_3d - options; side>` [string='auto'] [top,bottom,auto,both] Which side of the PCB we want. Using `auto` will detect which
         side contains solder paste.
      -  ``variant`` :index:`: <pair: output - stencil_3d - options; variant>` [string=''] Board variant to apply.

-  **type** :index:`: <pair: output - stencil_3d; type>` 'stencil_3d'
-  ``category`` :index:`: <pair: output - stencil_3d; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
   Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
   The categories are currently used for `navigate_results`.

-  ``disable_run_by_default`` :index:`: <pair: output - stencil_3d; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output.
   Useful when this output extends another and you don't want to generate the original.
   Use the boolean true value to disable the output you are extending.
-  ``extends`` :index:`: <pair: output - stencil_3d; extends>` [string=''] Copy the `options` section from the indicated output.
   Used to inherit options from another output of the same type.
-  ``groups`` :index:`: <pair: output - stencil_3d; groups>` [string|list(string)=''] One or more groups to add this output. In order to catch typos
   we recommend to add outputs only to existing groups. You can create an empty group if
   needed.

-  ``output_id`` :index:`: <pair: output - stencil_3d; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
-  ``priority`` :index:`: <pair: output - stencil_3d; priority>` [number=50] [0,100] Priority for this output. High priority outputs are created first.
   Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
-  ``run_by_default`` :index:`: <pair: output - stencil_3d; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.