Commit c94603f1 authored by Maciej Suminski's avatar Maciej Suminski

Added some comments and missing parameter names for pcb_painter.h.

parent 53e04ce7
...@@ -68,6 +68,7 @@ public: ...@@ -68,6 +68,7 @@ public:
CL_TRACKS = 0x4 CL_TRACKS = 0x4
}; };
///> Determines how zones should be displayed
enum DisplayZonesMode { enum DisplayZonesMode {
DZ_HIDE_FILLED = 0, DZ_HIDE_FILLED = 0,
DZ_SHOW_FILLED, DZ_SHOW_FILLED,
...@@ -90,27 +91,44 @@ public: ...@@ -90,27 +91,44 @@ public:
/// @copydoc RENDER_SETTINGS::GetColor() /// @copydoc RENDER_SETTINGS::GetColor()
virtual const COLOR4D& GetColor( const VIEW_ITEM* aItem, int aLayer ) const; virtual const COLOR4D& GetColor( const VIEW_ITEM* aItem, int aLayer ) const;
/**
* Function GetLayerColor
* Returns the color used to draw a layer.
* @param aLayer is the layer number.
*/
const COLOR4D& GetLayerColor( int aLayer ) const; const COLOR4D& GetLayerColor( int aLayer ) const;
protected: protected:
/// @copydoc RENDER_SETTINGS::Update() ///> @copydoc RENDER_SETTINGS::Update()
void update(); void update();
/// Colors for all layers (including special, highlighted & darkened versions) ///> Colors for all layers (normal)
COLOR4D m_layerColors [TOTAL_LAYER_COUNT]; COLOR4D m_layerColors [TOTAL_LAYER_COUNT];
///> Colors for all layers (highlighted)
COLOR4D m_layerColorsHi [TOTAL_LAYER_COUNT]; COLOR4D m_layerColorsHi [TOTAL_LAYER_COUNT];
///> Colors for all layers (selected)
COLOR4D m_layerColorsSel [TOTAL_LAYER_COUNT]; COLOR4D m_layerColorsSel [TOTAL_LAYER_COUNT];
///> Colors for all layers (darkened)
COLOR4D m_layerColorsDark[TOTAL_LAYER_COUNT]; COLOR4D m_layerColorsDark[TOTAL_LAYER_COUNT];
bool m_sketchModeSelect[TOTAL_LAYER_COUNT]; bool m_sketchModeSelect[TOTAL_LAYER_COUNT];
///> Flag determining if pad numbers should be visible
bool m_padNumbers; bool m_padNumbers;
///> Flag determining if net names should be visible for pads
bool m_netNamesOnPads; bool m_netNamesOnPads;
///> Flag determining if net names should be visible for tracks
bool m_netNamesOnTracks; bool m_netNamesOnTracks;
/// Maximum font size for netnames (and other dynamically shown strings) ///> Maximum font size for netnames (and other dynamically shown strings)
static const double MAX_FONT_SIZE; static const double MAX_FONT_SIZE;
/// Option for different display modes for zones ///> Option for different display modes for zones
DisplayZonesMode m_displayZoneMode; DisplayZonesMode m_displayZoneMode;
}; };
...@@ -122,7 +140,6 @@ protected: ...@@ -122,7 +140,6 @@ protected:
class PCB_PAINTER : public PAINTER class PCB_PAINTER : public PAINTER
{ {
public: public:
PCB_PAINTER( GAL* aGal ); PCB_PAINTER( GAL* aGal );
/// @copydoc PAINTER::Draw() /// @copydoc PAINTER::Draw()
...@@ -142,16 +159,17 @@ protected: ...@@ -142,16 +159,17 @@ protected:
PCB_RENDER_SETTINGS* m_pcbSettings; PCB_RENDER_SETTINGS* m_pcbSettings;
// Drawing functions for various types of PCB-specific items // Drawing functions for various types of PCB-specific items
void draw( const TRACK*, int ); void draw( const TRACK* aTrack, int aLayer );
void draw( const SEGVIA*, int ); void draw( const SEGVIA* aVia, int aLayer );
void draw( const D_PAD*, int ); void draw( const D_PAD* aPad, int aLayer );
void draw( const DRAWSEGMENT* ); void draw( const DRAWSEGMENT* aSegment );
void draw( const TEXTE_PCB*, int ); void draw( const TEXTE_PCB* aText, int aLayer );
void draw( const TEXTE_MODULE*, int ); void draw( const TEXTE_MODULE* aText, int aLayer );
void draw( const ZONE_CONTAINER* ); void draw( const ZONE_CONTAINER* aZone );
void draw( const DIMENSION*, int ); void draw( const DIMENSION* aDimension, int aLayer );
void draw( const PCB_TARGET* ); void draw( const PCB_TARGET* aTarget );
}; };
} // namespace KIGFX } // namespace KIGFX
#endif /* __CLASS_PAINTER_H */ #endif /* __CLASS_PAINTER_H */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment