pcb_painter.h

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 Tomasz Wlostowski <[email protected]>
 * @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/>.
 */
 
#ifndef PCB_PAINTER_H
#define PCB_PAINTER_H
 
#include <frame_type.h>
#include <gal/definitions.h>
#include <gal/painter.h>
#include <kiid.h>
#include <padstack.h>   // PAD_DRILL_SHAPE
#include <pcb_display_options.h>
#include <math/vector2d.h>
#include <bitset>
#include <memory>
#include <set>
#include <unordered_set>
#include <geometry/shape_segment.h>
 
 
class EDA_ITEM;
class PCB_DISPLAY_OPTIONS;
class PCBNEW_SETTINGS;
class PCB_VIEWERS_SETTINGS_BASE;
class BOARD_ITEM;
class PCB_ARC;
class BOARD;
class PCB_VIA;
class PCB_TRACK;
class PAD;
class PCB_SHAPE;
class PCB_GROUP;
class FOOTPRINT;
class ZONE;
class PCB_REFERENCE_IMAGE;
class PCB_TEXT;
class PCB_FIELD;
class PCB_TEXTBOX;
class PCB_DRILL_CHART;
class PCB_DRILL_MAP;
class PCB_TABLE;
class PCB_DIMENSION_BASE;
class PCB_BARCODE;
class PCB_TARGET;
class PCB_POINT;
class PCB_MARKER;
class NET_SETTINGS;
class NETINFO_LIST;
class TEXT_ATTRIBUTES;
class PCB_BOARD_OUTLINE;
class PCB_GRID_ITEM;
struct DRILL_SYMBOL_ENTRY;

PCBNEW_SETTINGS* pcbconfig();
 
 
namespace KIFONT
{
class FONT;
class METRICS;
}
 
namespace KIGFX
{
class GAL;

class PCB_RENDER_SETTINGS : public RENDER_SETTINGS
{
public:
    friend class PCB_PAINTER;
 
    PCB_RENDER_SETTINGS();

    void LoadDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions );
 
    void LoadColors( const COLOR_SETTINGS* aSettings ) override;

    COLOR4D GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;

    COLOR4D GetColor( const BOARD_ITEM* aItem, int aLayer ) const;

    COLOR4D GetColor( std::nullptr_t, int aLayer ) const
    {
        return GetColor( static_cast<const BOARD_ITEM*>( nullptr ), aLayer );
    }

    void SetCanvasFadedLayers( const std::bitset<MAX_LAYERS_FOR_VIEW>& aLayers ) { m_canvasFadedLayers = aLayers; }
 
    bool IsCanvasFadedLayer( int aLayer ) const;
 
    bool HasCanvasFadedLayers() const { return m_canvasFadedLayers.any(); }

    bool GetLayerDim( int aLayer, COLOR4D& aToward, double& aKeep ) const override;

    bool IsDimExempt( const VIEW_ITEM* aItem ) const override;
 
    bool GetShowPageLimits() const override;
 
    inline bool IsBackgroundDark() const override
    {
        auto it = m_layerColors.find( LAYER_PCB_BACKGROUND );
 
        if( it == m_layerColors.end() )
            return false;
 
        return it->second.GetBrightness() < 0.5;
    }
 
    const COLOR4D& GetBackgroundColor() const override
    {
        auto it = m_layerColors.find( LAYER_PCB_BACKGROUND );
        return it == m_layerColors.end() ? COLOR4D::BLACK : it->second;
    }
 
    void SetBackgroundColor( const COLOR4D& aColor ) override
    {
        m_layerColors[ LAYER_PCB_BACKGROUND ] = aColor;
    }
 
    const COLOR4D& GetGridColor() override { return m_layerColors[ LAYER_GRID ]; }
 
    const COLOR4D& GetCursorColor() override { return m_layerColors[ LAYER_CURSOR ]; }
 
    NET_COLOR_MODE GetNetColorMode() const { return m_netColorMode; }
    void SetNetColorMode( NET_COLOR_MODE aMode ) { m_netColorMode = aMode; }
 
    std::map<int, KIGFX::COLOR4D>& GetNetColorMap() { return m_netColors; }
 
    std::set<int>& GetHiddenNets() { return m_hiddenNets; }
    const std::set<int>& GetHiddenNets() const { return m_hiddenNets; }
 
    // Net chain highlight support (grouped nets).  Empty when no chain highlight active.
    const wxString& GetHighlightedNetChain() const { return m_highlightedNetChain; }
    void SetHighlightedNetChain( const wxString& aNetChain ) { m_highlightedNetChain = aNetChain; }
 
    // Items referenced by geometric constraint shadow layer draws only for these
    // refreshed each board-wide diagnosis
    const std::unordered_set<KIID>& GetConstrainedItems() const { return m_constrainedItems; }
    void SetConstrainedItems( std::unordered_set<KIID> aItems ) { m_constrainedItems = std::move( aItems ); }
 
    // Members of badge-selected constraint shadows drawn brighter and thicker
    const std::unordered_set<KIID>& GetHighlightedConstraintMembers() const
    {
        return m_highlightedConstraintMembers;
    }
 
    void SetHighlightedConstraintMembers( std::unordered_set<KIID> aItems )
    {
        m_highlightedConstraintMembers = std::move( aItems );
    }
 
public:
    bool               m_ForcePadSketchModeOn;
    bool               m_ForceShowFieldsWhenFPSelected;
 
    ZONE_DISPLAY_MODE  m_ZoneDisplayMode;
    HIGH_CONTRAST_MODE m_ContrastModeDisplay;
 
    PAD*               m_PadEditModePad;       // Pad currently in Pad Edit Mode (if any)
 
protected:
    static const double MAX_FONT_SIZE;

    NET_COLOR_MODE     m_netColorMode;

    std::map<wxString, KIGFX::COLOR4D> m_netclassColors;

    std::map<int, KIGFX::COLOR4D> m_netColors;

    std::set<int> m_hiddenNets;
 
    // These opacity overrides multiply with any opacity in the base layer color
    double m_trackOpacity;           
    double m_viaOpacity;             
    double m_padOpacity;             
    double m_zoneOpacity;            
    double m_imageOpacity;           
    double m_filledShapeOpacity;     
 
    wxString m_highlightedNetChain;  

    std::unordered_set<KIID> m_constrainedItems;

    std::unordered_set<KIID> m_highlightedConstraintMembers;

    std::bitset<MAX_LAYERS_FOR_VIEW> m_canvasFadedLayers;
};
 

class PCB_PAINTER : public PAINTER
{
public:
    PCB_PAINTER( GAL* aGal, FRAME_T aFrameType );
 
    virtual PCB_RENDER_SETTINGS* GetSettings() override
    {
        return &m_pcbSettings;
    }
 
    virtual bool Draw( const VIEW_ITEM* aItem, int aLayer ) override;
 
    virtual bool HasUniformColor( const VIEW_ITEM* aItem, int aLayer ) const override;
 
protected:
    PCB_VIEWERS_SETTINGS_BASE* viewer_settings();

    bool zoneOutlineOnly( const ZONE* aZone ) const;
 
    // Drawing functions for various types of PCB-specific items
    void draw( const PCB_TRACK* aTrack, int aLayer );
    void draw( const PCB_ARC* aArc, int aLayer );
    void draw( const PCB_VIA* aVia, int aLayer );
    void draw( const PAD* aPad, int aLayer );
 
    void drawDrillSymbol( const BOARD_ITEM* aItem, int aLayer );

    void drawDrillMarks( const PCB_DRILL_MAP* aMap, const std::vector<DRILL_SYMBOL_ENTRY>& aEntries,
                         const COLOR4D& aColor, const KIFONT::METRICS& aFontMetrics );
 
    void draw( const PCB_DRILL_MAP* aMap, int aLayer );
 
    void drawChartSymbols( const PCB_DRILL_CHART* aChart, int aLayer );
    void draw( const PCB_SHAPE* aSegment, int aLayer );
    void draw( const PCB_REFERENCE_IMAGE* aBitmap, int aLayer );
    void draw( const PCB_FIELD* aField, int aLayer );
    void draw( const PCB_TEXT* aText, int aLayer );
    void draw( const PCB_TEXTBOX* aText, int aLayer );
    void draw( const PCB_TABLE* aTable, int aLayer );
    void draw( const FOOTPRINT* aFootprint, int aLayer );
    void draw( const PCB_GROUP* aGroup, int aLayer );
    void draw( const ZONE* aZone, int aLayer );
    void draw( const PCB_BARCODE* aBarcode, int aLayer );
    void draw( const PCB_DIMENSION_BASE* aDimension, int aLayer );
    void draw( const PCB_POINT* aPoint, int aLayer );
    void draw( const PCB_TARGET* aTarget );
    void draw( const PCB_MARKER* aMarker, int aLayer );
    void draw( const PCB_BOARD_OUTLINE* aBoardOutline, int aLayer );
    void draw( const PCB_GRID_ITEM* aGridItem, int aLayer );

    int getLineThickness( int aActualThickness ) const;

    virtual PAD_DRILL_SHAPE getDrillShape( const PAD* aPad ) const;

    virtual SHAPE_SEGMENT getPadHoleShape( const PAD* aPad ) const;

    virtual int getViaDrillSize( const PCB_VIA* aVia ) const;
 
    void strokeText( const wxString& aText, const VECTOR2I& aPosition,
                     const TEXT_ATTRIBUTES& aAttrs, const KIFONT::METRICS& aFontMetrics );
 
    void renderNetNameForSegment( const SHAPE_SEGMENT& aSeg, const COLOR4D& aColor, const wxString& aNetName ) const;

    void drawBackdrillIndicator( const BOARD_ITEM* aItem, const VECTOR2D& aCenter,
                                 int aDrillSize, PCB_LAYER_ID aStartLayer,
                                 PCB_LAYER_ID aEndLayer );

    void drawPostMachiningIndicator( const BOARD_ITEM* aItem, const VECTOR2D& aCenter, PCB_LAYER_ID aLayer );
 
protected:
    PCB_RENDER_SETTINGS m_pcbSettings;
    FRAME_T             m_frameType;
 
    int                 m_maxError;
    int                 m_holePlatingThickness;
    int                 m_lockedShadowMargin;
};
 

bool ZoneOutlineDrawnOnLayer( bool aOutlineOnly, int aLayer );
 
} // namespace KIGFX
 
#endif /* PCB_PAINTER_H */