338 lines
15 KiB
Python
338 lines
15 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2021-2023 Salvador E. Tropea
|
|
# Copyright (c) 2021-2023 Instituto Nacional de Tecnología Industrial
|
|
# License: GPL-3.0
|
|
# Project: KiBot (formerly KiPlot)
|
|
# KiCad 6/6.0.1 bug: https://gitlab.com/kicad/code/kicad/-/issues/9890
|
|
"""
|
|
Dependencies:
|
|
- from: KiAuto
|
|
role: mandatory
|
|
version: 2.0.4
|
|
- from: ImageMagick
|
|
role: Automatically crop images
|
|
"""
|
|
import os
|
|
from .misc import (RENDER_3D_ERR, PCB_MAT_COLORS, PCB_FINISH_COLORS, SOLDER_COLORS, SILK_COLORS,
|
|
KICAD_VERSION_6_0_2, MISSING_TOOL)
|
|
from .gs import GS
|
|
from .out_base_3d import Base3DOptionsWithHL, Base3D
|
|
from .kiplot import run_command
|
|
from .macros import macros, document, output_class # noqa: F401
|
|
from . import log
|
|
|
|
logger = log.get_logger()
|
|
|
|
|
|
def _run_command(cmd):
|
|
run_command(cmd, err_lvl=RENDER_3D_ERR)
|
|
|
|
|
|
class Render3DOptions(Base3DOptionsWithHL):
|
|
_colors = {'background1': 'bg_color_1',
|
|
'background2': 'bg_color_2',
|
|
'copper': 'copper_color',
|
|
'board': 'board_color',
|
|
'silk': 'silk_color',
|
|
'solder_mask': 'sm_color',
|
|
'solder_paste': 'sp_color'}
|
|
_views = {'top': 'z', 'bottom': 'Z', 'front': 'y', 'rear': 'Y', 'right': 'x', 'left': 'X'}
|
|
_rviews = {v: k for k, v in _views.items()}
|
|
|
|
def __init__(self):
|
|
with document:
|
|
self.output = GS.def_global_output
|
|
""" *Name for the generated image file (%i='3D_$VIEW' %x='png') """
|
|
self.no_tht = False
|
|
""" Used to exclude 3D models for through hole components """
|
|
self.no_smd = False
|
|
""" Used to exclude 3D models for surface mount components """
|
|
self.background1 = "#66667F"
|
|
""" First color for the background gradient """
|
|
self.background2 = "#CCCCE5"
|
|
""" Second color for the background gradient """
|
|
self.board = "#332B16"
|
|
""" Color for the board without copper or solder mask """
|
|
self.copper = "#8b898c"
|
|
""" Color for the copper """
|
|
self.silk = "#d5dce4"
|
|
""" Color for the silk screen """
|
|
self.solder_mask = "#208b47"
|
|
""" Color for the solder mask """
|
|
self.solder_paste = "#808080"
|
|
""" Color for the solder paste """
|
|
self.move_x = 0
|
|
""" *Steps to move in the X axis, positive is to the right.
|
|
Just like pressing the right arrow in the 3D viewer """
|
|
self.move_y = 0
|
|
""" *Steps to move in the Y axis, positive is up.
|
|
Just like pressing the up arrow in the 3D viewer """
|
|
self.rotate_x = 0
|
|
""" *Steps to rotate around the X axis, positive is clockwise.
|
|
Each step is currently 10 degrees. Only for KiCad 6 or newer """
|
|
self.rotate_y = 0
|
|
""" *Steps to rotate around the Y axis, positive is clockwise.
|
|
Each step is currently 10 degrees. Only for KiCad 6 or newer """
|
|
self.rotate_z = 0
|
|
""" *Steps to rotate around the Z axis, positive is clockwise.
|
|
Each step is currently 10 degrees. Only for KiCad 6 or newer """
|
|
self.ray_tracing = False
|
|
""" *Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt` """
|
|
self.wait_render = -600
|
|
""" How many seconds we must wait before capturing the render (ray tracing or normal).
|
|
Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered.
|
|
Use negative values to enable the auto-detect using CPU load.
|
|
In this case the value is interpreted as a time-out. """
|
|
self.wait_ray_tracing = None
|
|
""" {wait_render} """
|
|
self.view = 'top'
|
|
""" *[top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view """
|
|
self.zoom = 0
|
|
""" *Zoom steps. Use positive to enlarge, get closer, and negative to reduce.
|
|
Same result as using the mouse wheel in the 3D viewer.
|
|
Note that KiCad 8 starts with a zoom to fit, so you might not even need it """
|
|
self.width = 1280
|
|
""" Image width (aprox.) """
|
|
self.height = 720
|
|
""" Image height (aprox.) """
|
|
self.orthographic = False
|
|
""" Enable the orthographic projection mode (top view looks flat) """
|
|
self.show_silkscreen = True
|
|
""" Show the silkscreen layers (KiCad 6+) """
|
|
self.show_soldermask = True
|
|
""" Show the solder mask layers (KiCad 6+) """
|
|
self.show_solderpaste = True
|
|
""" Show the solder paste layers (KiCad 6+) """
|
|
self.show_zones = True
|
|
""" Show filled areas in zones (KiCad 6+) """
|
|
self.clip_silk_on_via_annulus = True
|
|
""" Clip silkscreen at via annuli (KiCad 6+) """
|
|
self.subtract_mask_from_silk = True
|
|
""" Clip silkscreen at solder mask edges (KiCad 6+) """
|
|
self.auto_crop = False
|
|
""" When enabled the image will be post-processed to remove the empty space around the image.
|
|
In this mode the `background2` is changed to be the same as `background1` """
|
|
self.transparent_background = False
|
|
""" When enabled the image will be post-processed to make the background transparent.
|
|
In this mode the `background1` and `background2` colors are ignored """
|
|
self.transparent_background_color = "#00ff00"
|
|
""" Color used for the chroma key. Adjust it if some regions of the board becomes transparent """
|
|
self.transparent_background_fuzz = 15
|
|
""" [0,100] Chroma key tolerance (percent). Bigger values will remove more pixels """
|
|
self.realistic = True
|
|
""" When disabled we use the colors of the layers used by the GUI. KiCad 6 or newer """
|
|
self.show_board_body = True
|
|
""" Show the PCB core material. KiCad 6 or newer """
|
|
self.show_comments = False
|
|
""" Show the content of the User.Comments layer. KiCad 6 or newer and ray tracing disabled """
|
|
self.show_eco = False
|
|
""" Show the content of the Eco1.User/Eco2.User layers. KiCad 6 or newer and ray tracing disabled """
|
|
self.show_adhesive = False
|
|
""" Show the content of F.Adhesive/B.Adhesive layers. KiCad 6 or newer """
|
|
super().__init__()
|
|
self._expand_ext = 'png'
|
|
|
|
def config(self, parent):
|
|
# Apply global defaults
|
|
if GS.global_pcb_material is not None:
|
|
material = GS.global_pcb_material.lower()
|
|
for mat, color in PCB_MAT_COLORS.items():
|
|
if mat in material:
|
|
self.board = "#"+color
|
|
break
|
|
# Pre parse the view option
|
|
bottom = False
|
|
if 'view' in self._tree:
|
|
v = self._tree['view']
|
|
bottom = isinstance(v, str) and v == 'bottom'
|
|
# Solder mask
|
|
if bottom:
|
|
name = GS.global_solder_mask_color_bottom or GS.global_solder_mask_color
|
|
else:
|
|
name = GS.global_solder_mask_color_top or GS.global_solder_mask_color
|
|
if name and name.lower() in SOLDER_COLORS:
|
|
(_, self.solder_mask) = SOLDER_COLORS[name.lower()]
|
|
# Add the default opacity (80%)
|
|
self.solder_mask += "D4"
|
|
# Silk screen
|
|
if bottom:
|
|
name = GS.global_silk_screen_color_bottom or GS.global_silk_screen_color
|
|
else:
|
|
name = GS.global_silk_screen_color_top or GS.global_silk_screen_color
|
|
if name and name.lower() in SILK_COLORS:
|
|
self.silk = "#"+SILK_COLORS[name.lower()]
|
|
# PCB finish
|
|
if GS.global_pcb_finish is not None:
|
|
name = GS.global_pcb_finish.lower()
|
|
for nm, color in PCB_FINISH_COLORS.items():
|
|
if nm in name:
|
|
self.copper = "#"+color
|
|
break
|
|
# Now we can configure (defaults applied)
|
|
super().config(parent)
|
|
self.validate_colors(list(self._colors.keys())+['transparent_background_color'])
|
|
# View and also add it to the ID
|
|
view = self._views.get(self.view, None)
|
|
if view is not None:
|
|
self.view = view
|
|
self._expand_id += '_'+self._rviews.get(self.view)
|
|
|
|
def setup_renderer(self, components, active_components, bottom, name):
|
|
super().setup_renderer(components, active_components)
|
|
self.view = 'Z' if bottom else 'z'
|
|
self.output = name
|
|
return self.expand_filename_both(name, is_sch=False)
|
|
|
|
def save_renderer_options(self):
|
|
""" Save the current renderer settings """
|
|
super().save_renderer_options()
|
|
self.old_show_all_components = self._show_all_components
|
|
self.old_view = self.view
|
|
self.old_output = self.output
|
|
|
|
def restore_renderer_options(self):
|
|
""" Restore the renderer settings """
|
|
super().restore_renderer_options()
|
|
self._show_all_components = self.old_show_all_components
|
|
self.view = self.old_view
|
|
self.output = self.old_output
|
|
|
|
def add_step(self, cmd, steps, ops):
|
|
if steps:
|
|
cmd.extend([ops, str(steps)])
|
|
|
|
def add_options(self, cmd):
|
|
# Add user options
|
|
if not self.no_virtual:
|
|
cmd.append('--virtual')
|
|
if self.no_tht:
|
|
cmd.append('--no_tht')
|
|
if self.no_smd:
|
|
cmd.append('--no_smd')
|
|
for color, option in self._colors.items():
|
|
cmd.extend(['--'+option, getattr(self, color)])
|
|
self.add_step(cmd, self.move_x, '--move_x')
|
|
self.add_step(cmd, self.move_y, '--move_y')
|
|
self.add_step(cmd, self.rotate_x, '--rotate_x')
|
|
self.add_step(cmd, self.rotate_y, '--rotate_y')
|
|
self.add_step(cmd, self.rotate_z, '--rotate_z')
|
|
if self.zoom:
|
|
cmd.extend(['--zoom', str(self.zoom)])
|
|
if self.wait_render != 5:
|
|
if self.wait_render < 0:
|
|
self.wait_render = -self.wait_render
|
|
cmd.append('--detect_rt')
|
|
cmd.extend(['--wait_rt', str(self.wait_render), '--use_rt_wait'])
|
|
if self.ray_tracing:
|
|
cmd.append('--ray_tracing')
|
|
if self.orthographic:
|
|
cmd.append('--orthographic')
|
|
if self.view != 'z':
|
|
cmd.extend(['--view', self.view])
|
|
if not self.show_silkscreen:
|
|
cmd.append('--hide_silkscreen')
|
|
if not self.show_soldermask:
|
|
cmd.append('--hide_soldermask')
|
|
if not self.show_solderpaste:
|
|
cmd.append('--hide_solderpaste')
|
|
if not self.show_zones:
|
|
cmd.append('--hide_zones')
|
|
if not self.clip_silk_on_via_annulus:
|
|
cmd.append('--dont_clip_silk_on_via_annulus')
|
|
if not self.subtract_mask_from_silk:
|
|
cmd.append('--dont_substrack_mask_from_silk')
|
|
if not self.realistic:
|
|
cmd.append('--use_layer_colors')
|
|
if not self.show_board_body:
|
|
cmd.append('--hide_board_body')
|
|
if self.show_comments:
|
|
cmd.append('--show_comments')
|
|
if self.show_eco:
|
|
cmd.append('--show_eco')
|
|
if self.show_adhesive:
|
|
cmd.append('--show_adhesive')
|
|
|
|
def run(self, output):
|
|
super().run(output)
|
|
if GS.ki6 and GS.kicad_version_n < KICAD_VERSION_6_0_2:
|
|
GS.exit_with_error("3D Viewer not supported for KiCad 6.0.0/1\n"
|
|
"Please upgrade KiCad to 6.0.2 or newer", MISSING_TOOL)
|
|
command = self.ensure_tool('KiAuto')
|
|
if self.transparent_background:
|
|
# Use the chroma key color
|
|
self.background1 = self.background2 = self.transparent_background_color
|
|
convert_command = self.ensure_tool('ImageMagick')
|
|
elif self.auto_crop:
|
|
# Avoid a gradient
|
|
self.background2 = self.background1
|
|
convert_command = self.ensure_tool('ImageMagick')
|
|
# Base command with overwrite
|
|
cmd = [command, '--rec_w', str(self.width+2), '--rec_h', str(self.height+85),
|
|
'3d_view', '--output_name', output]
|
|
self.add_options(cmd)
|
|
# The board
|
|
self.apply_show_components()
|
|
board_name = self.filter_components(highlight=set(self.expand_kf_components(self.highlight)))
|
|
self.undo_show_components()
|
|
cmd.extend([board_name, os.path.dirname(output)])
|
|
# Execute it
|
|
self.exec_with_retry(self.add_extra_options(cmd), RENDER_3D_ERR)
|
|
if self.auto_crop:
|
|
_run_command([convert_command, output, '-trim', '+repage', '-trim', '+repage', output])
|
|
if self.transparent_background:
|
|
_run_command([convert_command, output, '-fuzz', str(self.transparent_background_fuzz)+'%', '-transparent',
|
|
self.color_str_to_rgb(self.transparent_background_color), output])
|
|
|
|
|
|
@output_class
|
|
class Render_3D(Base3D): # noqa: F821
|
|
""" 3D render of the PCB
|
|
Exports the image generated by KiCad's 3D viewer. """
|
|
def __init__(self):
|
|
super().__init__()
|
|
with document:
|
|
self.options = Render3DOptions
|
|
""" *[dict] Options for the `render_3d` output """
|
|
self._category = 'PCB/3D'
|
|
|
|
def get_renderer_options(self):
|
|
""" Where are the options for this output when used as a 'renderer' """
|
|
return self.options
|
|
|
|
@staticmethod
|
|
def get_conf_examples(name, layers):
|
|
outs = []
|
|
has_top = False
|
|
has_bottom = False
|
|
for la in layers:
|
|
if la.is_top() or la.layer.startswith('F.'):
|
|
has_top = True
|
|
elif la.is_bottom() or la.layer.startswith('B.'):
|
|
has_bottom = True
|
|
if has_top:
|
|
gb = {}
|
|
gb['name'] = 'basic_{}_top'.format(name)
|
|
gb['comment'] = '3D view from top'
|
|
gb['type'] = name
|
|
gb['dir'] = '3D'
|
|
gb['options'] = {'ray_tracing': True, 'orthographic': True}
|
|
outs.append(gb)
|
|
if GS.ki6:
|
|
gb = {}
|
|
gb['name'] = 'basic_{}_30deg'.format(name)
|
|
gb['comment'] = '3D view from 30 degrees'
|
|
gb['type'] = name
|
|
gb['dir'] = '3D'
|
|
gb['output_id'] = '30deg'
|
|
gb['options'] = {'ray_tracing': True, 'rotate_x': 3, 'rotate_z': -2}
|
|
outs.append(gb)
|
|
if has_bottom:
|
|
gb = {}
|
|
gb['name'] = 'basic_{}_bottom'.format(name)
|
|
gb['comment'] = '3D view from bottom'
|
|
gb['type'] = name
|
|
gb['dir'] = '3D'
|
|
gb['options'] = {'ray_tracing': True, 'orthographic': True, 'view': 'bottom'}
|
|
outs.append(gb)
|
|
return outs
|