bitmap_base.h

Go to the documentation of this file.

/*
 * 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-2024 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
 */
 
#pragma once
 
#include <wx/bitmap.h>
#include <wx/image.h>
 
#include <core/mirror.h>
#include <kiid.h>
#include <math/box2.h>
#include <gal/color4d.h>
 
class LINE_READER;
class PLOTTER;
 
 
class BITMAP_BASE
{
public:
 BITMAP_BASE( const VECTOR2I& pos = VECTOR2I( 0, 0 ) );
 
 BITMAP_BASE( const BITMAP_BASE& aSchBitmap );
 
 ~BITMAP_BASE()
 {
 delete m_bitmap;
 delete m_image;
 delete m_originalImage;
 }
 
 /*
 * Accessors:
 */
 double GetPixelSizeIu() const { return m_pixelSizeIu; }
 void SetPixelSizeIu( double aPixSize ) { m_pixelSizeIu = aPixSize; }
 
 wxImage* GetImageData() { return m_image; }
 const wxImage* GetImageData() const { return m_image; }
 
 const wxImage* GetOriginalImageData() const { return m_originalImage; }
 
 double GetScale() const { return m_scale; }
 void SetScale( double aScale ) { m_scale = aScale; }
 
 KIID GetImageID() const { return m_imageId; }
 
 void ImportData( BITMAP_BASE& aItem );
 
 double GetScalingFactor() const
 {
 return m_pixelSizeIu * m_scale;
 }
 
 VECTOR2I GetSize() const;
 
 VECTOR2I GetSizePixels() const
 {
 if( m_image )
 return VECTOR2I( m_image->GetWidth(), m_image->GetHeight() );
 else
 return VECTOR2I( 0, 0 );
 }
 
 int GetPPI() const
 {
 return m_ppi;
 }
 
 const BOX2I GetBoundingBox() const;
 
 void DrawBitmap( wxDC* aDC, const VECTOR2I& aPos,
 const KIGFX::COLOR4D& aBackgroundColor = KIGFX::COLOR4D::UNSPECIFIED ) const;
 
 bool ReadImageFile( const wxString& aFullFilename );
 
 bool ReadImageFile( wxInputStream& aInStream );
 
 bool ReadImageFile( wxMemoryBuffer& aBuf );
 
 bool SaveImageData( wxOutputStream& aOutStream ) const;
 
 bool LoadLegacyData( LINE_READER& aLine, wxString& aErrorMsg );
 
 void Mirror( FLIP_DIRECTION aFlipDirection );
 
 void Rotate( bool aRotateCCW );
 
 void ConvertToGreyscale();
 
 bool IsMirroredX() const { return m_isMirroredX; }
 bool IsMirroredY() const { return m_isMirroredY; }
 EDA_ANGLE Rotation() const { return m_rotation; }
 
 void PlotImage( PLOTTER* aPlotter, const VECTOR2I& aPos,
 const KIGFX::COLOR4D& aDefaultColor, int aDefaultPensize ) const;
 
 wxBitmapType GetImageType() const { return m_imageType; }
 
 void SetImageType( wxBitmapType aType ) { m_imageType = aType; }
 
 const wxMemoryBuffer& GetImageDataBuffer() const { return m_imageData; }
 
 void UpdateImageDataBuffer();
 
private:
 /*
 * Rebuild the internal bitmap used to draw/plot image.
 *
 * This must be called after a #m_image change.
 *
 * @param aResetID is used to reset the cache ID used for OpenGL rendering.
 */
 void rebuildBitmap( bool aResetID = true );
 
 void updatePPI();
 
 double m_scale; // The scaling factor of the bitmap
 // With m_pixelSizeIu, controls the actual draw size
 wxMemoryBuffer m_imageData; // The original image data, in its original format
 wxBitmapType m_imageType; // the image type (png, jpeg, etc.)
 
 wxImage* m_image; // the raw, uncompressed image data
 wxImage* m_originalImage; // Raw image data, not transformed by rotate/mirror
 wxBitmap* m_bitmap; // the bitmap used to draw/plot image
 double m_pixelSizeIu; // 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
 KIID m_imageId;
 bool m_isMirroredX; // Used for OpenGL rendering only
 bool m_isMirroredY; // Used for OpenGL rendering only
 EDA_ANGLE m_rotation; // Used for OpenGL rendering only
};