KiCad PCB EDA Suite
sch_bitmap.cpp
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) 2011 jean-pierre.charras
5  * Copyright (C) 2011-2021 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 
29 #include <sch_draw_panel.h>
30 #include <plotters/plotter.h>
32 #include <bitmaps.h>
33 #include <base_units.h>
34 #include <common.h>
35 #include <eda_draw_frame.h>
36 #include <core/mirror.h>
37 #include <sch_bitmap.h>
38 #include <trigo.h>
39 
40 #include <wx/mstream.h>
41 
42 
43 SCH_BITMAP::SCH_BITMAP( const wxPoint& pos ) :
44  SCH_ITEM( nullptr, SCH_BITMAP_T )
45 {
46  m_pos = pos;
47  m_layer = LAYER_NOTES; // used only to draw/plot a rectangle,
48  // when a bitmap cannot be drawn or plotted
49  m_image = new BITMAP_BASE();
50 }
51 
52 
53 SCH_BITMAP::SCH_BITMAP( const SCH_BITMAP& aSchBitmap ) :
54  SCH_ITEM( aSchBitmap )
55 {
56  m_pos = aSchBitmap.m_pos;
57  m_layer = aSchBitmap.m_layer;
58  m_image = new BITMAP_BASE( *aSchBitmap.m_image );
59 }
60 
61 
63 {
64  wxCHECK_MSG( Type() == aItem.Type(), *this,
65  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
66  GetClass() );
67 
68  if( &aItem != this )
69  {
70  SCH_ITEM::operator=( aItem );
71 
72  SCH_BITMAP* bitmap = (SCH_BITMAP*) &aItem;
73 
74  delete m_image;
75  m_image = new BITMAP_BASE( *bitmap->m_image );
76  m_pos = bitmap->m_pos;
77  }
78 
79  return *this;
80 }
81 
82 
83 bool SCH_BITMAP::ReadImageFile( const wxString& aFullFilename )
84 {
85  return m_image->ReadImageFile( aFullFilename );
86 }
87 
88 
90 {
91  return new SCH_BITMAP( *this );
92 }
93 
94 
96 {
97  wxCHECK_RET( aItem->Type() == SCH_BITMAP_T,
98  wxString::Format( wxT( "SCH_BITMAP object cannot swap data with %s object." ),
99  aItem->GetClass() ) );
100 
101  SCH_BITMAP* item = (SCH_BITMAP*) aItem;
102  std::swap( m_pos, item->m_pos );
103  std::swap( m_image, item->m_image );
104 }
105 
106 
108 {
109  EDA_RECT rect = m_image->GetBoundingBox();
110 
111  rect.Move( m_pos );
112 
113  return rect;
114 }
115 
116 
117 void SCH_BITMAP::Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset )
118 {
119  wxPoint pos = m_pos + aOffset;
120 
121  m_image->DrawBitmap( aSettings->GetPrintDC(), pos );
122 }
123 
124 
125 wxSize SCH_BITMAP::GetSize() const
126 {
127  return m_image->GetSize();
128 }
129 
130 
131 void SCH_BITMAP::MirrorVertically( int aCenter )
132 {
133  MIRROR( m_pos.y, aCenter );
134  m_image->Mirror( true );
135 }
136 
137 
139 {
140  MIRROR( m_pos.x, aCenter );
141  m_image->Mirror( false );
142 }
143 
144 
145 void SCH_BITMAP::Rotate( const wxPoint& aCenter )
146 {
147  RotatePoint( &m_pos, aCenter, 900 );
148  m_image->Rotate( false );
149 }
150 
151 
152 #if defined(DEBUG)
153 void SCH_BITMAP::Show( int nestLevel, std::ostream& os ) const
154 {
155  // XML output:
156  wxString s = GetClass();
157 
158  NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << m_pos << "/>\n";
159 }
160 #endif
161 
162 
163 bool SCH_BITMAP::HitTest( const wxPoint& aPosition, int aAccuracy ) const
164 {
165  EDA_RECT rect = GetBoundingBox();
166 
167  rect.Inflate( aAccuracy );
168 
169  return rect.Contains( aPosition );
170 }
171 
172 
173 bool SCH_BITMAP::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
174 {
175  EDA_RECT rect = aRect;
176 
177  rect.Inflate( aAccuracy );
178 
179  if( aContained )
180  return rect.Contains( GetBoundingBox() );
181 
182  return rect.Intersects( GetBoundingBox() );
183 }
184 
185 
186 void SCH_BITMAP::Plot( PLOTTER* aPlotter ) const
187 {
188  m_image->PlotImage( aPlotter, m_pos, aPlotter->RenderSettings()->GetLayerColor( GetLayer() ),
189  aPlotter->RenderSettings()->GetDefaultPenWidth() );
190 }
191 
192 
194 {
195  return BITMAPS::image;
196 }
197 
198 
199 void SCH_BITMAP::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
200 {
201  aList.emplace_back( _( "Bitmap" ), wxEmptyString );
202 
203  aList.emplace_back( _( "Width" ), MessageTextFromValue( aFrame->GetUserUnits(), GetSize().x ) );
204  aList.emplace_back( _( "Height" ), MessageTextFromValue( aFrame->GetUserUnits(), GetSize().y ) );
205 }
206 
207 
208 void SCH_BITMAP::ViewGetLayers( int aLayers[], int& aCount ) const
209 {
210  aCount = 2;
211  aLayers[0] = LAYER_DRAW_BITMAPS;
212  aLayers[1] = LAYER_SELECTION_SHADOWS;
213 }
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: sch_bitmap.cpp:199
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
Plot settings, and plotting engines (PostScript, Gerber, HPGL and DXF)
void Move(const wxPoint &aMoveVector)
Move the rectangle by the aMoveVector.
Definition: eda_rect.cpp:51
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
Implementation of conversion functions that require both schematic and board internal units.
void Rotate(const wxPoint &aCenter) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition: sch_bitmap.cpp:145
void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
Definition: sch_bitmap.cpp:117
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
wxPoint m_pos
Definition: sch_bitmap.h:151
void PlotImage(PLOTTER *aPlotter, const wxPoint &aPos, const KIGFX::COLOR4D &aDefaultColor, int aDefaultPensize) const
Plot bitmap on plotter.
void Plot(PLOTTER *aPlotter) const override
Plot the schematic item to aPlotter.
Definition: sch_bitmap.cpp:186
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition: sch_bitmap.cpp:131
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
The base class for create windows for drawing purpose.
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_bitmap.cpp:107
void Mirror(bool aVertically)
Mirror image vertically (i.e.
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
const EDA_RECT GetBoundingBox() const
Return the orthogonal, bounding box of this object for display purposes.
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
This class handle bitmap images in KiCad.
Definition: bitmap_base.h:51
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Test if aPosition is contained within or on the bounding box of an item.
Definition: sch_bitmap.cpp:163
wxSize GetSize() const
Definition: sch_bitmap.cpp:125
SCH_LAYER_ID m_layer
Definition: sch_item.h:481
wxSize GetSize() const
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_bitmap.cpp:95
#define _(s)
wxDC * GetPrintDC() const
to handle and draw images bitmaps
Definition: layer_ids.h:219
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: sch_bitmap.cpp:193
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:180
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:40
SCH_BITMAP & operator=(const SCH_ITEM &aItem)
Definition: sch_bitmap.cpp:62
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:257
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
Base plotter engine class.
Definition: plotter.h:121
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:156
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
Handle the component boundary box.
Definition: eda_rect.h:42
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: sch_bitmap.cpp:89
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
The common library.
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:191
void DrawBitmap(wxDC *aDC, const wxPoint &aPos)
int GetDefaultPenWidth() const
SCH_BITMAP(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_bitmap.cpp:43
bool ReadImageFile(const wxString &aFullFilename)
Reads and stores in memory an image file.
Definition: bitmap_base.cpp:95
bool ReadImageFile(const wxString &aFullFilename)
Read and store an image file.
Definition: sch_bitmap.cpp:83
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_bitmap.cpp:138
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Definition: sch_bitmap.cpp:208
void Rotate(bool aRotateCCW)
Rotate image CW or CCW.
BITMAP_BASE * m_image
Definition: sch_bitmap.h:152
wxString GetClass() const override
Return the class name.
Definition: sch_bitmap.h:81
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:364
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113