Bitmap implementation based on Qt QImage. More...

#include <CBitmap.h>

Inheritance diagram for iimg::CBitmap:

Collaboration diagram for iimg::CBitmap:

Public Member Functions
	CBitmap ()

	CBitmap (const CBitmap &bitmap)

	CBitmap (const QImage &image)

QImage &	GetQImageRef ()

const QImage &	GetQImage () const override
	Gets a QImage object.

bool	CopyImageFrom (const QImage &image) override
	Copies the image data from a QImage object.

bool	IsFormatSupported (PixelFormat pixelFormat) const override
	Get `true` if the pixel format is supported by the bitmap implementation.

PixelFormat	GetPixelFormat () const override
	Get the bitmap's pixel format.

bool	CreateBitmap (PixelFormat pixelFormat, const istd::CIndex2d &size, int pixelBitsCount=0, int componentsCount=0) override
	Create bitmap with specified size and format.

bool	CreateBitmap (PixelFormat pixelFormat, const istd::CIndex2d &size, istd::COptMemory &&data, int linesDifference=0) override
	Create bitmap with specified size and format using external image data buffer.

int	GetLinesDifference () const override
	Get address difference between next and previous line.

int	GetPixelsDifference () const override
	Get address difference between next and previous pixel.

int	GetPixelBitsCount () const override
	Get total number of bits per single pixel.

const void *	GetLinePtr (int positionY) const override
	Get pointer to buffer for single line.

void *	GetLinePtr (int positionY) override
	Get pointer to buffer for single line.

void	ResetImage () override
	Reset this image.

void	ClearImage () override
	Cleat this image.

istd::CIndex2d	GetImageSize () const override
	Get size of this raster image.

int	GetComponentsCount () const override
	Get number of color components.

icmm::CVarColor	GetColorAt (const istd::CIndex2d &position) const override
	Get color at specified pixel.

QByteArray	GetFactoryId () const override

int	GetSupportedOperations () const override
	Get set of flags for supported operations.

bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

Public Member Functions inherited from iimg::CBitmapBase
virtual bool	CreateImageFromRegion (const iimg::IBitmap &sourceBitmap, const i2d::CRect &region)

i2d::CVector2d	GetCenter () const override
	Returns center of this 2D-object.

void	MoveCenterTo (const i2d::CVector2d &position) override
	Move object to position `position`.

i2d::CRectangle	GetBoundingBox () const override
	Get bounding box of this shape.

int	GetLineBytesCount () const override
	Number of bytes per single line.

int	GetComponentBitsCount (int componentIndex=0) const override
	Get number of bits per single pixel component.

bool	IsEmpty () const override
	Return true if this image is empty.

icmm::CVarColor	GetColorAt (const istd::CIndex2d &position) const override
	Get color at specified pixel.

bool	SetColorAt (const istd::CIndex2d &position, const icmm::CVarColor &color) override
	Set color at specified pixel.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

Public Member Functions inherited from i2d::CObject2dBase
	CObject2dBase ()

	CObject2dBase (const CObject2dBase &object2d)

	CObject2dBase (CObject2dBase &&object2d)

const ICalibration2d *	GetCalibration () const override
	Get access to transformation object, which transforms a local logical coordinate system to global one.

void	SetCalibration (istd::TOptDelPtr< const ICalibration2d > &&calibrationPtr) override
	Set calibration of this object.

bool	Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Transform this object using some transformation.

bool	InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Do inverse transformation of this object.

bool	GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate transformation of the object into second one.

bool	GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate inverse transformation of the object into second one.

bool	CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

CObject2dBase &	operator= (const CObject2dBase &object2d)

CObject2dBase &	operator= (CObject2dBase &&object2d)

Public Member Functions inherited from i2d::IObject2d
Public Member Functions inherited from iser::IObject
Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from i2d::ICalibration2dProvider
Public Member Functions inherited from iimg::IBitmap
Public Member Functions inherited from iimg::IRasterImage
Public Member Functions inherited from iimg::IQImageProvider

Static Public Member Functions
static QByteArray	GetTypeName ()

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions
QImage::Format	CalcQtFormat (PixelFormat pixelFormat) const

PixelFormat	CalcFromQtFormat (QImage::Format imageFormat) const

bool	SetQImage (const QImage &image)

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Additional Inherited Members
Public Types inherited from iimg::CBitmapBase
typedef i2d::CObject2dBase	BaseClass

Public Types inherited from i2d::IObject2d
enum	ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Types inherited from iimg::IBitmap
enum	PixelFormat { PF_UNKNOWN = 0 , PF_MONO , PF_GRAY , PF_RGB , PF_RGBA , PF_RGB24 , PF_GRAY16 , PF_GRAY32 , PF_FLOAT32 , PF_FLOAT64 , PF_XYZ32 , PF_XY32 , PF_USER = 256 }
	Bitmap pixel format description. More...

Static Protected Attributes inherited from i2d::CObject2dBase
static const ChangeSet	s_objectMovedChange

static const ChangeSet	s_objectModifiedChange

Detailed Description

Bitmap implementation based on Qt QImage.

Definition at line 27 of file CBitmap.h.

Constructor & Destructor Documentation

◆ CBitmap() [1/3]

iimg::CBitmap::CBitmap ( )

◆ CBitmap() [2/3]

iimg::CBitmap::CBitmap ( const CBitmap & bitmap )

◆ CBitmap() [3/3]

iimg::CBitmap::CBitmap ( const QImage & image )

Member Function Documentation

◆ CalcFromQtFormat()

PixelFormat iimg::CBitmap::CalcFromQtFormat ( QImage::Format imageFormat ) const

protected

◆ CalcQtFormat()

QImage::Format iimg::CBitmap::CalcQtFormat ( PixelFormat pixelFormat ) const

protected

◆ ClearImage()

void iimg::CBitmap::ClearImage ( )

overridevirtual

Cleat this image.

After this operation all the image pixels will be set to the default value (black by default).

Implements iimg::IRasterImage.

◆ CloneMe()

std::unique_ptr< istd::IChangeable > iimg::CBitmap::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns: new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

Reimplemented in imod::TModelWrap< iimg::CBitmap >.

◆ CopyFrom()

bool iimg::CBitmap::CopyFrom	(	const istd::IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

Reimplemented in iser::TCopySerializedWrap< iimg::CBitmap >.

◆ CopyImageFrom()

bool iimg::CBitmap::CopyImageFrom ( const QImage & image )

overridevirtual

Copies the image data from a QImage object.

Parameters

image QImage object.

Returns: true if it succeeds, false if it fails.

Implements iimg::IQImageProvider.

◆ CreateBitmap() [1/2]

bool iimg::CBitmap::CreateBitmap	(	PixelFormat	pixelFormat,
		const istd::CIndex2d &	size,
		int	pixelBitsCount = 0,
		int	componentsCount = 0 )

overridevirtual

Create bitmap with specified size and format.

Parameters

pixelFormat bitmap format.

See also: PixelFormat

Parameters

size	bitmap size.
pixelBitsCount	bits per pixel. Default value `0` means that the number of bits per pixel is defined by format specification.
componentsCount	components per pixel. Default value `0` means that the number of bits per pixel is defined by format specification.

Implements iimg::IBitmap.

◆ CreateBitmap() [2/2]

bool iimg::CBitmap::CreateBitmap	(	PixelFormat	pixelFormat,
		const istd::CIndex2d &	size,
		istd::COptMemory &&	data,
		int	linesDifference = 0 )

overridevirtual

Create bitmap with specified size and format using external image data buffer.

Parameters

pixelFormat bitmap format.

See also: PixelFormat

Parameters

size	bitmap size.
data	external image buffer.
linesDifference	address difference between next and previos line. If it equals 0, the value will be taken from size and number of bits per pixel.

Implements iimg::IBitmap.

◆ GetColorAt()

icmm::CVarColor iimg::CBitmap::GetColorAt ( const istd::CIndex2d & position ) const

overridevirtual

Get color at specified pixel.

Parameters

position pixel position, must be inside of returned size.

Implements iimg::IRasterImage.

◆ GetComponentsCount()

int iimg::CBitmap::GetComponentsCount ( ) const

overridevirtual

Get number of color components.

Implements iimg::IRasterImage.

◆ GetFactoryId()

QByteArray iimg::CBitmap::GetFactoryId ( ) const

overridevirtual

Reimplemented from iser::IObject.

◆ GetImageSize()

istd::CIndex2d iimg::CBitmap::GetImageSize ( ) const

overridevirtual

Get size of this raster image.

Implements iimg::IRasterImage.

◆ GetLinePtr() [1/2]

const void * iimg::CBitmap::GetLinePtr ( int positionY ) const

overridevirtual

Get pointer to buffer for single line.

Parameters

positionY position Y. It must be smaller than bitmap size Y component.

Implements iimg::IBitmap.

◆ GetLinePtr() [2/2]

void * iimg::CBitmap::GetLinePtr ( int positionY )

overridevirtual

Get pointer to buffer for single line.

Parameters

positionY position Y. It must be smaller than bitmap size Y component.

Implements iimg::IBitmap.

◆ GetLinesDifference()

int iimg::CBitmap::GetLinesDifference ( ) const

overridevirtual

Get address difference between next and previous line.

Returns: address difference between next and previous line or 0, if it is not available.

Implements iimg::IBitmap.

◆ GetPixelBitsCount()

int iimg::CBitmap::GetPixelBitsCount ( ) const

overridevirtual

Get total number of bits per single pixel.

Implements iimg::IBitmap.

◆ GetPixelFormat()

PixelFormat iimg::CBitmap::GetPixelFormat ( ) const

overridevirtual

Get the bitmap's pixel format.

See also: PixelFormat

Implements iimg::IBitmap.

◆ GetPixelsDifference()

int iimg::CBitmap::GetPixelsDifference ( ) const

overridevirtual

Get address difference between next and previous pixel.

Implements iimg::IBitmap.

◆ GetQImage()

const QImage & iimg::CBitmap::GetQImage ( ) const

overridevirtual

Gets a QImage object.

Implements iimg::IQImageProvider.

◆ GetQImageRef()

QImage & iimg::CBitmap::GetQImageRef ( )

inline

Definition at line 88 of file CBitmap.h.

◆ GetSupportedOperations()

int iimg::CBitmap::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also: SupportedOperations

Reimplemented from istd::IChangeable.

Reimplemented in imod::TModelWrap< iimg::CBitmap >, and iser::TCopySerializedWrap< iimg::CBitmap >.

◆ GetTypeName()

static QByteArray iimg::CBitmap::GetTypeName ( )

static

◆ IsFormatSupported()

bool iimg::CBitmap::IsFormatSupported ( PixelFormat pixelFormat ) const

overridevirtual

Get true if the pixel format is supported by the bitmap implementation.

Parameters

pixelFormat bitmap format.

See also: PixelFormat

Implements iimg::IBitmap.

◆ ResetImage()

void iimg::CBitmap::ResetImage ( )

overridevirtual

Reset this image.

After this operation image is set to initial state.

Implements iimg::IRasterImage.

◆ SetQImage()

bool iimg::CBitmap::SetQImage ( const QImage & image )

protected

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

iimg/CBitmap.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CBitmap() [1/3]

◆ CBitmap() [2/3]

◆ CBitmap() [3/3]

Member Function Documentation

◆ CalcFromQtFormat()

◆ CalcQtFormat()

◆ ClearImage()

◆ CloneMe()

◆ CopyFrom()

◆ CopyImageFrom()

◆ CreateBitmap() [1/2]

◆ CreateBitmap() [2/2]

◆ GetColorAt()

◆ GetComponentsCount()

◆ GetFactoryId()

◆ GetImageSize()

◆ GetLinePtr() [1/2]

◆ GetLinePtr() [2/2]

◆ GetLinesDifference()

◆ GetPixelBitsCount()

◆ GetPixelFormat()

◆ GetPixelsDifference()

◆ GetQImage()

◆ GetQImageRef()

◆ GetSupportedOperations()

◆ GetTypeName()

◆ IsFormatSupported()

◆ ResetImage()

◆ SetQImage()