.. Automatically generated by KiBot, please don't edit this file .. index:: pair: VRML (Virtual Reality Modeling Language); vrml VRML (Virtual Reality Modeling Language) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Exports the PCB as a 3D model (WRL file). This is intended for rendering, unlike STEP which is intended to be an exact mechanic model Type: ``vrml`` Category: **PCB/3D** Parameters: - **comment** :index:`: ` [string=''] A comment for documentation purposes. It helps to identify the output. - **dir** :index:`: ` [string='./'] Output directory for the generated files. If it starts with `+` the rest is concatenated to the default dir. - **name** :index:`: ` [string=''] Used to identify this particular output definition. Avoid using `_` as first character. These names are reserved for KiBot. - **options** :index:`: ` [dict] Options for the `vrml` output. - Valid keys: - **download** :index:`: ` [boolean=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** :index:`: ` [boolean=false] Used to exclude 3D models for components with 'virtual' attribute. - **output** :index:`: ` [string='%f-%i%I%v.%x'] Filename for the output (%i=vrml, %x=wrl). Affected by global options. - **show_components** :index:`: ` [list(string)|string=all] [none,all] List of components to draw, can be also a string for `none` or `all`. Unlike the `pcbdraw` output, the default is `all`. - ``dir_models`` :index:`: ` [string='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`` :index:`: ` [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. - ``highlight`` :index:`: ` [list(string)=[]] List of components to highlight. - ``highlight_on_top`` :index:`: ` [boolean=false] Highlight over the component (not under). - ``highlight_padding`` :index:`: ` [number=1.5] [0,1000] How much the highlight extends around the component [mm]. - ``kicad_3d_url`` :index:`: ` [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models. - ``kicad_3d_url_suffix`` :index:`: ` [string=''] 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. - ``model_units`` :index:`: ` [string='millimeters'] [millimeters,meters,deciinches,inches] Units used for the VRML (1 deciinch = 0.1 inches). - ``pre_transform`` :index:`: ` [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. - ``ref_units`` :index:`: ` [string='millimeters'] [millimeters,inches'] Units for `ref_x` and `ref_y`. - ``ref_x`` :index:`: ` [number=0] X coordinate to use as reference when `use_pcb_center_as_ref` and `use_pcb_center_as_ref` are disabled. - ``ref_y`` :index:`: ` [number=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`` :index:`: ` [boolean=false] Use the auxiliary axis as origin for coordinates. Has more precedence than `use_pcb_center_as_ref`. - ``use_pcb_center_as_ref`` :index:`: ` [boolean=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`` :index:`: ` [string=''] Board variant to apply. - **type** :index:`: ` [string=''] Type of output. - ``category`` :index:`: ` [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:`: ` [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:`: ` [string=''] Copy the `options` section from the indicated output. Used to inherit options from another output of the same type. - ``groups`` :index:`: ` [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:`: ` [string=''] Text to use for the %I expansion content. To differentiate variations of this output. - ``priority`` :index:`: ` [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:`: ` [boolean=true] When enabled this output will be created when no specific outputs are requested.