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

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.

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

VECTOR2I	GetSize () const

VECTOR2I	GetSizePixels () const

int	GetPPI () const

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

void	DrawBitmap (wxDC *aDC, const VECTOR2I &aPos, const KIGFX::COLOR4D &aBackgroundColor=KIGFX::COLOR4D::UNSPECIFIED) const

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

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

bool	ReadImageFile (wxMemoryBuffer &aBuf)
	Reads and stores in memory an image file.

bool	SetImage (const wxImage &aImage)
	Set the image from an existing wxImage.

bool	SaveImageData (wxOutputStream &aOutStream) const
	Write the bitmap data to aOutStream.

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

void	Mirror (FLIP_DIRECTION aFlipDirection)
	Mirror image vertically (i.e.

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

void	ConvertToGreyscale ()

bool	IsMirroredX () const

bool	IsMirroredY () const

EDA_ANGLE	Rotation () const

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

wxBitmapType	GetImageType () const
	Return the bitmap type (png, jpeg, etc.)

void	SetImageType (wxBitmapType aType)
	Set the bitmap type (png, jpeg, etc.)

Private Member Functions
void	updateImageDataBuffer ()
	Resets the image data buffer using the current image data.

void	rebuildBitmap (bool aResetID=true)
	Rebuild the internal bitmap used to draw/plot image.

void	updatePPI ()

Private Attributes
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.

int	m_ppi
	The bitmap definition. The default is 300PPI.

KIID	m_imageId

bool	m_isMirroredX

bool	m_isMirroredY

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 48 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 40 of file bitmap_base.cpp.

References ANGLE_0, m_bitmap, m_image, m_imageType, m_isMirroredX, m_isMirroredY, 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 56 of file bitmap_base.cpp.

References m_bitmap, m_image, m_imageData, m_imageId, m_imageType, m_isMirroredX, m_isMirroredY, m_originalImage, m_pixelSizeIu, m_ppi, m_rotation, and m_scale.

◆ ~BITMAP_BASE()

BITMAP_BASE::~BITMAP_BASE ( )

inline

Definition at line 55 of file bitmap_base.h.

References m_bitmap, m_image, and m_originalImage.

Member Function Documentation

◆ ConvertToGreyscale()

void BITMAP_BASE::ConvertToGreyscale ( )

Definition at line 466 of file bitmap_base.cpp.

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

◆ DrawBitmap()

void BITMAP_BASE::DrawBitmap	(	wxDC *	aDC,
		const VECTOR2I &	aPos,
		const KIGFX::COLOR4D &	aBackgroundColor = `KIGFX::COLOR4D::UNSPECIFIED`
	)		const

Definition at line 277 of file bitmap_base.cpp.

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

Referenced by 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 266 of file bitmap_base.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetImageData() [1/2]

wxImage * BITMAP_BASE::GetImageData ( )

inline

Definition at line 68 of file bitmap_base.h.

References m_image.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_LEGACY::saveBitmap(), and SCH_IO_KICAD_SEXPR::saveBitmap().

◆ GetImageData() [2/2]

const wxImage * BITMAP_BASE::GetImageData ( ) const

inline

Definition at line 69 of file bitmap_base.h.

References m_image.

◆ GetImageID()

KIID BITMAP_BASE::GetImageID ( ) const

inline

Definition at line 76 of file bitmap_base.h.

References m_imageId.

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

◆ GetImageType()

wxBitmapType BITMAP_BASE::GetImageType ( ) const

inline

Return the bitmap type (png, jpeg, etc.)

Definition at line 236 of file bitmap_base.h.

References m_imageType.

◆ GetOriginalImageData()

const wxImage * BITMAP_BASE::GetOriginalImageData ( ) const

inline

Definition at line 71 of file bitmap_base.h.

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 65 of file bitmap_base.h.

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 118 of file bitmap_base.h.

References m_ppi.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::CAIRO_GAL_BASE::DrawBitmap(), KIGFX::OPENGL_GAL::DrawBitmap(), SCH_BITMAP::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), DS_DATA_ITEM_BITMAP::GetPPI(), SCH_IO_KICAD_LEGACY::loadBitmap(), SCH_IO_KICAD_SEXPR_PARSER::parseImage(), PLEDITOR_PRINTOUT::PrintPage(), SCH_IO_KICAD_SEXPR::saveBitmap(), DS_DATA_ITEM_BITMAP::SetPPI(), and DS_DATA_ITEM_BITMAP::SyncDrawItems().

◆ GetScale()

double BITMAP_BASE::GetScale ( ) const

inline

Definition at line 73 of file bitmap_base.h.

References m_scale.

Referenced by BOOST_AUTO_TEST_CASE(), DS_DATA_MODEL_IO::format(), and DS_DATA_ITEM_BITMAP::GetPPI().

◆ 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 94 of file bitmap_base.h.

References m_pixelSizeIu, and m_scale.

Referenced by DrawBitmap(), GetSize(), and PlotImage().

◆ GetSize()

VECTOR2I BITMAP_BASE::GetSize ( ) const

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

Definition at line 395 of file bitmap_base.cpp.

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(), SCH_BITMAP::GetHeight(), PCB_REFERENCE_IMAGE::GetHeight(), SCH_BITMAP::GetWidth(), and PCB_REFERENCE_IMAGE::GetWidth().

◆ GetSizePixels()

VECTOR2I BITMAP_BASE::GetSizePixels ( ) const

inline

Returns: the size in pixels of the image

Definition at line 107 of file bitmap_base.h.

References m_image.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE_F(), 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 110 of file bitmap_base.cpp.

References m_bitmap, m_image, m_imageData, m_imageId, m_imageType, m_isMirroredX, m_isMirroredY, m_originalImage, m_pixelSizeIu, m_ppi, m_rotation, and m_scale.

Referenced by PANEL_IMAGE_EDITOR::TransferToImage().

◆ IsMirroredX()

bool BITMAP_BASE::IsMirroredX ( ) const

inline

Definition at line 216 of file bitmap_base.h.

References m_isMirroredX.

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

◆ IsMirroredY()

bool BITMAP_BASE::IsMirroredY ( ) const

inline

Definition at line 217 of file bitmap_base.h.

References m_isMirroredY.

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

◆ LoadLegacyData()

bool BITMAP_BASE::LoadLegacyData	(	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 218 of file bitmap_base.cpp.

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

Referenced by DRAWING_SHEET_PARSER::readPngdata().

◆ Mirror()

void BITMAP_BASE::Mirror ( FLIP_DIRECTION aFlipDirection )

Mirror image vertically (i.e.

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

Parameters

aFlipDirection the direction to flip the image.

Definition at line 412 of file bitmap_base.cpp.

References m_image, m_isMirroredX, m_isMirroredY, rebuildBitmap(), and updateImageDataBuffer().

Referenced by PCB_IO_EASYEDAPRO_PARSER::ParseBoard().

◆ 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 478 of file bitmap_base.cpp.

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

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

◆ ReadImageFile() [1/3]

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 163 of file bitmap_base.cpp.

References ReadImageFile().

Referenced by DRAWING_SHEET_PARSER::parseBitmap(), ReadImageFile(), and TEST_BITMAP_BASE_FIXTURE::TEST_BITMAP_BASE_FIXTURE().

◆ ReadImageFile() [2/3]

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 127 of file bitmap_base.cpp.

References m_imageData, and SetImage().

◆ ReadImageFile() [3/3]

bool BITMAP_BASE::ReadImageFile ( wxMemoryBuffer & aBuf )

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

aBuf	a memory buffer containing the file data.

Returns: true if success reading else false.

Definition at line 146 of file bitmap_base.cpp.

References m_imageData, and SetImage().

◆ rebuildBitmap()

void BITMAP_BASE::rebuildBitmap ( bool aResetID = true )

private

Rebuild the internal bitmap used to draw/plot image.

This must be called after a m_image change.

Parameters

aResetID is used to reset the cache ID used for OpenGL rendering.

Definition at line 82 of file bitmap_base.cpp.

References m_bitmap, m_image, and m_imageId.

Referenced by ConvertToGreyscale(), Mirror(), 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 441 of file bitmap_base.cpp.

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

◆ Rotation()

EDA_ANGLE BITMAP_BASE::Rotation ( ) const

inline

Definition at line 218 of file bitmap_base.h.

References m_rotation.

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

◆ SaveImageData()

bool BITMAP_BASE::SaveImageData ( wxOutputStream & aOutStream ) const

Write the bitmap data to aOutStream.

This writes binary data, not hexadecimal strings

Parameters

aOutStream The output stream to write to.

Returns: true if success writing else false.

Definition at line 194 of file bitmap_base.cpp.

References m_image, m_imageData, and m_imageType.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), DS_DATA_MODEL_IO::format(), and SCH_IO_KICAD_SEXPR::saveBitmap().

◆ SetImage()

bool BITMAP_BASE::SetImage ( const wxImage & aImage )

Set the image from an existing wxImage.

Definition at line 175 of file bitmap_base.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), and ReadImageFile().

◆ SetImageType()

void BITMAP_BASE::SetImageType ( wxBitmapType aType )

inline

Set the bitmap type (png, jpeg, etc.)

Definition at line 241 of file bitmap_base.h.

References m_imageType.

◆ SetPixelSizeIu()

void BITMAP_BASE::SetPixelSizeIu ( double aPixSize )

inline

Definition at line 66 of file bitmap_base.h.

References m_pixelSizeIu.

Referenced by PLEDITOR_PRINTOUT::PrintPage(), 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 74 of file bitmap_base.h.

References m_scale.

Referenced by DRAWING_SHEET_PARSER::parseBitmap(), DS_DATA_ITEM_BITMAP::SetPPI(), and TEST_BITMAP_BASE_FIXTURE::TEST_BITMAP_BASE_FIXTURE().

◆ updateImageDataBuffer()

void BITMAP_BASE::updateImageDataBuffer ( )

private

Resets the image data buffer using the current image data.

Definition at line 493 of file bitmap_base.cpp.

References m_image, m_imageData, and m_imageType.

Referenced by ConvertToGreyscale(), LoadLegacyData(), Mirror(), and Rotate().

◆ updatePPI()

void BITMAP_BASE::updatePPI ( )

private

Definition at line 95 of file bitmap_base.cpp.

References KiROUND(), m_originalImage, and m_ppi.

Referenced by SetImage().

Member Data Documentation

◆ m_bitmap

wxBitmap* BITMAP_BASE::m_bitmap

private

The bitmap used to draw/plot image.

Definition at line 267 of file bitmap_base.h.

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

◆ m_image

wxImage* BITMAP_BASE::m_image

private

The raw, uncompressed image data.

Definition at line 265 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ConvertToGreyscale(), GetImageData(), GetSizePixels(), ImportData(), LoadLegacyData(), Mirror(), PlotImage(), rebuildBitmap(), Rotate(), SaveImageData(), SetImage(), updateImageDataBuffer(), and ~BITMAP_BASE().

◆ m_imageData

wxMemoryBuffer BITMAP_BASE::m_imageData

private

The original image data in its original format.

Definition at line 262 of file bitmap_base.h.

Referenced by BITMAP_BASE(), ImportData(), ReadImageFile(), SaveImageData(), and updateImageDataBuffer().

◆ m_imageId

KIID BITMAP_BASE::m_imageId

private

Definition at line 272 of file bitmap_base.h.

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

◆ m_imageType

wxBitmapType BITMAP_BASE::m_imageType

private

The image type (png, jpeg, etc.).

Definition at line 263 of file bitmap_base.h.

Referenced by BITMAP_BASE(), GetImageType(), ImportData(), SaveImageData(), SetImageType(), and updateImageDataBuffer().

◆ m_isMirroredX

bool BITMAP_BASE::m_isMirroredX

private

Definition at line 273 of file bitmap_base.h.

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

◆ m_isMirroredY

bool BITMAP_BASE::m_isMirroredY

private

Definition at line 274 of file bitmap_base.h.

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

◆ m_originalImage

wxImage* BITMAP_BASE::m_originalImage

private

Raw image data, not transformed by rotate/mirror.

Definition at line 266 of file bitmap_base.h.

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

◆ m_pixelSizeIu

double BITMAP_BASE::m_pixelSizeIu

private

The scaling factor of the bitmap to convert the bitmap size (in pixels) to internal KiCad units.

This usually does not change.

Definition at line 268 of file bitmap_base.h.

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

◆ m_ppi

int BITMAP_BASE::m_ppi

private

The bitmap definition. The default is 300PPI.

Definition at line 271 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 275 of file bitmap_base.h.

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

◆ m_scale

double BITMAP_BASE::m_scale

private

The scaling factor of the bitmap with m_pixelSizeIu, controls the actual draw size.

Definition at line 260 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()

◆ GetImageType()

◆ GetOriginalImageData()

◆ GetPixelSizeIu()

◆ GetPPI()

◆ GetScale()

◆ GetScalingFactor()

◆ GetSize()

◆ GetSizePixels()

◆ ImportData()

◆ IsMirroredX()

◆ IsMirroredY()

◆ LoadLegacyData()

◆ Mirror()

◆ PlotImage()

◆ ReadImageFile() [1/3]

◆ ReadImageFile() [2/3]

◆ ReadImageFile() [3/3]

◆ rebuildBitmap()

◆ Rotate()

◆ Rotation()

◆ SaveImageData()

◆ SetImage()

◆ SetImageType()

◆ SetPixelSizeIu()

◆ SetScale()

◆ updateImageDataBuffer()

◆ updatePPI()

Member Data Documentation

◆ m_bitmap

◆ m_image

◆ m_imageData

◆ m_imageId

◆ m_imageType

◆ m_isMirroredX

◆ m_isMirroredY

◆ m_originalImage

◆ m_pixelSizeIu

◆ m_ppi

◆ m_rotation

◆ m_scale