kicad/pcbnew/pcb_painter.h

321 lines
10 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2013 CERN
* Copyright (C) 2016 KiCad Developers, see AUTHORS.txt for contributors.
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef __CLASS_PCB_PAINTER_H
#define __CLASS_PCB_PAINTER_H
#include <painter.h>
#include <pcb_display_options.h>
#include <memory>
class EDA_ITEM;
class PCB_DISPLAY_OPTIONS;
class BOARD_ITEM;
class ARC;
class BOARD;
class VIA;
class TRACK;
class D_PAD;
class DRAWSEGMENT;
class PCB_GROUP;
class MODULE;
class ZONE_CONTAINER;
class TEXTE_PCB;
class TEXTE_MODULE;
class DIMENSION;
class PCB_TARGET;
class MARKER_PCB;
class NET_SETTINGS;
class NETINFO_LIST;
namespace KIGFX
{
class GAL;
/**
* PCB_RENDER_SETTINGS
* Stores PCB specific render settings.
*/
class PCB_RENDER_SETTINGS : public RENDER_SETTINGS
{
public:
friend class PCB_PAINTER;
///> Flags to control clearance lines visibility
enum CLEARANCE_MODE
{
CL_NONE = 0x00,
// Object type
CL_PADS = 0x01,
CL_VIAS = 0x02,
CL_TRACKS = 0x04,
// Existence
CL_NEW = 0x08,
CL_EDITED = 0x10,
CL_EXISTING = 0x20
};
PCB_RENDER_SETTINGS();
/**
* Function LoadDisplayOptions
* Loads settings related to display options (high-contrast mode, full or outline modes
* for vias/pads/tracks and so on).
* @param aOptions are settings that you want to use for displaying items.
*/
void LoadDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions, bool aShowPageLimits );
virtual void LoadColors( const COLOR_SETTINGS* aSettings ) override;
/// @copydoc RENDER_SETTINGS::GetColor()
virtual COLOR4D GetColor( const VIEW_ITEM* aItem, int aLayer ) const override;
/**
* Function SetSketchMode
* Turns on/off sketch mode for given item layer.
* @param aItemLayer is the item layer that is changed.
* @param aEnabled decides if it is drawn in sketch mode (true for sketched mode,
* false for filled mode).
*/
inline void SetSketchMode( int aItemLayer, bool aEnabled )
{
m_sketchMode[aItemLayer] = aEnabled;
}
/**
* Function GetSketchMode
* Returns sketch mode setting for a given item layer.
* @param aItemLayer is the item layer that is changed.
*/
inline bool GetSketchMode( int aItemLayer ) const
{
return m_sketchMode[aItemLayer];
}
/**
* Turns on/off sketch mode for graphic items (DRAWSEGMENTs, texts).
* @param aEnabled decides if it is drawn in sketch mode (true for sketched mode,
* false for filled mode).
*/
inline void SetSketchModeGraphicItems( bool aEnabled )
{
m_sketchGraphics = aEnabled;
}
/**
* Turns on/off drawing outline and hatched lines for zones.
*/
void EnableZoneOutlines( bool aEnabled )
{
m_zoneOutlines = aEnabled;
}
inline bool IsBackgroundDark() const override
{
auto luma = m_layerColors[ LAYER_PCB_BACKGROUND ].GetBrightness();
return luma < 0.5;
}
const COLOR4D& GetBackgroundColor() override { return m_layerColors[ LAYER_PCB_BACKGROUND ]; }
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 ]; }
/** Switch the contrast mode setting (HIGH_CONTRAST_MODE:NORMAL, DIMMED or HIDDEN )
* to control how the non active layers are shown
*/
void SetContrastModeDisplay( HIGH_CONTRAST_MODE aMode ) { m_contrastModeDisplay = aMode; }
/** return the contrast mode setting (HIGH_CONTRAST_MODE:NORMAL, DIMMED or HIDDEN )
*/
HIGH_CONTRAST_MODE GetContrastModeDisplay() { return m_contrastModeDisplay; }
inline bool GetCurvedRatsnestLinesEnabled() const { return m_curvedRatsnestlines; }
inline bool GetGlobalRatsnestLinesEnabled() const { return m_globalRatsnestlines; }
bool GetDrawIndividualViaLayers() const { return m_drawIndividualViaLayers; }
void SetDrawIndividualViaLayers( bool aFlag ) { m_drawIndividualViaLayers = aFlag; }
NET_COLOR_MODE GetNetColorMode() const { return m_netColorMode; }
void SetNetColorMode( NET_COLOR_MODE aMode ) { m_netColorMode = aMode; }
std::map<wxString, KIGFX::COLOR4D>& GetNetclassColorMap() { return m_netclassColors; }
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; }
protected:
///> Flag determining if items on a given layer should be drawn as an outline or a filled item
bool m_sketchMode[GAL_LAYER_ID_END];
///> Flag determining if graphic items should be outlined or stroked
bool m_sketchGraphics;
///> Flag determining if text items should be outlined or stroked
bool m_sketchText;
///> Flag determining if pad numbers should be visible
bool m_padNumbers;
///> Flag determining if net names should be visible for pads
bool m_netNamesOnPads;
///> Flag determining if net names should be visible for tracks
bool m_netNamesOnTracks;
///> Flag determining if net names should be visible for vias
bool m_netNamesOnVias;
///> Flag determining if zones should have outlines drawn
bool m_zoneOutlines;
///> Flag determining if ratsnest lines should be drawn curved
bool m_curvedRatsnestlines = true;
///> Flag determining if ratsnest lines are shown by default
bool m_globalRatsnestlines = true;
bool m_drawIndividualViaLayers = false;
///> Maximum font size for netnames (and other dynamically shown strings)
static const double MAX_FONT_SIZE;
///> Option for different display modes for zones
ZONE_DISPLAY_MODE m_zoneDisplayMode;
///> Clearance visibility settings
int m_clearance;
///> Color used for highlighting selection candidates
COLOR4D m_selectionCandidateColor;
///> How to display nets and netclasses with color overrides
NET_COLOR_MODE m_netColorMode;
///> Overrides for specific netclass colors
std::map<wxString, KIGFX::COLOR4D> m_netclassColors;
///> Overrides for specific net colors, stored as netcodes for the ratsnest to access easily
std::map<int, KIGFX::COLOR4D> m_netColors;
///> Set of net codes that should not have their ratsnest displayed
std::set<int> m_hiddenNets;
///> How to display inactive layers (HIGH_CONTRAST_MODE:NORMAL, DIMMED or HIDDEN )
HIGH_CONTRAST_MODE m_contrastModeDisplay;
// These opacity overrides multiply with any opacity in the base layer color
double m_trackOpacity; ///< Opacity override for all tracks
double m_viaOpacity; ///< Opacity override for all types of via
double m_padOpacity; ///< Opacity override for SMD pads and PTHs
double m_zoneOpacity; ///< Opacity override for filled zones
};
/**
* PCB_PAINTER
* Contains methods for drawing PCB-specific items.
*/
class PCB_PAINTER : public PAINTER
{
public:
PCB_PAINTER( GAL* aGal );
/// @copydoc PAINTER::ApplySettings()
virtual void ApplySettings( const RENDER_SETTINGS* aSettings ) override
{
m_pcbSettings = *static_cast<const PCB_RENDER_SETTINGS*>( aSettings );
}
/// @copydoc PAINTER::GetAdapter()
virtual PCB_RENDER_SETTINGS* GetSettings() override
{
return &m_pcbSettings;
}
/// @copydoc PAINTER::Draw()
virtual bool Draw( const VIEW_ITEM* aItem, int aLayer ) override;
protected:
PCB_RENDER_SETTINGS m_pcbSettings;
// Drawing functions for various types of PCB-specific items
void draw( const TRACK* aTrack, int aLayer );
void draw( const ARC* aArc, int aLayer );
void draw( const VIA* aVia, int aLayer );
void draw( const D_PAD* aPad, int aLayer );
void draw( const DRAWSEGMENT* aSegment, int aLayer );
void draw( const TEXTE_PCB* aText, int aLayer );
void draw( const TEXTE_MODULE* aText, int aLayer );
void draw( const MODULE* aModule, int aLayer );
void draw( const PCB_GROUP* aGroup, int aLayer );
void draw( const ZONE_CONTAINER* aZone, int aLayer );
void draw( const DIMENSION* aDimension, int aLayer );
void draw( const PCB_TARGET* aTarget );
void draw( const MARKER_PCB* aMarker );
/**
* Function getLineThickness()
* Get the thickness to draw for a line (e.g. 0 thickness lines
* get a minimum value).
* @param aActualThickness line own thickness
* @return the thickness to draw
*/
int getLineThickness( int aActualThickness ) const;
/**
* Return drill shape of a pad.
*/
virtual int getDrillShape( const D_PAD* aPad ) const;
/**
* Return drill size for a pad (internal units).
*/
virtual VECTOR2D getDrillSize( const D_PAD* aPad ) const;
/**
* Return drill diameter for a via (internal units).
*/
virtual int getDrillSize( const VIA* aVia ) const;
};
} // namespace KIGFX
#endif /* __CLASS_PAINTER_H */