ratsnest_view_item.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#include <ratsnest/ratsnest_view_item.h>
 
#include <kiface_base.h>
#include <gal/graphics_abstraction_layer.h>
#include <pcbnew_settings.h>
#include <pcb_painter.h>
#include <ratsnest/ratsnest_data.h>
#include <layer_ids.h>
#include <pcb_base_frame.h>
#include <view/view.h>
#include <hash.h>
 
#include <memory>
#include <utility>
 
 
// A zero length connection is drawn as a fixed size cross
static constexpr int CROSS_SIZE = 200000;
 
// How far a curved line's control point sits off the chord, as a fraction of the span
static constexpr double CURVE_BOW = 0.1;
 
 
// A cross on an anchor near the coordinate limit overflows an int, so keep it in doubles
static void drawCross( KIGFX::GAL* aGal, const VECTOR2D& aPos )
{
    aGal->DrawLine( aPos + VECTOR2D( -CROSS_SIZE, -CROSS_SIZE ),
                    aPos + VECTOR2D( CROSS_SIZE, CROSS_SIZE ) );
    aGal->DrawLine( aPos + VECTOR2D( -CROSS_SIZE, CROSS_SIZE ),
                    aPos + VECTOR2D( CROSS_SIZE, -CROSS_SIZE ) );
}
 
 
RATSNEST_VIEW_ITEM::RATSNEST_VIEW_ITEM( std::shared_ptr<CONNECTIVITY_DATA> aData, PART aPart ) :
        EDA_ITEM( NOT_USED ),
        m_data( std::move( aData ) ),
        m_part( aPart )
{
}
 
 
VECTOR2D RATSNEST_VIEW_ITEM::CurveControlPoint( const VECTOR2D& aSource, const VECTOR2D& aTarget )
{
    // Doubles throughout because the span between two board corners overflows an int
    VECTOR2D span = aTarget - aSource;
 
    return aSource + VECTOR2D( 0.5 * span.x - CURVE_BOW * span.y,
                               0.5 * span.y + CURVE_BOW * span.x );
}
 
 
bool RATSNEST_VIEW_ITEM::LineInViewport( const VECTOR2I& aSource, const VECTOR2I& aTarget,
                                         const BOX2D& aViewport, bool aCurved )
{
    VECTOR2D source( aSource );
    VECTOR2D target( aTarget );
    BOX2D    bounds( source );
 
    if( aSource == aTarget )
    {
        bounds.Inflate( CROSS_SIZE );
    }
    else
    {
        bounds.Merge( target );
 
        // A cubic stays inside the hull of its endpoints and its control points, which are both
        // the same point here
        if( aCurved )
            bounds.Merge( CurveControlPoint( source, target ) );
    }
 
    return aViewport.Intersects( bounds );
}
 
 
const BOX2I RATSNEST_VIEW_ITEM::ViewBBox() const
{
    // Make it always visible
    BOX2I bbox;
    bbox.SetMaximum();
 
    return bbox;
}
 
 
void RATSNEST_VIEW_ITEM::ViewDraw( int aLayer, KIGFX::VIEW* aView ) const
{
    std::unique_lock<KISPINLOCK> lock( m_data->GetLock(), std::try_to_lock );
 
    // A cached copy drawn now would stay empty until the next update, see BoardInputsChanged()
    m_drawSkipped = !lock;
 
    if( !lock )
        return;
 
    PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
 
    if( !cfg )
        return;
 
    auto rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( aView->GetPainter()->GetSettings() );
    KIGFX::GAL* gal = aView->GetGAL();
    gal->SetIsStroke( true );
    gal->SetIsFill( false );
    // A pixel width the canvas resolves itself keeps the ratsnest valid across zooms
    if( gal->SupportsStrokePixelPad() )
    {
        gal->SetLineWidth( 0.0f );
        gal->SetStrokePixelPad( cfg->m_Display.m_RatsnestThickness );
    }
    else
    {
        gal->SetLineWidth( cfg->m_Display.m_RatsnestThickness / gal->GetWorldScale() );
    }
 
    std::set<int>        highlightedNets = rs->GetHighlightNetCodes();
    const std::set<int>& hiddenNets      = rs->GetHiddenNets();
 
    COLOR4D    defaultColor = rs->GetColor( nullptr, LAYER_RATSNEST );
    COLOR4D    color = defaultColor;
    const bool colorByNet = rs->GetNetColorMode() != NET_COLOR_MODE::OFF;
    const bool dimStatic = m_data->GetLocalRatsnest().size() > 0 || highlightedNets.size() > 0;
 
    std::map<int, KIGFX::COLOR4D>& netColors = rs->GetNetColorMap();
 
    const bool onlyVisibleLayers = cfg->m_Display.m_RatsnestMode == RATSNEST_MODE::VISIBLE;
    LSET       visibleLayers;
 
    // If we are in "other layers off" mode, the active layer is the only visible layer
    if( rs->m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN )
    {
        if( rs->GetPrimaryHighContrastLayer() > UNDEFINED_LAYER )
            visibleLayers.set( rs->GetPrimaryHighContrastLayer() );
    }
    else
    {
        LSET::AllCuMask().RunOnLayers(
                [&]( PCB_LAYER_ID layer )
                {
                    if( aView->IsLayerVisible( layer ) )
                        visibleLayers.set( layer );
                } );
    }
 
    auto adjustColor =
            [&]( COLOR4D& color_base, double brightnessDelta, double alpha )
            {
                if( rs->GetColor( nullptr, LAYER_PCB_BACKGROUND ).GetBrightness() < 0.5 )
                    return color_base.Brightened( brightnessDelta ).WithAlpha( std::min( alpha, 1.0 ) );
                else
                    return color_base.Darkened( brightnessDelta ).WithAlpha( std::min( alpha, 1.0 ) );
            };
 
    const bool curved_ratsnest = cfg->m_Display.m_DisplayRatsnestLinesCurved;
 
    // Adaptive tessellation filter for the curved ratsnest. The ratsnest is only a visual
    // hint, so there is no need to tessellate the Bezier to the default 10 nm precision: a
    // polyline whose deviation from the true curve stays below line_width/2 is fully hidden
    // by the line's own thickness. We use line_width/4 for a 2x safety margin. The filter is
    // in world units and scales with zoom (line width is already world-scaled above), so it
    // produces far fewer segments without any visible faceting.
    const double widthFilter = gal->GetLineWidth() / 4.0;
 
    // A pixel-padded stroke has no world width and is kept at every zoom, so the filter follows
    // the curve's own span
    auto curveFilter = [&]( const VECTOR2I& aSource, const VECTOR2I& aTarget )
    {
        if( widthFilter > 0.0 )
            return widthFilter;
 
        return ( VECTOR2D( aTarget ) - VECTOR2D( aSource ) ).EuclideanNorm() / 512.0;
    };
 
    // Lines are stroked, so one just off screen still reaches back into the viewport
    BOX2D viewport = aView->GetViewport();
    viewport.Inflate( gal->GetLineWidth() );
 
    // A cached board ratsnest is kept through pans and zooms, so it must hold every line
    const bool cull = m_part != PART::BOARD;
 
    static const std::vector<RN_DYNAMIC_LINE> noLines;
 
    // Draw the "dynamic" ratsnest (i.e. for objects that may be currently being moved)
    for( const RN_DYNAMIC_LINE& l : m_part == PART::BOARD ? noLines : m_data->GetLocalRatsnest() )
    {
        if( hiddenNets.count( l.netCode ) )
            continue;
 
        if( cull && !LineInViewport( l.a, l.b, viewport, curved_ratsnest ) )
            continue;
 
        const NETCLASS*     nc = nullptr;
        const NET_SETTINGS* netSettings = m_data->GetNetSettings();
 
        if( m_data->HasNetNameForNetCode( l.netCode ) )
        {
            const wxString& netName = m_data->GetNetNameForNetCode( l.netCode );
 
            if( netSettings && netSettings->HasEffectiveNetClass( netName ) )
                nc = netSettings->GetCachedEffectiveNetClass( netName ).get();
        }
 
        if( colorByNet && netColors.count( l.netCode ) )
            color = netColors.at( l.netCode );
        else if( colorByNet && nc && nc->HasPcbColor() )
            color = nc->GetPcbColor();
        else
            color = defaultColor;
 
        if( color == COLOR4D::UNSPECIFIED )
            color = defaultColor;
 
        gal->SetStrokeColor( adjustColor( color, 0.5, color.a + 0.3 ) );
 
        if( l.a == l.b )
        {
            drawCross( gal, l.a );
        }
        else
        {
            if( curved_ratsnest )
            {
                const VECTOR2D center = CurveControlPoint( l.a, l.b );
                gal->DrawCurve( l.a, center, center, l.b, curveFilter( l.a, l.b ) );
            }
            else
            {
                gal->DrawLine( l.a, l.b );
            }
        }
    }
 
    const int netCount = m_part == PART::LOCAL ? 0 : m_data->GetNetCount();
 
    for( int i = 1 /* skip "No Net" at [0] */; i < netCount; ++i )
    {
        if( hiddenNets.count( i ) )
            continue;
 
        RN_NET* net = m_data->GetRatsnestForNet( i );
 
        if( !net || m_data->GetConnectivityAlgo()->IsNetDirty( i ) )
            continue;
 
        const NETCLASS*     nc = nullptr;
        const NET_SETTINGS* netSettings = m_data->GetNetSettings();
 
        if( m_data->HasNetNameForNetCode( i ) )
        {
            const wxString& netName = m_data->GetNetNameForNetCode( i );
 
            if( netSettings && netSettings->HasEffectiveNetClass( netName ) )
                nc = netSettings->GetCachedEffectiveNetClass( netName ).get();
        }
 
        if( colorByNet && netColors.count( i ) )
            color = netColors.at( i );
        else if( colorByNet && nc && nc->HasPcbColor() )
            color = nc->GetPcbColor();
        else
            color = defaultColor;
 
        if( color == COLOR4D::UNSPECIFIED )
            color = defaultColor;
 
        if( dimStatic )
            color = adjustColor( color, 0.0, color.a / 2 );
 
        // Draw the "static" ratsnest
        if( highlightedNets.count( i ) )
            gal->SetStrokeColor( adjustColor( color, 0.8, color.a + 0.4 ) );
        else
            gal->SetStrokeColor( color );  // using the default ratsnest color for not highlighted
 
        // Every line of a net is stroked in one colour on one layer, so their order is not
        // observable and the sort in GetEdges() would be paid on every frame
        for( const CN_EDGE& edge : net->GetUnsortedEdges() )
        {
            if( !edge.IsVisible() )
                continue;
 
            const std::shared_ptr<const CN_ANCHOR>& sourceNode = edge.GetSourceNode();
            const std::shared_ptr<const CN_ANCHOR>& targetNode = edge.GetTargetNode();
 
            if( !sourceNode || sourceNode->Dirty() || !targetNode || targetNode->Dirty() )
                continue;
 
            const VECTOR2I source( sourceNode->Pos() );
            const VECTOR2I target( targetNode->Pos() );
 
            if( cull && !LineInViewport( source, target, viewport, curved_ratsnest ) )
                continue;
 
            bool enable =  !sourceNode->GetNoLine() && !targetNode->GetNoLine();
            bool show;
 
            // If the global ratsnest is currently enabled, the local ratsnest should be easy to
            // turn off, so either element can disable it.
            // If the global ratsnest is disabled, the local ratsnest should be easy to turn on
            // so either element can enable it.
            if( cfg->m_Display.m_ShowGlobalRatsnest )
            {
                show = sourceNode->Parent()->GetLocalRatsnestVisible() &&
                       targetNode->Parent()->GetLocalRatsnestVisible();
            }
            else
            {
                show = sourceNode->Parent()->GetLocalRatsnestVisible() ||
                       targetNode->Parent()->GetLocalRatsnestVisible();
            }
 
            if( onlyVisibleLayers && show )
            {
                LSET sourceLayers = sourceNode->Parent()->GetLayerSet();
                LSET targetLayers = targetNode->Parent()->GetLayerSet();
 
                if( !( sourceLayers & visibleLayers ).any() ||
                    !( targetLayers & visibleLayers ).any() )
                {
                    show = false;
                }
            }
 
            if ( enable && show )
            {
                if ( source == target )
                {
                    drawCross( gal, source );
                }
                else
                {
                    if( curved_ratsnest )
                    {
                        const VECTOR2D center = CurveControlPoint( source, target );
                        gal->DrawCurve( source, center, center, target, curveFilter( source, target ) );
                    }
                    else
                    {
                        gal->DrawLine( source, target );
                    }
                }
            }
        }
    }
    gal->SetStrokePixelPad( 0.0 );
}
 
 
std::vector<int> RATSNEST_VIEW_ITEM::ViewGetLayers() const
{
    return { m_part == PART::LOCAL ? LOCAL_LAYER : LAYER_RATSNEST };
}
 
 
bool RATSNEST_VIEW_ITEM::BoardInputsChanged( KIGFX::VIEW* aView )
{
    PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
 
    if( !cfg )
        return false;
 
    auto   rs = static_cast<KIGFX::PCB_RENDER_SETTINGS*>( aView->GetPainter()->GetSettings() );
    size_t seed = 0;
 
    hash_combine( seed, !m_data->GetLocalRatsnest().empty(), static_cast<int>( rs->GetNetColorMode() ),
                  static_cast<int>( rs->m_ContrastModeDisplay ), static_cast<int>( rs->GetPrimaryHighContrastLayer() ),
                  cfg->m_Display.m_RatsnestThickness, cfg->m_Display.m_DisplayRatsnestLinesCurved,
                  static_cast<int>( cfg->m_Display.m_RatsnestMode ), cfg->m_Display.m_ShowGlobalRatsnest );
 
    for( int net : rs->GetHighlightNetCodes() )
        hash_combine( seed, net );
 
    // Keeps a highlighted net distinct from a hidden one with the same code
    hash_combine( seed, -1 );
 
    for( int net : rs->GetHiddenNets() )
        hash_combine( seed, net );
 
    LSET::AllCuMask().RunOnLayers(
            [&]( PCB_LAYER_ID aLayer )
            {
                hash_combine( seed, aView->IsLayerVisible( aLayer ) );
            } );
 
    const bool skipped = std::exchange( m_drawSkipped, false );
 
    return std::exchange( m_boardInputs, seed ) != seed || skipped;
}