reference_image.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 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 <memory>
 
#include <base_units.h>
#include <core/mirror.h>
#include <math/box2.h>
#include <math/vector2d.h>
 
class BITMAP_BASE;
 
class wxMemoryBuffer;
class wxImage;
 
class REFERENCE_IMAGE
{
public:
    REFERENCE_IMAGE( const EDA_IU_SCALE& aIuScale );
    REFERENCE_IMAGE( const REFERENCE_IMAGE& aOther );
    ~REFERENCE_IMAGE();
 
    REFERENCE_IMAGE& operator=( const REFERENCE_IMAGE& aOther );
 
    bool operator==( const REFERENCE_IMAGE& aOther ) const;
 
    double Similarity( const REFERENCE_IMAGE& aOther ) const;
 
    BOX2I GetBoundingBox() const;
 
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const;
 
    VECTOR2I GetPosition() const;
    void     SetPosition( const VECTOR2I& aPos );
 
    VECTOR2I GetSize() const;
 
    double GetImageScale() const;
 
    void SetImageScale( double aScale );
 
    void SetWidth( int aWidth );
    void SetHeight( int aHeight );
 
    void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection );
 
    void Rotate( const VECTOR2I& aCenter, const EDA_ANGLE& aAngle );
 
    bool ReadImageFile( const wxString& aFullFilename );
 
    bool ReadImageFile( wxMemoryBuffer& aBuf );
 
    bool SetImage( const wxImage& aImage );
 
    void SwapData( REFERENCE_IMAGE& aItem );
 
    const BITMAP_BASE& GetImage() const;
 
    BITMAP_BASE& MutableImage() const;
 
 
    VECTOR2I GetTransformOriginOffset() const;
    void     SetTransformOriginOffset( const VECTOR2I& aCenter );
 
private:
    void scaleBy( double ratio );
 
    void updatePixelSizeInIU();
 
    const EDA_IU_SCALE& m_iuScale;
 
    VECTOR2I m_pos; // XY coordinates of center of the bitmap
    VECTOR2I m_transformOriginOffset;
 
    std::unique_ptr<BITMAP_BASE> m_bitmapBase;
};