VRMLOptions 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.no_virtual : [boolean] (default:
false) Used to exclude 3D models for components with ‘virtual’ attribute.output : [string] (default:
'%f-%i%I%v.%x') Filename for the output (%i=vrml, %x=wrl). Affected by global options.show_components : [list(string) | string] (default:
'all') (choices: “none”, “all”) (also accepts any string) List of components to draw, can be also a string for none or all. Ranges like R5-R10 are supported.
Unlike the pcbdraw output, the default is all.dir_models: [string] (default:'shapes3D') Subdirectory used to store the 3D models for the components. If you want to create a monolithic file just use ‘’ here.
Note that the WRL file will contain relative paths to the models.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.highlight: [list(string)] (default:[]) List of components to highlight. Ranges like R5-R10 are supported.highlight_on_top: [boolean] (default:false) Highlight over the component (not under).highlight_padding: [number] (default:1.5) (range: 0 to 1000) How much the highlight extends around the component [mm].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.model_units: [string] (default:'millimeters') (choices: “millimeters”, “meters”, “deciinches”, “inches”) Units used for the VRML (1 deciinch = 0.1 inches).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.ref_units: [string] (default:'millimeters') (choices: “millimeters”, “inches’”) Units for ref_x and ref_y.ref_x: [number] (default:0) X coordinate to use as reference when use_pcb_center_as_ref and use_pcb_center_as_ref are disabled.ref_y: [number] (default:0) Y coordinate to use as reference when use_pcb_center_as_ref and use_pcb_center_as_ref are disabled.use_aux_axis_as_origin: [boolean] (default:false) Use the auxiliary axis as origin for coordinates. Has more precedence than use_pcb_center_as_ref.use_pcb_center_as_ref: [boolean] (default:true) The center of the PCB will be used as reference point. When disabled the ref_x, ref_y and ref_units will be used.variant: [string] (default:'') Board variant to apply.