pcb_diff_canvas_context.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 */
 
#include <diff_merge/pcb_diff_canvas_context.h>
#include <diff_merge/pcb_differ.h>
 
#include <board.h>
#include <board_item.h>
#include <eda_item.h>
#include <footprint.h>
#include <gal/painter.h>
#include <layer_ids.h>
#include <pad.h>
#include <pcb_display_options.h>
#include <pcb_draw_panel_gal.h>
#include <pcb_track.h>
#include <view/view.h>
#include <widgets/widget_diff_canvas.h>
#include <zone.h>
 
#include <memory>
#include <set>
 
 
namespace
{
 
class PCB_DIFF_PAINTER : public KIGFX::PCB_PAINTER
{
public:
    PCB_DIFF_PAINTER( KIGFX::GAL* aGal, std::map<KIID, KIGFX::COLOR4D> aOverrides ) :
            KIGFX::PCB_PAINTER( aGal, FRAME_PCB_EDITOR ),
            m_overrides( std::move( aOverrides ) ),
            m_dimmed( std::make_shared<std::set<KIID>>() )
    {
    }

    std::shared_ptr<std::set<KIID>> DimmedSet() const { return m_dimmed; }
 
    bool Draw( const KIGFX::VIEW_ITEM* aItem, int aLayer ) override
    {
        const EDA_ITEM* edaItem = dynamic_cast<const EDA_ITEM*>( aItem );
 
        if( edaItem )
        {
            KIID key = KICAD_DIFF::PcbDiffItemId( *edaItem );
 
            if( m_overrides.count( key ) == 0 )
            {
                if( const BOARD_ITEM* boardItem = dynamic_cast<const BOARD_ITEM*>( aItem ) )
                {
                    if( const FOOTPRINT* fp = boardItem->GetParentFootprint() )
                        key = fp->m_Uuid;
                }
            }
 
            auto it = m_overrides.find( key );
 
            if( it != m_overrides.end() && m_dimmed->count( key ) == 0 )
            {
                // PCB_PAINTER tints normal items via the layer color, not via
                // LAYER_BRIGHTENED. Swap the layer color we are drawing on so
                // the override paints the changed item.
                KIGFX::PCB_RENDER_SETTINGS* settings = GetSettings();
                KIGFX::COLOR4D              saved = settings->GetLayerColor( aLayer );
                settings->SetLayerColor( aLayer, it->second );
 
                bool result = KIGFX::PCB_PAINTER::Draw( aItem, aLayer );
 
                settings->SetLayerColor( aLayer, saved );
                return result;
            }
        }
 
        return KIGFX::PCB_PAINTER::Draw( aItem, aLayer );
    }
 
private:
    std::map<KIID, KIGFX::COLOR4D>  m_overrides;
    std::shared_ptr<std::set<KIID>> m_dimmed;
};
 
} // namespace
 
 
namespace KICAD_DIFF
{
 
std::vector<KIGFX::VIEW_ITEM*> CollectFootprintDiffContextItems( FOOTPRINT& aFootprint )
{
    std::vector<KIGFX::VIEW_ITEM*> items;
 
    items.push_back( &aFootprint );
 
    for( PCB_FIELD* field : aFootprint.GetFields() )
        items.push_back( field );
 
    for( BOARD_ITEM* item : aFootprint.GraphicalItems() )
        items.push_back( item );
 
    for( PAD* pad : aFootprint.Pads() )
        items.push_back( pad );
 
    for( ZONE* zone : aFootprint.Zones() )
        items.push_back( zone );
 
    return items;
}
 
 
std::vector<KIGFX::VIEW_ITEM*> CollectBoardDiffContextItems( BOARD& aBoard )
{
    std::vector<KIGFX::VIEW_ITEM*> items;
 
    for( PCB_TRACK* track : aBoard.Tracks() )
        items.push_back( track );
 
    for( ZONE* zone : aBoard.Zones() )
        items.push_back( zone );
 
    for( BOARD_ITEM* item : aBoard.Drawings() )
        items.push_back( item );
 
    for( FOOTPRINT* fp : aBoard.Footprints() )
    {
        std::vector<KIGFX::VIEW_ITEM*> fpItems = CollectFootprintDiffContextItems( *fp );
        items.insert( items.end(), fpItems.begin(), fpItems.end() );
    }
 
    return items;
}
 
 
void ConfigurePcbDiffContextRenderSettings( KIGFX::PCB_RENDER_SETTINGS& aSettings,
                                            const KIGFX::COLOR4D& aColor )
{
    const KIGFX::COLOR4D gray( 0.45, 0.45, 0.45, 1.0 );
    const KIGFX::COLOR4D background( 0.97, 0.97, 0.97, 1.0 );
 
    for( int layer = 0; layer < LAYER_ID_COUNT; ++layer )
        aSettings.SetLayerColor( layer, gray );
 
    aSettings.SetLayerColor( LAYER_BRIGHTENED, aColor );
    aSettings.SetLayerColor( LAYER_PCB_BACKGROUND, background );
    aSettings.SetBackgroundColor( background );
 
    PCB_DISPLAY_OPTIONS displayOptions;
    displayOptions.m_ContrastModeDisplay = HIGH_CONTRAST_MODE::NORMAL;
    displayOptions.m_ZoneDisplayMode = ZONE_DISPLAY_MODE::SHOW_FILLED;
    displayOptions.m_TrackOpacity = 1.0;
    displayOptions.m_ViaOpacity = 1.0;
    displayOptions.m_PadOpacity = 1.0;
    // Zones fill translucent so footprints and traces under a copper pour
    // stay visible in the compare view.
    displayOptions.m_ZoneOpacity = 0.5;
    displayOptions.m_ImageOpacity = 1.0;
    displayOptions.m_FilledShapeOpacity = 1.0;
    aSettings.LoadDisplayOptions( displayOptions );
    aSettings.SetHighContrast( false );
    aSettings.SetHighlight( false );
}
 
 
std::unique_ptr<KIGFX::PAINTER> MakePcbDiffContextPainter( KIGFX::GAL* aGal, const KIGFX::COLOR4D& aColor,
                                                           std::map<KIID, KIGFX::COLOR4D> aOverrides )
{
    auto painter = std::make_unique<PCB_DIFF_PAINTER>( aGal, std::move( aOverrides ) );
    ConfigurePcbDiffContextRenderSettings( *painter->GetSettings(), aColor );
 
    return painter;
}
 
 
void ConfigurePcbDiffCanvasContext( WIDGET_DIFF_CANVAS& aCanvas, BOARD* aReference, BOARD* aComparison,
                                    const KIGFX::COLOR4D& aColor, const std::map<KIID, KIGFX::COLOR4D>& aOverrides,
                                    const std::vector<KIGFX::VIEW_ITEM*>&       aExtraItems,
                                    const std::map<KIID, KICAD_DIFF::CATEGORY>& aCategories )
{
    auto painter = std::make_unique<PCB_DIFF_PAINTER>( aCanvas.GetGAL(), aOverrides );
    ConfigurePcbDiffContextRenderSettings( *painter->GetSettings(), aColor );
 
    std::shared_ptr<std::set<KIID>> dimmed = painter->DimmedSet();
    aCanvas.SetContextPainter( std::move( painter ) );
    aCanvas.SetItemIdGetter( PcbDiffItemId );
 
    aCanvas.SetItemDimmer(
            [dimmed]( KIGFX::VIEW_ITEM* aItem, bool aDim )
            {
                EDA_ITEM* eda = dynamic_cast<EDA_ITEM*>( aItem );
 
                if( !eda )
                    return;
 
                if( aDim )
                    dimmed->insert( PcbDiffItemId( *eda ) );
                else
                    dimmed->erase( PcbDiffItemId( *eda ) );
            } );
 
    std::vector<KIGFX::VIEW_ITEM*> items;
 
    if( aReference )
    {
        std::vector<KIGFX::VIEW_ITEM*> refItems = CollectBoardDiffContextItems( *aReference );
        items.insert( items.end(), refItems.begin(), refItems.end() );
    }
 
    if( aComparison )
    {
        std::vector<KIGFX::VIEW_ITEM*> compItems = CollectBoardDiffContextItems( *aComparison );
        items.insert( items.end(), compItems.begin(), compItems.end() );
    }
 
    items.insert( items.end(), aExtraItems.begin(), aExtraItems.end() );
 
    aCanvas.SetContextItems( items );
 
    ApplyPcbGalLayerOrder( aCanvas.GetView() );
 
    std::map<KIGFX::VIEW_ITEM*, KICAD_DIFF::CATEGORY> itemCategories;
 
    for( KIGFX::VIEW_ITEM* viewItem : items )
    {
        EDA_ITEM* edaItem = dynamic_cast<EDA_ITEM*>( viewItem );
 
        if( !edaItem )
            continue;
 
        auto it = aCategories.find( PcbDiffItemId( *edaItem ) );
 
        if( it != aCategories.end() )
            itemCategories[viewItem] = it->second;
    }
 
    aCanvas.SetItemCategories( std::move( itemCategories ) );
}
 
} // namespace KICAD_DIFF