KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
28#include "sch_bitmap.h"
29
30#include <bitmap_base.h>
31#include <bitmaps.h>
32#include <base_units.h>
33#include <common.h>
34#include <core/mirror.h>
35#include <eda_draw_frame.h>
37#include <plotters/plotter.h>
38#include <sch_draw_panel.h>
40#include <trigo.h>
41
42#include <wx/mstream.h>
43
44
46 SCH_ITEM( nullptr, SCH_BITMAP_T ),
48{
49 m_referenceImage.SetPosition( pos );
50 m_layer = LAYER_NOTES; // used only to draw/plot a rectangle,
51 // when a bitmap cannot be drawn or plotted
52}
53
54
55SCH_BITMAP::SCH_BITMAP( const SCH_BITMAP& aSchBitmap ) :
56 SCH_ITEM( aSchBitmap ),
58{
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 const SCH_BITMAP& bitmap = static_cast<const SCH_BITMAP&>( aItem );
74 }
75
76 return *this;
77}
78
79
81{
82 return new SCH_BITMAP( *this );
83}
84
85
87{
88 wxCHECK_RET( aItem->Type() == SCH_BITMAP_T,
89 wxString::Format( wxT( "SCH_BITMAP object cannot swap data with %s object." ),
90 aItem->GetClass() ) );
91
92 SCH_BITMAP* item = (SCH_BITMAP*) aItem;
93 m_referenceImage.SwapData( item->m_referenceImage );
94}
95
96
98{
99 return m_referenceImage.GetBoundingBox();
100}
101
102
104{
105 return m_referenceImage.GetPosition();
106}
107
108
109void SCH_BITMAP::SetPosition( const VECTOR2I& aPosition )
110{
111 m_referenceImage.SetPosition( aPosition );
112}
113
114
115void SCH_BITMAP::Move( const VECTOR2I& aMoveVector )
116{
117 SetPosition( GetPosition() + aMoveVector );
118}
119
120
122{
124}
125
126
128{
130}
131
132
133void SCH_BITMAP::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
134{
135 m_referenceImage.Rotate( aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
136}
137
138
139#if defined(DEBUG)
140void SCH_BITMAP::Show( int nestLevel, std::ostream& os ) const
141{
142 // XML output:
143 wxString s = GetClass();
144
145 NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << GetPosition() << "/>\n";
146}
147#endif
148
149
150bool SCH_BITMAP::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
151{
152 return KIGEOM::BoxHitTest( aPosition, GetBoundingBox(), aAccuracy );
153}
154
155
156bool SCH_BITMAP::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
157{
158 return KIGEOM::BoxHitTest( aRect, GetBoundingBox(), aContained, aAccuracy );
159}
160
161
162bool SCH_BITMAP::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
163{
164 return KIGEOM::BoxHitTest( aPoly, GetBoundingBox(), aContained );
165}
166
167
168
169void SCH_BITMAP::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
170 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed )
171{
172 if( aBackground )
173 {
174 RENDER_SETTINGS* cfg = aPlotter->RenderSettings();
175
176 m_referenceImage.GetImage().PlotImage( aPlotter, GetPosition(),
177 cfg->GetLayerColor( GetLayer() ),
178 cfg->GetDefaultPenWidth() );
179 }
180}
181
182
184{
185 return BITMAPS::image;
186}
187
188
189void SCH_BITMAP::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
190{
191 aList.emplace_back( _( "Bitmap" ), wxEmptyString );
192
193 aList.emplace_back( _( "PPI" ),
194 wxString::Format( wxT( "%d " ), m_referenceImage.GetImage().GetPPI() ) );
195 aList.emplace_back( _( "Scale" ),
196 wxString::Format( wxT( "%f " ), m_referenceImage.GetImageScale() ) );
197
198 aList.emplace_back( _( "Width" ),
199 aFrame->MessageTextFromValue( m_referenceImage.GetSize().x ) );
200 aList.emplace_back( _( "Height" ),
201 aFrame->MessageTextFromValue( m_referenceImage.GetSize().y ) );
202}
203
204
205std::vector<int> SCH_BITMAP::ViewGetLayers() const
206{
208}
209
210
211bool SCH_BITMAP::operator==( const SCH_ITEM& aItem ) const
212{
213 if( Type() != aItem.Type() )
214 return false;
215
216 const SCH_BITMAP& bitmap = static_cast<const SCH_BITMAP&>( aItem );
217 return m_referenceImage == bitmap.m_referenceImage;
218}
219
220
221double SCH_BITMAP::Similarity( const SCH_ITEM& aItem ) const
222{
223 if( Type() != aItem.Type() )
224 return 0.0;
225
226 if( m_Uuid == aItem.m_Uuid )
227 return 1.0;
228
229 const SCH_BITMAP& bitmap = static_cast<const SCH_BITMAP&>( aItem );
230 return m_referenceImage.Similarity( bitmap.m_referenceImage );
231}
232
233
235{
236 return m_referenceImage.GetTransformOriginOffset().x;
237}
238
239
241{
242 VECTOR2I offset = m_referenceImage.GetTransformOriginOffset();
243 offset.x = aX;
244 m_referenceImage.SetTransformOriginOffset( offset );
245}
246
247
249{
250 return m_referenceImage.GetTransformOriginOffset().y;
251}
252
253
255{
256 VECTOR2I offset = m_referenceImage.GetTransformOriginOffset();
257 offset.y = aY;
258 m_referenceImage.SetTransformOriginOffset( offset );
259}
260
261
263{
264 return m_referenceImage.GetImageScale();
265}
266
267
268void SCH_BITMAP::SetImageScale( double aScale )
269{
270 m_referenceImage.SetImageScale( aScale );
271}
272
273
275{
276 return m_referenceImage.GetImage().GetSize().x;
277}
278
279
280void SCH_BITMAP::SetWidth( int aWidth )
281{
282 m_referenceImage.SetWidth( aWidth );
283}
284
285
287{
288 return m_referenceImage.GetImage().GetSize().y;
289}
290
291
292void SCH_BITMAP::SetHeight( int aHeight )
293{
294 m_referenceImage.SetHeight( aHeight );
295}
296
297
298static struct SCH_BITMAP_DESC
299{
301 {
305
306 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Position X" ),
309
310
311 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Position Y" ),
314
315 const wxString groupImage = _HKI( "Image Properties" );
316
317 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, double>( _HKI( "Scale" ),
319 groupImage );
320
321 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Transform Offset X" ),
325 groupImage );
326
327 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Transform Offset Y" ),
331 groupImage );
332
333 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Width" ),
336 groupImage );
337
338 propMgr.AddProperty( new PROPERTY<SCH_BITMAP, int>( _HKI( "Height" ),
341 groupImage );
342 }
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BITMAPS
A list of all bitmap identifiers.
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
The base class for create windows for drawing purpose.
const KIID m_Uuid
Definition eda_item.h:516
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
Base plotter engine class.
Definition plotter.h:121
RENDER_SETTINGS * RenderSettings()
Definition plotter.h:152
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
Object to handle a bitmap image that can be inserted in a schematic.
Definition sch_bitmap.h:40
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
double GetImageScale() const
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
SCH_BITMAP(const VECTOR2I &pos=VECTOR2I(0, 0))
void SetWidth(int aWidth)
VECTOR2I GetPosition() const override
int GetTransformOriginOffsetY() const
void SetHeight(int aHeight)
virtual std::vector< int > ViewGetLayers() const override
int GetWidth() const
int GetY() const
Definition sch_bitmap.h:57
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
Plot the item to aPlotter.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
wxString GetClass() const override
Return the class name.
Definition sch_bitmap.h:65
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
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.
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
int GetHeight() const
void SetY(int aY)
Definition sch_bitmap.h:58
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
int GetX() const
Definition sch_bitmap.h:54
void SetTransformOriginOffsetX(int aX)
void SetPosition(const VECTOR2I &aPosition) override
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
SCH_BITMAP & operator=(const SCH_ITEM &aItem)
void SetX(int aX)
Definition sch_bitmap.h:55
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
bool operator==(const SCH_ITEM &aOther) const override
REFERENCE_IMAGE m_referenceImage
Definition sch_bitmap.h:137
int GetTransformOriginOffsetX() const
void SetTransformOriginOffsetY(int aY)
void SetImageScale(double aScale)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
SCH_ITEM & operator=(const SCH_ITEM &aPin)
Definition sch_item.cpp:75
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition sch_item.h:309
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:51
wxString GetClass() const override
Return the class name.
Definition sch_item.h:177
SCH_LAYER_ID m_layer
Definition sch_item.h:739
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
The common library.
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
static constexpr EDA_ANGLE ANGLE_270
Definition eda_angle.h:416
a few functions useful in geometry calculations.
@ LAYER_DRAW_BITMAPS
Draw images.
Definition layer_ids.h:283
@ LAYER_NOTES
Definition layer_ids.h:466
@ LAYER_SELECTION_SHADOWS
Definition layer_ids.h:493
@ LEFT_RIGHT
Flip left to right (around the Y axis)
Definition mirror.h:28
@ TOP_BOTTOM
Flip top to bottom (around the X axis)
Definition mirror.h:29
bool BoxHitTest(const VECTOR2I &aHitPoint, const BOX2I &aHittee, int aAccuracy)
Perform a point-to-box hit test.
#define _HKI(x)
Definition page_info.cpp:44
#define TYPE_HASH(x)
Definition property.h:73
@ PT_COORD
Coordinate expressed in distance units (mm/inch)
Definition property.h:64
#define REGISTER_TYPE(x)
static struct SCH_BITMAP_DESC _SCH_BITMAP_DESC
@ SCH_BITMAP_T
Definition typeinfo.h:166
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695