KiCad PCB EDA Suite
bitmap_base.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 jean-pierre.charras jp.charras at wanadoo.fr
5 * Copyright (C) 2013-2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef BITMAP_BASE_H
26#define BITMAP_BASE_H
27
28#include <wx/bitmap.h>
29#include <wx/image.h>
30#include <math/box2.h>
31
32namespace KIGFX
33{
34class COLOR4D;
35}
36
37class LINE_READER;
38class PLOTTER;
39
40
51{
52public:
53 BITMAP_BASE( const VECTOR2I& pos = VECTOR2I( 0, 0 ) );
54
55 BITMAP_BASE( const BITMAP_BASE& aSchBitmap );
56
58 {
59 delete m_bitmap;
60 delete m_image;
61 }
62
63 /*
64 * Accessors:
65 */
66 double GetPixelSizeIu() const { return m_pixelSizeIu; }
67 void SetPixelSizeIu( double aPixSize ) { m_pixelSizeIu = aPixSize; }
68
69 wxImage* GetImageData() { return m_image; }
70 const wxImage* GetImageData() const { return m_image; }
71
72 void SetImage( wxImage* aImage )
73 {
74 delete m_image;
75 m_image = aImage;
76 }
77
78 double GetScale() const { return m_scale; }
79 void SetScale( double aScale ) { m_scale = aScale; }
80
81 /*
82 * Rebuild the internal bitmap used to draw/plot image.
83 *
84 * This must be called after a #m_image change.
85 */
86 void RebuildBitmap() { *m_bitmap = wxBitmap( *m_image ); }
87
88 void SetBitmap( wxBitmap* aBitMap )
89 {
90 delete m_bitmap;
91 m_bitmap = aBitMap;
92 }
93
97 void ImportData( BITMAP_BASE* aItem );
98
110 double GetScalingFactor() const
111 {
112 return m_pixelSizeIu * m_scale;
113 }
114
118 VECTOR2I GetSize() const;
119
123 wxSize GetSizePixels() const
124 {
125 if( m_image )
126 return wxSize( m_image->GetWidth(), m_image->GetHeight() );
127 else
128 return wxSize( 0, 0 );
129 }
130
134 int GetPPI() const
135 {
136 return m_ppi;
137 }
138
146 const BOX2I GetBoundingBox() const;
147
148 void DrawBitmap( wxDC* aDC, const VECTOR2I& aPos );
149
160 bool ReadImageFile( const wxString& aFullFilename );
161
173 bool ReadImageFile( wxInputStream& aInStream );
174
184 bool SaveData( FILE* aFile ) const;
185
194 void SaveData( wxArrayString& aPngStrings ) const;
195
206 bool LoadData( LINE_READER& aLine, wxString& aErrorMsg );
207
213 void Mirror( bool aVertically );
214
220 void Rotate( bool aRotateCCW );
221
232 void PlotImage( PLOTTER* aPlotter, const VECTOR2I& aPos,
233 const KIGFX::COLOR4D& aDefaultColor, int aDefaultPensize ) const;
234
235private:
236 double m_scale; // The scaling factor of the bitmap
237 // With m_pixelSizeIu, controls the actual draw size
238 wxImage* m_image; // the raw image data (png format)
239 wxBitmap* m_bitmap; // the bitmap used to draw/plot image
240 double m_pixelSizeIu; // The scaling factor of the bitmap
241 // to convert the bitmap size (in pixels)
242 // to internal KiCad units
243 // Usually does not change
244 int m_ppi; // the bitmap definition. the default is 300PPI
245};
246
247
248#endif // BITMAP_BASE_H
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
void SetBitmap(wxBitmap *aBitMap)
Definition: bitmap_base.h:88
void Rotate(bool aRotateCCW)
Rotate image CW or CCW.
double GetScalingFactor() const
This scaling factor depends on m_pixelSizeIu and m_scale.
Definition: bitmap_base.h:110
wxSize GetSizePixels() const
Definition: bitmap_base.h:123
bool SaveData(FILE *aFile) const
Write the bitmap data to aFile.
void PlotImage(PLOTTER *aPlotter, const VECTOR2I &aPos, const KIGFX::COLOR4D &aDefaultColor, int aDefaultPensize) const
Plot bitmap on plotter.
void RebuildBitmap()
Definition: bitmap_base.h:86
const BOX2I GetBoundingBox() const
Return the orthogonal, bounding box of this object for display purposes.
double GetPixelSizeIu() const
Definition: bitmap_base.h:66
double GetScale() const
Definition: bitmap_base.h:78
void Mirror(bool aVertically)
Mirror image vertically (i.e.
void SetPixelSizeIu(double aPixSize)
Definition: bitmap_base.h:67
wxBitmap * m_bitmap
Definition: bitmap_base.h:239
void ImportData(BITMAP_BASE *aItem)
Copy aItem image to this object and update m_bitmap.
Definition: bitmap_base.cpp:63
void DrawBitmap(wxDC *aDC, const VECTOR2I &aPos)
void SetImage(wxImage *aImage)
Definition: bitmap_base.h:72
const wxImage * GetImageData() const
Definition: bitmap_base.h:70
bool ReadImageFile(const wxString &aFullFilename)
Reads and stores in memory an image file.
Definition: bitmap_base.cpp:88
wxImage * m_image
Definition: bitmap_base.h:238
double m_scale
Definition: bitmap_base.h:236
double m_pixelSizeIu
Definition: bitmap_base.h:240
int GetPPI() const
Definition: bitmap_base.h:134
bool LoadData(LINE_READER &aLine, wxString &aErrorMsg)
Load an image data saved by SaveData.
wxImage * GetImageData()
Definition: bitmap_base.h:69
BITMAP_BASE(const VECTOR2I &pos=VECTOR2I(0, 0))
Definition: bitmap_base.cpp:35
VECTOR2I GetSize() const
void SetScale(double aScale)
Definition: bitmap_base.h:79
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:81
Base plotter engine class.
Definition: plotter.h:110
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:266
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618