KisTileDataWrapper Class Reference

#include <kis_tile_data_wrapper.h>

Public Types
enum	accessType { READ , WRITE }

Public Member Functions
quint8 *	data () const
	KisTileDataWrapper (KisTiledDataManager *dm, qint32 x, qint32 y, enum KisTileDataWrapper::accessType type)
qint32	offset () const
KisTileSP &	tile ()
virtual	~KisTileDataWrapper ()

Private Attributes
qint32	m_offset
KisTileSP	m_tile
KisTileDataWrapper::accessType	m_type

Detailed Description

KisTileDataWrapper is a special object, that fetches the tile from the data manager according to the position, locks it and returns a pointer to the needed piece of data

Definition at line 16 of file kis_tile_data_wrapper.h.

Member Enumeration Documentation

accessType

enum KisTileDataWrapper::accessType

Enumerator
READ
WRITE

Definition at line 19 of file kis_tile_data_wrapper.h.

                    {
        READ,
        WRITE
    };

Constructor & Destructor Documentation

KisTileDataWrapper()

KisTileDataWrapper::KisTileDataWrapper ( KisTiledDataManager * dm, qint32 x, qint32 y, enum KisTileDataWrapper::accessType type )

inline

Fetches the tile which contains point (x, y) from the data manager dm with access type

Definition at line 28 of file kis_tile_data_wrapper.h.

    {
        const qint32 col = dm->xToCol(x);
        const qint32 row = dm->yToRow(y);
 
        /* FIXME: Always positive? */
        const qint32 xInTile = x - col * KisTileData::WIDTH;
        const qint32 yInTile = y - row * KisTileData::HEIGHT;
 
        const qint32 pixelIndex = xInTile + yInTile * KisTileData::WIDTH;
 
        KisTileSP tile = dm->getTile(col, row, type == WRITE);
 
        m_tile = tile;
        m_offset = pixelIndex * dm->pixelSize();
 
        if (type == READ) {
            m_tile->lockForRead();
        }
        else {
            m_tile->lockForWrite();
        }
 
        m_type = type;
    }

References KisTiledDataManager::getTile(), KisTileData::HEIGHT, KisTile::lockForRead(), KisTile::lockForWrite(), m_offset, m_tile, m_type, KisTiledDataManager::pixelSize(), READ, tile(), KisTileData::WIDTH, WRITE, KisTiledDataManager::xToCol(), and KisTiledDataManager::yToRow().

~KisTileDataWrapper()

virtual KisTileDataWrapper::~KisTileDataWrapper ( )

inlinevirtual

Definition at line 56 of file kis_tile_data_wrapper.h.

    {
        if (m_type == READ) {
            m_tile->unlockForRead();
        } else {
            m_tile->unlockForWrite();
        }
    }

References m_tile, m_type, READ, KisTile::unlockForRead(), and KisTile::unlockForWrite().

Member Function Documentation

data()

quint8 * KisTileDataWrapper::data ( ) const

inline

Returns the pointer to the pixel, that was passed to the constructor. This points to the raw data of the tile, so you should think about the borders of the tile yourself. When (x,y) is the top-left corner of the tile, the pointer will lead to the beginning of the tile's chunk of memory.

Definition at line 90 of file kis_tile_data_wrapper.h.

    {
        return m_tile->data() + m_offset;
    }

References KisTile::data(), m_offset, and m_tile.

offset()

qint32 KisTileDataWrapper::offset ( ) const

inline

Returns the offset of the data in the tile's chunk of memory

See also

data()

Definition at line 70 of file kis_tile_data_wrapper.h.

    {
        return m_offset;
    }

References m_offset.

tile()

KisTileSP & KisTileDataWrapper::tile ( )

inline

Returns the fetched tile

Definition at line 78 of file kis_tile_data_wrapper.h.

    {
        return m_tile;
    }

References m_tile.

Member Data Documentation

m_offset

qint32 KisTileDataWrapper::m_offset

private

Definition at line 99 of file kis_tile_data_wrapper.h.

m_tile

KisTileSP KisTileDataWrapper::m_tile

private

Definition at line 98 of file kis_tile_data_wrapper.h.

m_type

KisTileDataWrapper::accessType KisTileDataWrapper::m_type

private

Definition at line 100 of file kis_tile_data_wrapper.h.

---

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

• libs/image/tiles3/kis_tile_data_wrapper.h