#include <kis_vline_iterator.h>

Inheritance diagram for KisVLineIterator2:

Classes
struct	KisTileInfo

Public Member Functions
	KisVLineIterator2 (KisDataManager dataManager, qint32 x, qint32 y, qint32 h, qint32 offsetX, qint32 offsetY, bool writable, KisIteratorCompleteListener completeListener)

qint32	nConseqPixels () const override

void	nextColumn () override

bool	nextPixel () override

bool	nextPixels (qint32 n) override

const quint8 *	oldRawData () const override

quint8 *	rawData () override

const quint8 *	rawDataConst () const override

void	resetColumnPos () override

void	resetPixelPos () override

qint32	x () const override

qint32	y () const override

	~KisVLineIterator2 () override

Public Member Functions inherited from KisVLineIteratorNG
	KisVLineIteratorNG ()

	~KisVLineIteratorNG () override

Public Member Functions inherited from KisVLineConstIteratorNG
	KisVLineConstIteratorNG ()

	~KisVLineConstIteratorNG () override

Public Member Functions inherited from KisBaseConstIteratorNG
	KisBaseConstIteratorNG ()

	~KisBaseConstIteratorNG () override

Public Member Functions inherited from KisBaseConstAccessor
	KisBaseConstAccessor ()

virtual	~KisBaseConstAccessor ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Public Member Functions inherited from KisBaseAccessor
	KisBaseAccessor ()

virtual	~KisBaseAccessor ()

Private Member Functions
void	fetchTileDataForCache (KisTileInfo &kti, qint32 col, qint32 row)

	KisVLineIterator2 (const KisVLineIterator2 &)

KisVLineIterator2 &	operator= (const KisVLineIterator2 &)

void	preallocateTiles ()

void	switchToTile (qint32 xInTile)

Private Member Functions inherited from KisBaseIterator
qint32	calcXInTile (qint32 x, qint32 col) const

qint32	calcYInTile (qint32 y, qint32 row) const

	KisBaseIterator (KisTiledDataManager _dataManager, bool _writable, KisIteratorCompleteListener listener)

void	lockOldTile (KisTileSP &tile)

void	lockTile (KisTileSP &tile)

void	unlockOldTile (KisTileSP &tile)

void	unlockTile (KisTileSP &tile)

quint32	xToCol (quint32 x) const

quint32	yToRow (quint32 y) const

	~KisBaseIterator ()

Private Attributes
qint32	m_bottom {0}

qint32	m_bottomRow {0}

qint32	m_column {0}

quint8 *	m_data {nullptr}

quint8 *	m_dataBottom {nullptr}

bool	m_havePixels {false}

qint32	m_index {0}

qint32	m_left {0}

qint32	m_lineStride {0}

qint32	m_offsetX {0}

qint32	m_offsetY {0}

quint8 *	m_oldData {nullptr}

QVector< KisTileInfo >	m_tilesCache

qint32	m_tilesCacheSize {0}

qint32	m_tileSize {0}

qint32	m_top {0}

qint32	m_topInTopmostTile {0}

qint32	m_topRow {0}

qint32	m_x {0}

qint32	m_xInTile {0}

qint32	m_y {0}

Private Attributes inherited from KisBaseIterator
KisTiledDataManager *	m_dataManager

qint32	m_pixelSize

bool	m_writable

Additional Inherited Members
Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Detailed Description

Definition at line 15 of file kis_vline_iterator.h.

Constructor & Destructor Documentation

◆ KisVLineIterator2() [1/2]

KisVLineIterator2::KisVLineIterator2 ( const KisVLineIterator2 & )

private

◆ KisVLineIterator2() [2/2]

KisVLineIterator2::KisVLineIterator2	(	KisDataManager *	dataManager,
		qint32	x,
		qint32	y,
		qint32	h,
		qint32	offsetX,
		qint32	offsetY,
		bool	writable,
		KisIteratorCompleteListener *	completeListener )

Definition at line 12 of file kis_vline_iterator.cpp.

    : KisBaseIterator(dataManager, writable, completeListener),
      m_offsetX(offsetX),
      m_offsetY(offsetY)
{
    x -= m_offsetX;
    y -= m_offsetY;
    Q_ASSERT(dataManager != 0);
 
    Q_ASSERT(h > 0); // for us, to warn us when abusing the iterators
    if (h < 1) h = 1;  // for release mode, to make sure there's always at least one pixel read.
 
    m_lineStride = m_pixelSize * KisTileData::WIDTH;
 
    m_x = x;
    m_y = y;
 
    m_top = y;
    m_bottom = y + h - 1;
 
    m_left = m_x;
 
    m_havePixels = (h == 0) ? false : true;
    if (m_top > m_bottom) {
        m_havePixels = false;
        return;
    }
 
    m_topRow = yToRow(m_top);
    m_bottomRow = yToRow(m_bottom);
 
    m_column = xToCol(m_x);
    m_xInTile = calcXInTile(m_x, m_column);
 
    m_topInTopmostTile = m_top - m_topRow * KisTileData::WIDTH;
 
    m_tilesCacheSize = m_bottomRow - m_topRow + 1;
    m_tilesCache.resize(m_tilesCacheSize);
 
    m_tileSize = m_lineStride * KisTileData::HEIGHT;
 
    // let's preallocate first row
    for (int i = 0; i < m_tilesCacheSize; i++){
        fetchTileDataForCache(m_tilesCache[i], m_column, m_topRow + i);
    }
    m_index = 0;
    switchToTile(m_topInTopmostTile);
}

References KisBaseIterator::calcXInTile(), fetchTileDataForCache(), KisTileData::HEIGHT, m_bottom, m_bottomRow, m_column, m_havePixels, m_index, m_left, m_lineStride, m_offsetX, m_offsetY, KisBaseIterator::m_pixelSize, m_tilesCache, m_tilesCacheSize, m_tileSize, m_top, m_topInTopmostTile, m_topRow, m_x, m_xInTile, m_y, switchToTile(), KisTileData::WIDTH, x(), KisBaseIterator::xToCol(), y(), and KisBaseIterator::yToRow().

◆ ~KisVLineIterator2()

KisVLineIterator2::~KisVLineIterator2 ( )

override

Definition at line 152 of file kis_vline_iterator.cpp.

{
    for (int i = 0; i < m_tilesCacheSize; i++) {
        unlockTile(m_tilesCache[i].tile);
        unlockOldTile(m_tilesCache[i].oldtile);
    }
}

References m_tilesCache, m_tilesCacheSize, KisBaseIterator::unlockOldTile(), and KisBaseIterator::unlockTile().

Member Function Documentation

◆ fetchTileDataForCache()

void KisVLineIterator2::fetchTileDataForCache	(	KisTileInfo &	kti,
		qint32	col,
		qint32	row )

private

Definition at line 194 of file kis_vline_iterator.cpp.

{
    m_dataManager->getTilesPair(col, row, m_writable, &kti.tile, &kti.oldtile);
 
    lockTile(kti.tile);
    kti.data = kti.tile->data();
 
    lockOldTile(kti.oldtile);
    kti.oldData = kti.oldtile->data();
}

References KisTile::data(), KisVLineIterator2::KisTileInfo::data, KisTiledDataManager::getTilesPair(), KisBaseIterator::lockOldTile(), KisBaseIterator::lockTile(), KisBaseIterator::m_dataManager, KisBaseIterator::m_writable, KisVLineIterator2::KisTileInfo::oldData, KisVLineIterator2::KisTileInfo::oldtile, and KisVLineIterator2::KisTileInfo::tile.

◆ nConseqPixels()

qint32 KisVLineIterator2::nConseqPixels ( ) const

overridevirtual

Returns: return number of consequential numbers of pixels, useful for optimization

Implements KisBaseConstIteratorNG.

Definition at line 123 of file kis_vline_iterator.cpp.

{
    return 1;
}

◆ nextColumn()

void KisVLineIterator2::nextColumn ( )

overridevirtual

Move to the next row

Implements KisVLineConstIteratorNG.

Definition at line 104 of file kis_vline_iterator.cpp.

{
    m_y = m_top;
    ++m_x;
 
    if (++m_xInTile < KisTileData::HEIGHT) {
        /* do nothing, usual case */
    } else {
        ++m_column;
        m_xInTile = 0;
        preallocateTiles();
    }
    m_index = 0;
    switchToTile(m_topInTopmostTile);
 
    m_havePixels = true;
}

References KisTileData::HEIGHT, m_column, m_havePixels, m_index, m_top, m_topInTopmostTile, m_x, m_xInTile, m_y, preallocateTiles(), and switchToTile().

◆ nextPixel()

bool KisVLineIterator2::nextPixel ( )

overridevirtual

Move to the next pixel

Returns: false if there is no more pixel in the line

Implements KisBaseConstIteratorNG.

Definition at line 82 of file kis_vline_iterator.cpp.

{
    // We won't increment m_x here as integer can overflow here
    if (m_y >= m_bottom) {
        //return !m_isDoneFlag;
        return m_havePixels = false;
    } else {
        ++m_y;
        m_data += m_lineStride;
        if (m_data < m_dataBottom)
            m_oldData += m_lineStride;
        else {
            // Switching to the beginning of the next tile
            ++m_index;
            switchToTile(0);
        }
    }
 
    return m_havePixels;
}

References m_bottom, m_data, m_dataBottom, m_havePixels, m_index, m_lineStride, m_oldData, m_y, and switchToTile().

◆ nextPixels()

bool KisVLineIterator2::nextPixels ( qint32 n )

overridevirtual

Move to the next pixels

Implements KisBaseConstIteratorNG.

Definition at line 128 of file kis_vline_iterator.cpp.

{
    Q_ASSERT_X(!(m_y > 0 && (m_y + n) < 0), "vlineIt+=", "Integer overflow");
 
    qint32 previousRow = yToRow(m_y);
    // We won't increment m_x here first as integer can overflow
    if (m_y >= m_bottom || (m_y += n) > m_bottom) {
        m_havePixels = false;
    } else {
        qint32 row = yToRow(m_y);
        // if we are in the same column in tiles
        if (row == previousRow) {
            m_data += n * m_pixelSize;
        } else {
            qint32 yInTile = calcYInTile(m_y, row);
            m_index += row - previousRow;
            switchToTile(yInTile);
        }
    }
    return m_havePixels;
}

References KisBaseIterator::calcYInTile(), m_bottom, m_data, m_havePixels, m_index, KisBaseIterator::m_pixelSize, m_y, switchToTile(), and KisBaseIterator::yToRow().

◆ oldRawData()

const quint8 * KisVLineIterator2::oldRawData ( ) const

overridevirtual

Returns: a pointer to the pixel data as it was at the moment of the last memento creation.

Implements KisBaseConstAccessor.

Definition at line 167 of file kis_vline_iterator.cpp.

{
    return m_oldData;
}

References m_oldData.

◆ operator=()

KisVLineIterator2 & KisVLineIterator2::operator= ( const KisVLineIterator2 & )

private

◆ preallocateTiles()

void KisVLineIterator2::preallocateTiles ( )

private

Definition at line 205 of file kis_vline_iterator.cpp.

{
    for (int i = 0; i < m_tilesCacheSize; ++i){
        unlockTile(m_tilesCache[i].tile);
        unlockOldTile(m_tilesCache[i].oldtile);
        fetchTileDataForCache(m_tilesCache[i], m_column, m_topRow + i );
    }
}

References fetchTileDataForCache(), m_column, m_tilesCache, m_tilesCacheSize, m_topRow, KisBaseIterator::unlockOldTile(), and KisBaseIterator::unlockTile().

◆ rawData()

quint8 * KisVLineIterator2::rawData ( )

overridevirtual

Returns: a pointer to the pixel data. Do NOT interpret the data - leave that to a colorspace

Implements KisBaseAccessor.

Definition at line 161 of file kis_vline_iterator.cpp.

{
    return m_data;
}

References m_data.

◆ rawDataConst()

const quint8 * KisVLineIterator2::rawDataConst ( ) const

overridevirtual

Returns: a pointer to the most actual pixel data, this points to the same data as rawData() method of a writable accessor.

Implements KisBaseConstAccessor.

Definition at line 172 of file kis_vline_iterator.cpp.

{
    return m_data;
}

References m_data.

◆ resetColumnPos()

void KisVLineIterator2::resetColumnPos ( )

overridevirtual

Implements KisVLineConstIteratorNG.

Definition at line 71 of file kis_vline_iterator.cpp.

{
    m_x = m_left;
 
    m_column = xToCol(m_x);
    m_xInTile = calcXInTile(m_x, m_column);
    preallocateTiles();
 
    resetPixelPos();
}

References KisBaseIterator::calcXInTile(), m_column, m_left, m_x, m_xInTile, preallocateTiles(), resetPixelPos(), and KisBaseIterator::xToCol().

◆ resetPixelPos()

void KisVLineIterator2::resetPixelPos ( )

overridevirtual

Implements KisVLineConstIteratorNG.

Definition at line 61 of file kis_vline_iterator.cpp.

{
    m_y = m_top;
 
    m_index = 0;
    switchToTile(m_topInTopmostTile);
 
    m_havePixels = true;
}

References m_havePixels, m_index, m_top, m_topInTopmostTile, m_y, and switchToTile().

◆ switchToTile()

void KisVLineIterator2::switchToTile ( qint32 xInTile )

private

Definition at line 177 of file kis_vline_iterator.cpp.

{
    // The caller must ensure that we are not out of bounds
    Q_ASSERT(m_index < m_tilesCacheSize);
    Q_ASSERT(m_index >= 0);
 
    int offset_row = m_pixelSize * m_xInTile;
    m_data = m_tilesCache[m_index].data;
    m_oldData = m_tilesCache[m_index].oldData;
    m_data += offset_row;
    m_dataBottom = m_data + m_tileSize;
    int offset_col = m_pixelSize * yInTile * KisTileData::WIDTH;
    m_data  += offset_col;
    m_oldData += offset_row + offset_col;
}

References m_data, m_dataBottom, m_index, m_oldData, KisBaseIterator::m_pixelSize, m_tilesCache, m_tilesCacheSize, m_tileSize, m_xInTile, and KisTileData::WIDTH.

◆ x()

qint32 KisVLineIterator2::x ( ) const

overridevirtual

Implements KisBaseConstAccessor.

Definition at line 214 of file kis_vline_iterator.cpp.

{
    return m_x + m_offsetX;
}

References m_offsetX, and m_x.

◆ y()

qint32 KisVLineIterator2::y ( ) const

overridevirtual

Implements KisBaseConstAccessor.

Definition at line 219 of file kis_vline_iterator.cpp.

{
    return m_y + m_offsetY;
}

References m_offsetY, and m_y.

Member Data Documentation

◆ m_bottom

qint32 KisVLineIterator2::m_bottom {0}

private

Definition at line 60 of file kis_vline_iterator.h.

60{0};

◆ m_bottomRow

qint32 KisVLineIterator2::m_bottomRow {0}

private

Definition at line 63 of file kis_vline_iterator.h.

63{0};

◆ m_column

qint32 KisVLineIterator2::m_column {0}

private

Definition at line 51 of file kis_vline_iterator.h.

51{0}; // current column in tilemgr

◆ m_data

quint8* KisVLineIterator2::m_data {nullptr}

private

Definition at line 54 of file kis_vline_iterator.h.

54{nullptr};

◆ m_dataBottom

quint8* KisVLineIterator2::m_dataBottom {nullptr}

private

Definition at line 55 of file kis_vline_iterator.h.

55{nullptr};

◆ m_havePixels

bool KisVLineIterator2::m_havePixels {false}

private

Definition at line 57 of file kis_vline_iterator.h.

57{false};

◆ m_index

qint32 KisVLineIterator2::m_index {0}

private

Definition at line 52 of file kis_vline_iterator.h.

52{0}; // current row in tilemgr

◆ m_left

qint32 KisVLineIterator2::m_left {0}

private

Definition at line 61 of file kis_vline_iterator.h.

61{0};

◆ m_lineStride

qint32 KisVLineIterator2::m_lineStride {0}

private

Definition at line 67 of file kis_vline_iterator.h.

67{0};

◆ m_offsetX

qint32 KisVLineIterator2::m_offsetX {0}

private

Definition at line 46 of file kis_vline_iterator.h.

46{0};

◆ m_offsetY

qint32 KisVLineIterator2::m_offsetY {0}

private

Definition at line 47 of file kis_vline_iterator.h.

47{0};

◆ m_oldData

quint8* KisVLineIterator2::m_oldData {nullptr}

private

Definition at line 56 of file kis_vline_iterator.h.

56{nullptr};

◆ m_tilesCache

QVector<KisTileInfo> KisVLineIterator2::m_tilesCache

private

Definition at line 69 of file kis_vline_iterator.h.

◆ m_tilesCacheSize

qint32 KisVLineIterator2::m_tilesCacheSize {0}

private

Definition at line 70 of file kis_vline_iterator.h.

70{0};

◆ m_tileSize

qint32 KisVLineIterator2::m_tileSize {0}

private

Definition at line 53 of file kis_vline_iterator.h.

53{0};

◆ m_top

qint32 KisVLineIterator2::m_top {0}

private

Definition at line 59 of file kis_vline_iterator.h.

59{0};

◆ m_topInTopmostTile

qint32 KisVLineIterator2::m_topInTopmostTile {0}

private

Definition at line 65 of file kis_vline_iterator.h.

65{0};

◆ m_topRow

qint32 KisVLineIterator2::m_topRow {0}

private

Definition at line 62 of file kis_vline_iterator.h.

62{0};

◆ m_x

qint32 KisVLineIterator2::m_x {0}

private

Definition at line 49 of file kis_vline_iterator.h.

49{0}; // current x position

◆ m_xInTile

qint32 KisVLineIterator2::m_xInTile {0}

private

Definition at line 66 of file kis_vline_iterator.h.

66{0};

◆ m_y

qint32 KisVLineIterator2::m_y {0}

private

Definition at line 50 of file kis_vline_iterator.h.

50{0}; // current y position

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

libs/image/tiles3/kis_vline_iterator.h
libs/image/tiles3/kis_vline_iterator.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisVLineIterator2() [1/2]

◆ KisVLineIterator2() [2/2]

◆ ~KisVLineIterator2()

Member Function Documentation

◆ fetchTileDataForCache()

◆ nConseqPixels()

◆ nextColumn()

◆ nextPixel()

◆ nextPixels()

◆ oldRawData()

◆ operator=()

◆ preallocateTiles()

◆ rawData()

◆ rawDataConst()

◆ resetColumnPos()

◆ resetPixelPos()

◆ switchToTile()

◆ x()

◆ y()

Member Data Documentation

◆ m_bottom

◆ m_bottomRow

◆ m_column

◆ m_data

◆ m_dataBottom

◆ m_havePixels

◆ m_index

◆ m_left

◆ m_lineStride

◆ m_offsetX

◆ m_offsetY

◆ m_oldData

◆ m_tilesCache

◆ m_tilesCacheSize

◆ m_tileSize

◆ m_top

◆ m_topInTopmostTile

◆ m_topRow

◆ m_x

◆ m_xInTile

◆ m_y