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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <optional>
 
#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;
    }

    int GetLegacyPPI() const;

    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 SetImage( const wxImage& aImage );

    void BeginPreviewImage( const wxImage& aImage );

    void EndPreviewImage();

    bool SaveImageData( wxOutputStream& aOutStream ) const;

    bool LoadLegacyData( LINE_READER& aLine, wxString& aErrorMsg );

    void Mirror( FLIP_DIRECTION aFlipDirection );

    void Rotate( bool aRotateCCW );
 
    void ConvertToGreyscale();

    void InvertColors();

    void ConvertColourToAlpha( const wxColour& aColour );
 
    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; }
 
private:
    void updateImageDataBuffer();

    void rebuildBitmap( bool aResetID = true );

    void ensureBitmapUpToDate() const;
 
    void updatePPI();

    static void mirrorImageInPlace( wxImage& aImage, FLIP_DIRECTION aFlipDirection );

    static void invertImageInPlace( wxImage& aImage );
 
    double    m_scale;              
    mutable wxMemoryBuffer m_imageData; 
    wxBitmapType   m_imageType;     

    struct PREVIEW_SAVE
    {
        wxImage   m_image;
        wxImage   m_originalImage;
        KIID      m_imageId;
        EDA_ANGLE m_rotation;
        bool      m_isMirroredX;
        bool      m_isMirroredY;
    };
 
    std::optional<PREVIEW_SAVE> m_previewSave; 
 
    wxImage*  m_image;              
    wxImage*  m_originalImage;      
    mutable wxBitmap* m_bitmap;     
    mutable bool      m_bitmapDirty;
    double    m_pixelSizeIu;        
    int       m_ppi;                
    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
};