235 lines
7.5 KiB
C++
235 lines
7.5 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018 jean-pierre.charras jp.charras at wanadoo.fr
|
|
* Copyright (C) 2013-2018 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
|
|
*/
|
|
|
|
#ifndef BITMAP_BASE_H
|
|
#define BITMAP_BASE_H
|
|
|
|
#include <eda_rect.h>
|
|
|
|
/**
|
|
* @file bitmap_base.h
|
|
*
|
|
*/
|
|
|
|
class PLOTTER;
|
|
|
|
/**
|
|
* This class handle bitmap images in KiCad.
|
|
* It is not intended to be used alone, but inside another class,
|
|
* so all methods are protected ( or private )
|
|
* It is used in SCH_BITMAP class and WS_DRAW_ITEM_BITMAP (and other in future)
|
|
*
|
|
* Remember not all plotters are able to plot a bitmap
|
|
* Mainly GERBER plotters cannot.
|
|
*/
|
|
class BITMAP_BASE
|
|
{
|
|
private:
|
|
double m_scale; // The scaling factor of the bitmap
|
|
// With m_pixelScaleFactor, controls the actual draw size
|
|
wxImage* m_image; // the raw image data (png format)
|
|
wxBitmap* m_bitmap; // the bitmap used to draw/plot image
|
|
double m_pixelScaleFactor; // The scaling factor of the bitmap
|
|
// to convert the bitmap size (in pixels)
|
|
// to internal KiCad units
|
|
// Usually does not change
|
|
int m_ppi; // the bitmap definition. the default is 300PPI
|
|
|
|
|
|
public:
|
|
BITMAP_BASE( const wxPoint& pos = wxPoint( 0, 0 ) );
|
|
|
|
BITMAP_BASE( const BITMAP_BASE& aSchBitmap );
|
|
|
|
~BITMAP_BASE()
|
|
{
|
|
delete m_bitmap;
|
|
delete m_image;
|
|
}
|
|
|
|
|
|
/*
|
|
* Accessors:
|
|
*/
|
|
double GetPixelScaleFactor() const { return m_pixelScaleFactor; }
|
|
void SetPixelScaleFactor( double aSF ) { m_pixelScaleFactor = aSF; }
|
|
|
|
wxImage* GetImageData() { return m_image; }
|
|
const wxImage* GetImageData() const { return m_image; }
|
|
|
|
void SetImage( wxImage* aImage )
|
|
{
|
|
delete m_image;
|
|
m_image = aImage;
|
|
}
|
|
|
|
double GetScale() const { return m_scale; }
|
|
void SetScale( double aScale ) { m_scale = aScale; }
|
|
|
|
/*
|
|
* Function RebuildBitmap
|
|
* Rebuild the internal bitmap used to draw/plot image
|
|
* must be called after a m_image change
|
|
*/
|
|
void RebuildBitmap() { *m_bitmap = wxBitmap( *m_image ); }
|
|
|
|
void SetBitmap( wxBitmap* aBitMap )
|
|
{
|
|
delete m_bitmap;
|
|
m_bitmap = aBitMap;
|
|
}
|
|
|
|
/**
|
|
* Function ImportData
|
|
* Copy aItem image to me and update m_bitmap
|
|
*/
|
|
void ImportData( BITMAP_BASE* aItem );
|
|
|
|
/**
|
|
* Function GetScalingFactor
|
|
* @return the scaling factor from pixel size to actual draw size
|
|
* this scaling factor depend on m_pixelScaleFactor and m_scale
|
|
* m_pixelScaleFactor gives the scaling factor between a pixel size and
|
|
* the internal schematic units
|
|
* m_scale is an user dependant value, and gives the "zoom" value
|
|
* m_scale = 1.0 = original size of bitmap.
|
|
* m_scale < 1.0 = the bitmap is drawn smaller than its original size.
|
|
* m_scale > 1.0 = the bitmap is drawn bigger than its original size.
|
|
*/
|
|
double GetScalingFactor() const
|
|
{
|
|
return m_pixelScaleFactor * m_scale;
|
|
}
|
|
|
|
|
|
/**
|
|
* Function GetSize
|
|
* @return the actual size (in user units, not in pixels) of the image
|
|
*/
|
|
wxSize GetSize() const;
|
|
|
|
/**
|
|
* Function GetSizePixels
|
|
* @return the size in pixels of the image
|
|
*/
|
|
wxSize GetSizePixels() const
|
|
{
|
|
if( m_image )
|
|
return wxSize( m_image->GetWidth(), m_image->GetHeight() );
|
|
else
|
|
return wxSize( 0, 0 );
|
|
}
|
|
|
|
/**
|
|
* @return the bitmap definition in ppi
|
|
* the default is 300 ppi
|
|
*/
|
|
int GetPPI() const
|
|
{
|
|
return m_ppi;
|
|
}
|
|
|
|
/**
|
|
* Function GetBoundingBox
|
|
* returns the orthogonal, bounding box of this object for display
|
|
* purposes. This box should be an enclosing perimeter for visible
|
|
* components of this object, and the units should be in the pcb or
|
|
* schematic coordinate system. It is OK to overestimate the size
|
|
* by a few counts.
|
|
*/
|
|
const EDA_RECT GetBoundingBox() const;
|
|
|
|
void DrawBitmap( wxDC* aDC, const wxPoint& aPos );
|
|
|
|
/**
|
|
* Function ReadImageFile
|
|
* Reads and stores in memory an image file.
|
|
* Init the bitmap format used to draw this item.
|
|
* supported images formats are format supported by wxImage
|
|
* if all handlers are loaded
|
|
* by default, .png, .jpeg are alway loaded
|
|
* @param aFullFilename The full filename of the image file to read.
|
|
* @return bool - true if success reading else false.
|
|
*/
|
|
bool ReadImageFile( const wxString& aFullFilename );
|
|
|
|
/**
|
|
* writes the bitmap data to aFile
|
|
* The format is png, in Hexadecimal form:
|
|
* If the hexadecimal data is converted to binary it gives exactly a .png image data
|
|
* @param aFile The FILE to write to.
|
|
* @return bool - true if success writing else false.
|
|
*/
|
|
bool SaveData( FILE* aFile ) const;
|
|
|
|
/**
|
|
* writes the bitmap data to an array string
|
|
* The format is png, in Hexadecimal form:
|
|
* If the hexadecimal data is converted to binary it gives exactly a .png image data
|
|
* @param aPngStrings The wxArrayString to write to.
|
|
*/
|
|
void SaveData( wxArrayString& aPngStrings ) const;
|
|
|
|
/**
|
|
* Load an image data saved by SaveData (png, in Hexadecimal form)
|
|
* @param aLine - the LINE_READER used to read the data file.
|
|
* @param aErrorMsg - Description of the error if an error occurs while loading the
|
|
* png bimap data.
|
|
* @return true if the bitmap loaded successfully.
|
|
*/
|
|
bool LoadData( LINE_READER& aLine, wxString& aErrorMsg );
|
|
|
|
|
|
/**
|
|
* Function Mirror
|
|
* Mirror image vertically (i.e. relative to its horizontal X axis )
|
|
* or horizontally (i.e relative to its vertical Y axis)
|
|
* @param aVertically = false to mirror horizontally
|
|
* or true to mirror vertically
|
|
*/
|
|
void Mirror( bool aVertically );
|
|
|
|
/**
|
|
* Function Rotate
|
|
* Rotate image CW or CCW.
|
|
* @param aRotateCCW = true to rotate CCW
|
|
*/
|
|
void Rotate( bool aRotateCCW );
|
|
|
|
/**
|
|
* Function PlotImage
|
|
* Plot bitmap on plotter.
|
|
* If the plotter does not support bitmaps, plot a
|
|
* @param aPlotter = the plotter to use
|
|
* @param aPos = the position od the center of the bitmap
|
|
* @param aDefaultColor = the color used to plot the rectangle when bitmap is not supported
|
|
* @param aDefaultPensize = the pen size used to plot the rectangle when bitmap is not supported
|
|
*/
|
|
void PlotImage( PLOTTER* aPlotter, const wxPoint& aPos,
|
|
COLOR4D aDefaultColor, int aDefaultPensize );
|
|
};
|
|
|
|
|
|
#endif // BITMAP_BASE_H
|