kicad/eeschema/sch_bitmap.h

159 lines
4.6 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
2021-03-25 14:07:16 +00:00
* Copyright (C) 2011-2021 KiCad Developers, see AUTHORS.txt for contributors.
*
* 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
*/
/**
* @file sch_bitmap.h
*/
#ifndef _SCH_BITMAP_H_
#define _SCH_BITMAP_H_
2019-05-10 19:57:24 +00:00
#include <sch_item.h>
2018-01-29 08:39:13 +00:00
#include <bitmap_base.h>
/**
* Object to handle a bitmap image that can be inserted in a schematic.
*/
class SCH_BITMAP : public SCH_ITEM
{
public:
SCH_BITMAP( const VECTOR2I& pos = VECTOR2I( 0, 0 ) );
SCH_BITMAP( const SCH_BITMAP& aSchBitmap );
~SCH_BITMAP()
{
delete m_image;
}
2020-04-14 12:25:00 +00:00
SCH_BITMAP& operator=( const SCH_ITEM& aItem );
2020-12-20 18:44:13 +00:00
BITMAP_BASE* GetImage() const
{
2021-07-16 20:13:26 +00:00
wxCHECK_MSG( m_image != nullptr, nullptr, "Invalid SCH_BITMAP init, m_image is NULL." );
return m_image;
}
void SetImage( wxImage* aImage );
/**
2021-03-25 14:07:16 +00:00
* @return the image "zoom" value.
* scale = 1.0 = original size of bitmap.
* scale < 1.0 = the bitmap is drawn smaller than its original size.
* scale > 1.0 = the bitmap is drawn bigger than its original size.
*/
double GetImageScale() const
{
return m_image->GetScale();
}
void SetImageScale( double aScale )
2018-09-08 11:12:41 +00:00
{
m_image->SetScale( aScale );
2018-09-08 11:12:41 +00:00
}
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && SCH_BITMAP_T == aItem->Type();
}
2016-09-25 17:06:49 +00:00
wxString GetClass() const override
{
return wxT( "SCH_BITMAP" );
}
/**
2021-03-25 14:07:16 +00:00
* @return the actual size (in user units, not in pixels) of the image.
*/
2022-08-31 09:15:42 +00:00
VECTOR2I GetSize() const;
2022-08-31 09:15:42 +00:00
const BOX2I GetBoundingBox() const override;
2016-09-24 18:53:15 +00:00
void SwapData( SCH_ITEM* aItem ) override;
void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override;
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/**
2021-03-25 14:07:16 +00:00
* Read and store an image file.
*
2021-03-25 14:07:16 +00:00
* Initialize the bitmap used to draw this item format.
*
* @param aFullFilename is the full filename of the image file to read.
* @return true if success reading else false.
*/
bool ReadImageFile( const wxString& aFullFilename );
void Move( const VECTOR2I& aMoveVector ) override
{
m_pos += aMoveVector;
}
/**
2021-03-25 14:07:16 +00:00
* Return true for items which are moved with the anchor point at mouse cursor and false
* for items moved with no reference to anchor.
*
* @return false for a bus entry.
*/
2020-12-20 18:44:13 +00:00
bool IsMovableFromAnchorPoint() const override { return false; }
void MirrorHorizontally( int aCenter ) override;
void MirrorVertically( int aCenter ) override;
void Rotate( const VECTOR2I& aCenter ) override;
wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override
{
return wxString( _( "Image" ) );
}
BITMAPS GetMenuImage() const override;
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
VECTOR2I GetPosition() const override { return m_pos; }
void SetPosition( const VECTOR2I& aPosition ) override { m_pos = aPosition; }
bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
2022-08-31 09:33:46 +00:00
bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
void Plot( PLOTTER* aPlotter, bool aBackground ) const override;
2016-09-24 18:53:15 +00:00
EDA_ITEM* Clone() const override;
#if defined(DEBUG)
2016-09-25 17:06:49 +00:00
void Show( int nestLevel, std::ostream& os ) const override;
#endif
2021-03-25 14:07:16 +00:00
private:
VECTOR2I m_pos; // XY coordinates of center of the bitmap
2021-03-25 14:07:16 +00:00
BITMAP_BASE* m_image; // the BITMAP_BASE item
};
#endif // _SCH_BITMAP_H_