This class handle bitmap images in KiCad. More...

#include <bitmap_base.h>

Public Member Functions
	BITMAP_BASE (const VECTOR2I &pos=VECTOR2I(0, 0))

	BITMAP_BASE (const BITMAP_BASE &aSchBitmap)

	~BITMAP_BASE ()

double	GetPixelSizeIu () const

void	SetPixelSizeIu (double aPixSize)

wxImage *	GetImageData ()

const wxImage *	GetImageData () const

const wxImage *	GetOriginalImageData () const

void	SetImage (wxImage *aImage)

double	GetScale () const

void	SetScale (double aScale)

KIID	GetImageID () const

void	ImportData (BITMAP_BASE *aItem)
	Copy aItem image to this object and update m_bitmap. More...

double	GetScalingFactor () const
	This scaling factor depends on m_pixelSizeIu and m_scale. More...

VECTOR2I	GetSize () const

VECTOR2I	GetSizePixels () const

int	GetPPI () const

const BOX2I	GetBoundingBox () const
	Return the orthogonal, bounding box of this object for display purposes. More...

void	DrawBitmap (wxDC *aDC, const VECTOR2I &aPos)

bool	ReadImageFile (const wxString &aFullFilename)
	Reads and stores in memory an image file. More...

bool	ReadImageFile (wxInputStream &aInStream)
	Reads and stores in memory an image file. More...

bool	SaveData (FILE *aFile) const
	Write the bitmap data to aFile. More...

void	SaveData (wxArrayString &aPngStrings) const
	Write the bitmap data to an array string. More...

bool	LoadData (LINE_READER &aLine, wxString &aErrorMsg)
	Load an image data saved by SaveData. More...

void	Mirror (bool aVertically)
	Mirror image vertically (i.e. More...

void	Rotate (bool aRotateCCW)
	Rotate image CW or CCW. More...

void	ConvertToGreyscale ()

bool	IsMirrored () const

EDA_ANGLE	Rotation () const

void	PlotImage (PLOTTER *aPlotter, const VECTOR2I &aPos, const KIGFX::COLOR4D &aDefaultColor, int aDefaultPensize) const
	Plot bitmap on plotter. More...

Private Member Functions
void	rebuildBitmap (bool aResetID=true)

void	updatePPI ()

Private Attributes
double	m_scale

wxImage *	m_image

wxImage *	m_originalImage

wxBitmap *	m_bitmap

double	m_pixelSizeIu

int	m_ppi

KIID	m_imageId

bool	m_isMirrored

EDA_ANGLE	m_rotation

Detailed Description

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, DS_DRAW_ITEM_BITMAP, and possibly others in the future.

Warning: Not all plotters are able to plot a bitmap. Mainly GERBER plotters cannot.

Definition at line 51 of file bitmap_base.h.

Constructor & Destructor Documentation

◆ BITMAP_BASE() [1/2]

BITMAP_BASE::BITMAP_BASE ( const VECTOR2I & pos = VECTOR2I( 0, 0 ) )

Definition at line 35 of file bitmap_base.cpp.

{
 m_scale = 1.0; // 1.0 = original bitmap size
 m_bitmap = nullptr;
 m_image = nullptr;
 m_originalImage = nullptr;
 m_ppi = 300; // the bitmap definition. the default is 300PPI
 m_pixelSizeIu = 254000.0 / m_ppi; // a pixel size value OK for bitmaps using 300 PPI
 // for Eeschema which uses currently 254000PPI
 m_isMirrored = false;
 m_rotation = ANGLE_0;
}

References ANGLE_0, m_bitmap, m_image, m_isMirrored, m_originalImage, m_pixelSizeIu, m_ppi, m_rotation, and m_scale.

◆ BITMAP_BASE() [2/2]

BITMAP_BASE::BITMAP_BASE ( const BITMAP_BASE & aSchBitmap )

Definition at line 49 of file bitmap_base.cpp.

{
 m_scale = aSchBitmap.m_scale;
 m_ppi = aSchBitmap.m_ppi;
 m_pixelSizeIu = aSchBitmap.m_pixelSizeIu;
 m_isMirrored = aSchBitmap.m_isMirrored;
 m_rotation = aSchBitmap.m_rotation;
 
 m_image = nullptr;
 m_bitmap = nullptr;
 m_originalImage = nullptr;
 
 if( aSchBitmap.m_image )
  {
 m_image = new wxImage( *aSchBitmap.m_image );
 m_bitmap = new wxBitmap( *m_image );
 m_originalImage = new wxImage( *aSchBitmap.m_originalImage );
 m_imageId = aSchBitmap.m_imageId;
 }
}

References m_bitmap, m_image, m_imageId, m_isMirrored, m_originalImage, m_pixelSizeIu, m_ppi, m_rotation, and m_scale.

◆ ~BITMAP_BASE()

BITMAP_BASE::~BITMAP_BASE ( )

inline

Definition at line 58 of file bitmap_base.h.

 {
 delete m_bitmap;
 delete m_image;
 delete m_originalImage;
 }

References m_bitmap, m_image, and m_originalImage.

Member Function Documentation

◆ ConvertToGreyscale()

void BITMAP_BASE::ConvertToGreyscale ( )

Definition at line 421 of file bitmap_base.cpp.

{
 if( m_image )
 {
 *m_image = m_image->ConvertToGreyscale();
 *m_originalImage = m_originalImage->ConvertToGreyscale();
 rebuildBitmap();
 }
}

References m_image, m_originalImage, and rebuildBitmap().

Referenced by PANEL_IMAGE_EDITOR::OnGreyScaleConvert().

◆ DrawBitmap()

void BITMAP_BASE::DrawBitmap	(	wxDC *	aDC,
		const VECTOR2I &	aPos
	)

Definition at line 281 of file bitmap_base.cpp.

{
 if( m_bitmap == nullptr )
 return;
 
 VECTOR2I pos = aPos;
 VECTOR2I size = GetSize();
 
 // This fixes a bug in OSX that should be fixed in the 3.0.3 version or later.
 if( ( size.x == 0 ) || ( size.y == 0 ) )
 return;
 
 // To draw the bitmap, pos is the upper left corner position
 pos.x -= size.x / 2;
 pos.y -= size.y / 2;
 
 double scale;
 int logicalOriginX, logicalOriginY;
 aDC->GetUserScale( &scale, &scale );
 aDC->GetLogicalOrigin( &logicalOriginX, &logicalOriginY );
 
 // We already have issues to draw a bitmap on the wxDC, depending on wxWidgets version.
 // Now we have an issue on wxWidgets 3.1.6 to fix the clip area
 // and the bitmap position when using TransformMatrix
 // So for version == 3.1.6 do not use it
 // Be carefull before changing the code.
 bool useTransform = aDC->CanUseTransformMatrix();
 
 #if wxCHECK_VERSION( 3, 1, 6 ) && !wxCHECK_VERSION( 3, 1, 7 )
 useTransform = false;
 #endif
 
 wxAffineMatrix2D init_matrix = aDC->GetTransformMatrix();
 
 // Note: clipping bitmap area was made to fix a minor issue in old versions of
 // Kicad/wxWidgets (5.1 / wx 3.0)
 // However SetClippingRegion creates a lot of issues (different ways to fix the
 // position and size of the area, depending on wxWidget version)because it changes with
 // each versions of wxWigets, so it is now disabled
 // However the code is still here, just in case
 // #define USE_CLIP_AREA
 
 wxPoint clipAreaPos;
 
 if( useTransform )
 {
 wxAffineMatrix2D matrix = aDC->GetTransformMatrix();
 matrix.Translate( pos.x, pos.y );
 matrix.Scale( GetScalingFactor(), GetScalingFactor() );
 aDC->SetTransformMatrix( matrix );
 // Needed on wx <= 3.1.5, and this is strange...
 // Nevertheless, this code has problem (the bitmap is not seen)
 // with wx version > 3.1.5
 clipAreaPos.x = pos.x;
 clipAreaPos.y = pos.y;
 
 pos.x = pos.y = 0;
 }
 else
 {
 aDC->SetUserScale( scale * GetScalingFactor(), scale * GetScalingFactor() );
 aDC->SetLogicalOrigin( logicalOriginX / GetScalingFactor(),
 logicalOriginY / GetScalingFactor() );
 
 pos.x = KiROUND( pos.x / GetScalingFactor() );
 pos.y = KiROUND( pos.y / GetScalingFactor() );
 size.x = KiROUND( size.x / GetScalingFactor() );
 size.y = KiROUND( size.y / GetScalingFactor() );
 clipAreaPos.x = pos.x;
 clipAreaPos.y = pos.y;
 }
 
 #ifdef USE_CLIP_AREA
 aDC->DestroyClippingRegion();
 aDC->SetClippingRegion( clipAreaPos, wxSize( size.x, size.y ) );
 #endif
 
 if( GetGRForceBlackPenState() )
 {
 wxBitmap result( m_bitmap->ConvertToImage().ConvertToGreyscale() );
 aDC->DrawBitmap( result, pos.x, pos.y, true );
 }
 else
 {
 aDC->DrawBitmap( *m_bitmap, pos.x, pos.y, true );
 }
 
 if( useTransform )
 aDC->SetTransformMatrix( init_matrix );
 else
 {
 aDC->SetUserScale( scale, scale );
 aDC->SetLogicalOrigin( logicalOriginX, logicalOriginY );
 }
 
 #ifdef USE_CLIP_AREA
 aDC->DestroyClippingRegion();
 #endif
}

References GetGRForceBlackPenState(), GetScalingFactor(), GetSize(), KiROUND(), m_bitmap, scale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PANEL_IMAGE_EDITOR::OnRedrawPanel(), SCH_BITMAP::Print(), and DS_DRAW_ITEM_BITMAP::PrintWsItem().

◆ GetBoundingBox()

const BOX2I BITMAP_BASE::GetBoundingBox ( ) const

Return 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.

Definition at line 270 of file bitmap_base.cpp.

{
 BOX2I bbox;
 VECTOR2I size = GetSize();
 
 bbox.Inflate( size.x / 2, size.y / 2 );
 
 return bbox;
}

References GetSize(), BOX2< Vec >::Inflate(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_BITMAP::GetBoundingBox().

◆ GetImageData() [1/2]

wxImage * BITMAP_BASE::GetImageData ( )

inline

Definition at line 71 of file bitmap_base.h.

71{ return m_image; }

References m_image.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), PCB_PLUGIN::format(), SCH_LEGACY_PLUGIN::saveBitmap(), and SCH_SEXPR_PLUGIN::saveBitmap().

◆ GetImageData() [2/2]

const wxImage * BITMAP_BASE::GetImageData ( ) const

inline

Definition at line 72 of file bitmap_base.h.

72{ return m_image; }

References m_image.

◆ GetImageID()

KIID BITMAP_BASE::GetImageID ( ) const

inline

Definition at line 81 of file bitmap_base.h.

81{ return m_imageId; }

References m_imageId.

Referenced by KIGFX::GL_BITMAP_CACHE::cacheBitmap(), and KIGFX::GL_BITMAP_CACHE::RequestBitmap().

◆ GetOriginalImageData()

const wxImage * BITMAP_BASE::GetOriginalImageData ( ) const

inline

Definition at line 74 of file bitmap_base.h.

74{ return m_originalImage; }

References m_originalImage.

Referenced by KIGFX::GL_BITMAP_CACHE::cacheBitmap(), DS_DATA_MODEL_IO::format(), and DS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ GetPixelSizeIu()

double BITMAP_BASE::GetPixelSizeIu ( ) const

inline

Definition at line 68 of file bitmap_base.h.

68{ return m_pixelSizeIu; }

References m_pixelSizeIu.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetPPI()

int BITMAP_BASE::GetPPI ( ) const

inline

Returns: the bitmap definition in ppi, the default is 300 ppi.

Definition at line 123 of file bitmap_base.h.

 {
 return m_ppi;
 }

References m_ppi.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawBitmap(), DS_DATA_ITEM_BITMAP::GetPPI(), SCH_LEGACY_PLUGIN::loadBitmap(), PCB_BITMAP::operator=(), PCB_BITMAP::PCB_BITMAP(), PL_EDITOR_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), SCH_BITMAP::ReadImageFile(), PCB_BITMAP::ReadImageFile(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_BITMAP::SetImage(), PCB_BITMAP::SetImage(), DS_DATA_ITEM_BITMAP::SetPPI(), and DS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ GetScale()

double BITMAP_BASE::GetScale ( ) const

inline

Definition at line 78 of file bitmap_base.h.

78{ return m_scale; }

References m_scale.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PLUGIN::format(), DS_DATA_MODEL_IO::format(), SCH_BITMAP::GetImageScale(), PCB_BITMAP::GetImageScale(), DS_DATA_ITEM_BITMAP::GetPPI(), SCH_LEGACY_PLUGIN::loadBitmap(), PANEL_IMAGE_EDITOR::PANEL_IMAGE_EDITOR(), SCH_LEGACY_PLUGIN::saveBitmap(), and SCH_SEXPR_PLUGIN::saveBitmap().

◆ GetScalingFactor()

double BITMAP_BASE::GetScalingFactor ( ) const

inline

This scaling factor depends on m_pixelSizeIu and m_scale.

m_pixelSizeIu gives the scaling factor between a pixel size and the internal units. m_scale is an user dependent 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.

Returns: The scaling factor from pixel size to actual draw size.

Definition at line 99 of file bitmap_base.h.

 {
 return m_pixelSizeIu * m_scale;
 }

References m_pixelSizeIu, and m_scale.

Referenced by DrawBitmap(), GetSize(), PANEL_IMAGE_EDITOR::OnRedrawPanel(), and PlotImage().

◆ GetSize()

VECTOR2I BITMAP_BASE::GetSize ( ) const

Returns: the actual size (in user units, not in pixels) of the image

Definition at line 382 of file bitmap_base.cpp.

{
 VECTOR2I size;
 
 if( m_bitmap )
 {
 size.x = m_bitmap->GetWidth();
 size.y = m_bitmap->GetHeight();
 
 size.x = KiROUND( size.x * GetScalingFactor() );
 size.y = KiROUND( size.y * GetScalingFactor() );
 }
 
 return size;
}

References GetScalingFactor(), KiROUND(), m_bitmap, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), DrawBitmap(), GetBoundingBox(), DS_DRAW_ITEM_BITMAP::GetBoundingBox(), PCB_BITMAP::GetBoundingBox(), SCH_BITMAP::GetSize(), and PCB_BITMAP::GetSize().

◆ GetSizePixels()

VECTOR2I BITMAP_BASE::GetSizePixels ( ) const

inline

Returns: the size in pixels of the image

Definition at line 112 of file bitmap_base.h.

 {
 if( m_image )
 return VECTOR2I( m_image->GetWidth(), m_image->GetHeight() );
 else
 return VECTOR2I( 0, 0 );
 }

References m_image.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_IMAGE_EDITOR::CheckValues(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), and KIGFX::OPENGL_GAL::DrawBitmap().

◆ ImportData()

void BITMAP_BASE::ImportData ( BITMAP_BASE * aItem )

Copy aItem image to this object and update m_bitmap.

Definition at line 109 of file bitmap_base.cpp.

{
 *m_image = *aItem->m_image;
 *m_bitmap = *aItem->m_bitmap;
 *m_originalImage = *aItem->m_originalImage;
 m_imageId = aItem->m_imageId;
 m_scale = aItem->m_scale;
 m_ppi = aItem->m_ppi;
 m_pixelSizeIu = aItem->m_pixelSizeIu;
 m_isMirrored = aItem->m_isMirrored;
 m_rotation = aItem->m_rotation;
}

References m_bitmap, m_image, m_imageId, m_isMirrored, m_originalImage, m_pixelSizeIu, m_ppi, m_rotation, and m_scale.

Referenced by PANEL_IMAGE_EDITOR::TransferToImage().

◆ IsMirrored()

bool BITMAP_BASE::IsMirrored ( ) const

inline

Definition at line 213 of file bitmap_base.h.

213{ return m_isMirrored; }

References m_isMirrored.

Referenced by KIGFX::OPENGL_GAL::DrawBitmap().

◆ LoadData()

bool BITMAP_BASE::LoadData	(	LINE_READER &	aLine,
		wxString &	aErrorMsg
	)

Load an image data saved by SaveData.

The file format must be png format in hexadecimal.

Parameters

aLine	the LINE_READER used to read the data file.
aErrorMsg	Description of the error if an error occurs while loading the png bitmap data.

Returns: true if the bitmap loaded successfully.

Definition at line 223 of file bitmap_base.cpp.

{
 wxMemoryOutputStream stream;
 char* line;
 
 while( true )
 {
 if( !aLine.ReadLine() )
 {
 aErrorMsg = wxT("Unexpected end of data");
 return false;
 }
 
 line = aLine.Line();
 
 if( strncasecmp( line, "EndData", 4 ) == 0 )
 {
 // all the PNG date is read.
 // We expect here m_image and m_bitmap are void
 m_image = new wxImage();
 wxMemoryInputStream istream( stream );
 m_image->LoadFile( istream, wxBITMAP_TYPE_PNG );
 m_bitmap = new wxBitmap( *m_image );
 m_originalImage = new wxImage( *m_image );
 break;
 }
 
 // Read PNG data, stored in hexadecimal,
 // each byte = 2 hexadecimal digits and a space between 2 bytes
 // and put it in memory stream buffer
 int len = strlen( line );
 
 for( ; len > 0; len -= 3, line += 3 )
 {
 int value = 0;
 
 if( sscanf( line, "%X", &value ) == 1 )
 stream.PutC( (char) value );
 else
 break;
 }
 }
 
 return true;
}

References LINE_READER::Line(), m_bitmap, m_image, m_originalImage, and LINE_READER::ReadLine().

Referenced by DRAWING_SHEET_PARSER::readPngdata().

◆ Mirror()

void BITMAP_BASE::Mirror ( bool aVertically )

Mirror image vertically (i.e.

relative to its horizontal X axis ) or horizontally (i.e relative to its vertical Y axis).

Parameters

aVertically false to mirror horizontally or true to mirror vertically.

Definition at line 399 of file bitmap_base.cpp.

{
 if( m_image )
 {
 *m_image = m_image->Mirror( not aVertically );
 m_isMirrored = !m_isMirrored;
 rebuildBitmap( false );
 }
}

References m_image, m_isMirrored, and rebuildBitmap().

Referenced by PCB_BITMAP::Flip(), SCH_BITMAP::MirrorHorizontally(), and SCH_BITMAP::MirrorVertically().

◆ PlotImage()

void BITMAP_BASE::PlotImage	(	PLOTTER *	aPlotter,
		const VECTOR2I &	aPos,
		const KIGFX::COLOR4D &	aDefaultColor,
		int	aDefaultPensize
	)		const

Plot bitmap on plotter.

If the plotter does not support bitmaps, plot a

Parameters

aPlotter	the plotter to use.
aPos	the position of the center of the bitmap.
aDefaultColor	the color used to plot the rectangle when bitmap is not supported.
aDefaultPensize	the pen size used to plot the rectangle when bitmap is not supported.

Definition at line 432 of file bitmap_base.cpp.

{
 if( m_image == nullptr )
 return;
 
 // These 2 lines are useful only for plotters that cannot plot a bitmap
 // and plot a rectangle instead of.
 aPlotter->SetColor( aDefaultColor );
 aPlotter->SetCurrentLineWidth( aDefaultPensize );
 aPlotter->PlotImage( *m_image, aPos, GetScalingFactor() );
}

References GetScalingFactor(), m_image, PLOTTER::PlotImage(), PLOTTER::SetColor(), and PLOTTER::SetCurrentLineWidth().

Referenced by SCH_BITMAP::Plot(), and PlotDrawingSheet().

◆ ReadImageFile() [1/2]

bool BITMAP_BASE::ReadImageFile ( const wxString & aFullFilename )

Reads and stores in memory an image file.

Initialize 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 always loaded.

Parameters

aFullFilename The full filename of the image file to read.

Returns: true if success reading else false.

Definition at line 141 of file bitmap_base.cpp.

{
 wxImage* new_image = new wxImage();
 
 if( !new_image->LoadFile( aFullFilename ) )
 {
 delete new_image;
 return false;
 }
 
 delete m_image;
 m_image = new_image;
 delete m_originalImage;
 m_originalImage = new wxImage( *m_image );
 rebuildBitmap();
 updatePPI();
 
 return true;
}

References m_image, m_originalImage, rebuildBitmap(), and updatePPI().

Referenced by SCH_BITMAP::ReadImageFile(), PCB_BITMAP::ReadImageFile(), and TEST_BITMAP_BASE_FIXTURE::TEST_BITMAP_BASE_FIXTURE().

◆ ReadImageFile() [2/2]

bool BITMAP_BASE::ReadImageFile ( wxInputStream & aInStream )

Reads and stores in memory an image file.

Initialize 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 always loaded.

Parameters

aInStream an input stream containing the file data.

Returns: true if success reading else false.

Definition at line 123 of file bitmap_base.cpp.

{
 std::unique_ptr<wxImage> new_image = std::make_unique<wxImage>();
 
 if( !new_image->LoadFile( aInStream ) )
 return false;
 
 delete m_image;
 m_image = new_image.release();
 delete m_originalImage;
 m_originalImage = new wxImage( *m_image );
 rebuildBitmap();
 updatePPI();
 
 return true;
}

References m_image, m_originalImage, rebuildBitmap(), and updatePPI().

◆ rebuildBitmap()

void BITMAP_BASE::rebuildBitmap ( bool aResetID = true )

private

Definition at line 82 of file bitmap_base.cpp.

{
 if( m_bitmap )
 delete m_bitmap;
 
 m_bitmap = new wxBitmap( *m_image );
 
 if( aResetID )
 m_imageId = KIID();
}

References m_bitmap, m_image, and m_imageId.

Referenced by ConvertToGreyscale(), Mirror(), ReadImageFile(), Rotate(), and SetImage().

◆ Rotate()

void BITMAP_BASE::Rotate ( bool aRotateCCW )

Rotate image CW or CCW.

Parameters

aRotateCCW true to rotate CCW or false to rotate CW.

Definition at line 410 of file bitmap_base.cpp.

{
 if( m_image )
 {
 *m_image = m_image->Rotate90( aRotateCCW );
 m_rotation += ( aRotateCCW ? -ANGLE_90 : ANGLE_90 );
 rebuildBitmap( false );
 }
}

References ANGLE_90, m_image, m_rotation, and rebuildBitmap().

Referenced by SCH_BITMAP::Rotate(), and PCB_BITMAP::Rotate().

◆ Rotation()

EDA_ANGLE BITMAP_BASE::Rotation ( ) const

inline

Definition at line 214 of file bitmap_base.h.

214{ return m_rotation; }

References m_rotation.

Referenced by KIGFX::OPENGL_GAL::DrawBitmap().

◆ SaveData() [1/2]

bool BITMAP_BASE::SaveData ( FILE * aFile ) const

Write the bitmap data to aFile.

The file format is png, in hexadecimal form. If the hexadecimal data is converted to binary it gives exactly a .png image data.

Parameters

aFile The FILE to write to.

Returns: true if success writing else false.

Definition at line 162 of file bitmap_base.cpp.

{
 if( m_image )
 {
 wxMemoryOutputStream stream;
 m_image->SaveFile( stream, wxBITMAP_TYPE_PNG );
 
 // Write binary data in hexadecimal form (ASCII)
 wxStreamBuffer* buffer = stream.GetOutputStreamBuffer();
 char* begin = (char*) buffer->GetBufferStart();
 
 for( int ii = 0; begin < buffer->GetBufferEnd(); begin++, ii++ )
 {
 if( ii >= 32 )
 {
 ii = 0;
 
 if( fprintf( aFile, "\n" ) == EOF )
 return false;
 }
 
 if( fprintf( aFile, "%2.2X ", *begin & 0xFF ) == EOF )
 return false;
 }
 }
 
 return true;
}

References m_image.

Referenced by DS_DATA_MODEL_IO::format().

◆ SaveData() [2/2]

void BITMAP_BASE::SaveData ( wxArrayString & aPngStrings ) const

Write 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.

Parameters

aPngStrings The wxArrayString to write to.

Definition at line 192 of file bitmap_base.cpp.

{
 if( m_image )
 {
 wxMemoryOutputStream stream;
 m_image->SaveFile( stream, wxBITMAP_TYPE_PNG );
 
 // Write binary data in hexadecimal form (ASCII)
 wxStreamBuffer* buffer = stream.GetOutputStreamBuffer();
 char* begin = (char*) buffer->GetBufferStart();
 wxString line;
 
 for( int ii = 0; begin < buffer->GetBufferEnd(); begin++, ii++ )
 {
 if( ii >= 32 )
 {
 ii = 0;
 aPngStrings.Add( line );
 line.Empty();
 }
 
 line << wxString::Format( wxT( "%2.2X " ), *begin & 0xFF );
 }
 
 // Add last line:
 if( !line.IsEmpty() )
 aPngStrings.Add( line );
 }
}

References Format(), and m_image.

◆ SetImage()

void BITMAP_BASE::SetImage ( wxImage * aImage )

Definition at line 71 of file bitmap_base.cpp.

{
 delete m_image;
 m_image = aImage;
 delete m_originalImage;
 m_originalImage = new wxImage( *aImage );
 rebuildBitmap();
 updatePPI();
}

References m_image, m_originalImage, rebuildBitmap(), and updatePPI().

Referenced by SCH_BITMAP::SetImage(), and PCB_BITMAP::SetImage().

◆ SetPixelSizeIu()

void BITMAP_BASE::SetPixelSizeIu ( double aPixSize )

inline

Definition at line 69 of file bitmap_base.h.

69{ m_pixelSizeIu = aPixSize; }

References m_pixelSizeIu.

Referenced by PCB_BITMAP::operator=(), PCB_BITMAP::PCB_BITMAP(), PL_EDITOR_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), SCH_BITMAP::ReadImageFile(), PCB_BITMAP::ReadImageFile(), SCH_BITMAP::SetImage(), PCB_BITMAP::SetImage(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), and TEST_BITMAP_BASE_FIXTURE::TEST_BITMAP_BASE_FIXTURE().

◆ SetScale()

void BITMAP_BASE::SetScale ( double aScale )

inline

Definition at line 79 of file bitmap_base.h.

79{ m_scale = aScale; }

References m_scale.

Referenced by SCH_LEGACY_PLUGIN::loadBitmap(), DRAWING_SHEET_PARSER::parseBitmap(), SCH_BITMAP::SetImageScale(), PCB_BITMAP::SetImageScale(), DS_DATA_ITEM_BITMAP::SetPPI(), TEST_BITMAP_BASE_FIXTURE::TEST_BITMAP_BASE_FIXTURE(), and PANEL_IMAGE_EDITOR::TransferToImage().

◆ updatePPI()

void BITMAP_BASE::updatePPI ( )

private

Definition at line 94 of file bitmap_base.cpp.

{
 // Todo: eventually we need to support dpi / scaling in both dimensions
 int dpiX = m_originalImage->GetOptionInt( wxIMAGE_OPTION_RESOLUTIONX );
 
 if( dpiX > 1 )
 {
 if( m_originalImage->GetOptionInt( wxIMAGE_OPTION_RESOLUTIONUNIT ) == wxIMAGE_RESOLUTION_CM )
 m_ppi = KiROUND( dpiX * 2.54 );
 else
 m_ppi = dpiX;
 }
}

References KiROUND(), m_originalImage, and m_ppi.

Referenced by ReadImageFile(), and SetImage().

Member Data Documentation

◆ m_bitmap

wxBitmap* BITMAP_BASE::m_bitmap

private

Definition at line 245 of file bitmap_base.h.

Referenced by BITMAP_BASE(), DrawBitmap(), GetSize(), ImportData(), LoadData(), rebuildBitmap(), and ~BITMAP_BASE().

◆ m_image

wxImage* BITMAP_BASE::m_image

private

Definition at line 243 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ConvertToGreyscale(), GetImageData(), GetSizePixels(), ImportData(), LoadData(), Mirror(), PlotImage(), ReadImageFile(), rebuildBitmap(), Rotate(), SaveData(), SetImage(), and ~BITMAP_BASE().

◆ m_imageId

KIID BITMAP_BASE::m_imageId

private

Definition at line 251 of file bitmap_base.h.

Referenced by BITMAP_BASE(), GetImageID(), ImportData(), and rebuildBitmap().

◆ m_isMirrored

bool BITMAP_BASE::m_isMirrored

private

Definition at line 252 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ImportData(), IsMirrored(), and Mirror().

◆ m_originalImage

wxImage* BITMAP_BASE::m_originalImage

private

Definition at line 244 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ConvertToGreyscale(), GetOriginalImageData(), ImportData(), LoadData(), ReadImageFile(), SetImage(), updatePPI(), and ~BITMAP_BASE().

◆ m_pixelSizeIu

double BITMAP_BASE::m_pixelSizeIu

private

Definition at line 246 of file bitmap_base.h.

Referenced by BITMAP_BASE(), GetPixelSizeIu(), GetScalingFactor(), ImportData(), and SetPixelSizeIu().

◆ m_ppi

int BITMAP_BASE::m_ppi

private

Definition at line 250 of file bitmap_base.h.

Referenced by BITMAP_BASE(), GetPPI(), ImportData(), and updatePPI().

◆ m_rotation

EDA_ANGLE BITMAP_BASE::m_rotation

private

Definition at line 253 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ImportData(), Rotate(), and Rotation().

◆ m_scale

double BITMAP_BASE::m_scale

private

Definition at line 241 of file bitmap_base.h.

Referenced by BITMAP_BASE(), GetScale(), GetScalingFactor(), ImportData(), and SetScale().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BITMAP_BASE() [1/2]

◆ BITMAP_BASE() [2/2]

◆ ~BITMAP_BASE()

Member Function Documentation

◆ ConvertToGreyscale()

◆ DrawBitmap()

◆ GetBoundingBox()

◆ GetImageData() [1/2]

◆ GetImageData() [2/2]

◆ GetImageID()

◆ GetOriginalImageData()

◆ GetPixelSizeIu()

◆ GetPPI()

◆ GetScale()

◆ GetScalingFactor()

◆ GetSize()

◆ GetSizePixels()

◆ ImportData()

◆ IsMirrored()

◆ LoadData()

◆ Mirror()

◆ PlotImage()

◆ ReadImageFile() [1/2]

◆ ReadImageFile() [2/2]

◆ rebuildBitmap()

◆ Rotate()

◆ Rotation()

◆ SaveData() [1/2]

◆ SaveData() [2/2]

◆ SetImage()

◆ SetPixelSizeIu()

◆ SetScale()

◆ updatePPI()

Member Data Documentation

◆ m_bitmap

◆ m_image

◆ m_imageId

◆ m_isMirrored

◆ m_originalImage

◆ m_pixelSizeIu

◆ m_ppi

◆ m_rotation

◆ m_scale