KisPaintDeviceFramesInterface Class Reference

#include <kis_paint_device_frames_interface.h>

Classes
struct	TestingDataObjects

Public Member Functions
int	createFrame (bool copy, int copySrc, const QPoint &offset, KUndo2Command *parentCommand)
int	currentFrameId () const
void	deleteFrame (int frame, KUndo2Command *parentCommand)
QRect	frameBounds (int frameId)
KisDataManagerSP	frameDataManager (int frameId) const
KoColor	frameDefaultPixel (int frameId) const
QPoint	frameOffset (int frameId) const
QList< int >	frames ()
void	invalidateFrameCache (int frameId)
	KisPaintDeviceFramesInterface (KisPaintDevice *parentDevice)
bool	readFrame (QIODevice *stream, int frameId)
void	setFrameDefaultPixel (const KoColor &defPixel, int frameId)
void	setFrameOffset (int frameId, const QPoint &offset)
TestingDataObjects	testingGetDataObjects () const
QList< KisPaintDeviceData * >	testingGetDataObjectsList () const
void	uploadFrame (int dstFrameId, KisPaintDeviceSP srcDevice)
void	uploadFrame (int srcFrameId, int dstFrameId, KisPaintDeviceSP srcDevice)
bool	writeFrame (KisPaintDeviceWriter &store, int frameId)
void	writeFrameToDevice (int frameId, KisPaintDeviceSP targetDevice)

Private Attributes
KisPaintDevice *	q

Detailed Description

Definition at line 22 of file kis_paint_device_frames_interface.h.

Constructor & Destructor Documentation

KisPaintDeviceFramesInterface()

KisPaintDeviceFramesInterface::KisPaintDeviceFramesInterface

(

KisPaintDevice *

parentDevice

)

Definition at line 2221 of file kis_paint_device.cc.

    : q(parentDevice)
{
}

Member Function Documentation

createFrame()

int KisPaintDeviceFramesInterface::createFrame	(	bool	copy,
		int	copySrc,
		const QPoint &	offset,
		KUndo2Command *	parentCommand )

Creates a new frame on the device and returns an identifier for it.

Returns

frame id of the newly created frame

Definition at line 2231 of file kis_paint_device.cc.

{
    return q->m_d->createFrame(copy, copySrc, offset, parentCommand);
}

References KisPaintDevice::Private::createFrame(), KisPaintDevice::m_d, and q.

currentFrameId()

int KisPaintDeviceFramesInterface::currentFrameId

(

)

const

Returns frameId of the currently active frame. Should be used by Undo framework only!

Definition at line 2296 of file kis_paint_device.cc.

{
    return q->m_d->currentFrameId();
}

References KisPaintDevice::Private::currentFrameId(), KisPaintDevice::m_d, and q.

deleteFrame()

void KisPaintDeviceFramesInterface::deleteFrame	(	int	frame,
		KUndo2Command *	parentCommand )

Delete the frame with given id

Parameters

frame	frame ID
parentCommand	parent command

Definition at line 2236 of file kis_paint_device.cc.

{
    return q->m_d->deleteFrame(frame, parentCommand);
}

References KisPaintDevice::Private::deleteFrame(), KisPaintDevice::m_d, and q.

frameBounds()

QRect KisPaintDeviceFramesInterface::frameBounds

(

int

frameId

)

Returns

extent() of frameId

Definition at line 2256 of file kis_paint_device.cc.

{
    return q->m_d->frameBounds(frameId);
}

References KisPaintDevice::Private::frameBounds(), KisPaintDevice::m_d, and q.

frameDataManager()

KisDataManagerSP KisPaintDeviceFramesInterface::frameDataManager

(

int

frameId

)

const

Returns the data manager of the specified frame. Should be used by Undo framework only!

Definition at line 2301 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER(frameId >= 0) {
        return q->m_d->dataManager();
    }
    return q->m_d->frameDataManager(frameId);
}

References KisPaintDevice::Private::dataManager(), KisPaintDevice::Private::frameDataManager(), KIS_ASSERT_RECOVER, KisPaintDevice::m_d, and q.

frameDefaultPixel()

KoColor KisPaintDeviceFramesInterface::frameDefaultPixel

(

int

frameId

)

const

Returns

default pixel for frameId

Definition at line 2272 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER(frameId >= 0) {
        return KoColor(Qt::red, q->m_d->colorSpace());
    }
    return q->m_d->frameDefaultPixel(frameId);
}

References KisPaintDevice::Private::colorSpace(), KisPaintDevice::Private::frameDefaultPixel(), KIS_ASSERT_RECOVER, KisPaintDevice::m_d, and q.

frameOffset()

QPoint KisPaintDeviceFramesInterface::frameOffset

(

int

frameId

)

const

Returns

offset of a data on frameId

Definition at line 2261 of file kis_paint_device.cc.

{
    return q->m_d->frameOffset(frameId);
}

References KisPaintDevice::Private::frameOffset(), KisPaintDevice::m_d, and q.

frames()

QList< int > KisPaintDeviceFramesInterface::frames

(

)

Return a list of IDs for the frames contained in this paint device

Returns

list of frame IDs

Definition at line 2226 of file kis_paint_device.cc.

{
    return q->m_d->frameIds();
}

References KisPaintDevice::Private::frameIds(), KisPaintDevice::m_d, and q.

invalidateFrameCache()

void KisPaintDeviceFramesInterface::invalidateFrameCache

(

int

frameId

)

Resets the cache object associated with the frame. Should be used by Undo framework only!

Definition at line 2309 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER_RETURN(frameId >= 0);
 
    return q->m_d->invalidateFrameCache(frameId);
}

References KisPaintDevice::Private::invalidateFrameCache(), KIS_ASSERT_RECOVER_RETURN, KisPaintDevice::m_d, and q.

readFrame()

bool KisPaintDeviceFramesInterface::readFrame	(	QIODevice *	stream,
		int	frameId )

Loads content of a frameId from stream.

NOTE: the frame must be created manually with createFrame() beforehand!

Definition at line 2288 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER(frameId >= 0) {
        return false;
    }
    return q->m_d->readFrame(stream, frameId);
}

References KIS_ASSERT_RECOVER, KisPaintDevice::m_d, q, and KisPaintDevice::Private::readFrame().

setFrameDefaultPixel()

void KisPaintDeviceFramesInterface::setFrameDefaultPixel	(	const KoColor &	defPixel,
		int	frameId )

Sets default pixel for frameId

Definition at line 2266 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER_RETURN(frameId >= 0);
    q->m_d->setFrameDefaultPixel(defPixel, frameId);
}

References KIS_ASSERT_RECOVER_RETURN, KisPaintDevice::m_d, q, and KisPaintDevice::Private::setFrameDefaultPixel().

setFrameOffset()

void KisPaintDeviceFramesInterface::setFrameOffset	(	int	frameId,
		const QPoint &	offset )

Sets the offset for frameId. Should be used by Undo framework only!

Definition at line 2316 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER_RETURN(frameId >= 0);
    return q->m_d->setFrameOffset(frameId, offset);
}

References KIS_ASSERT_RECOVER_RETURN, KisPaintDevice::m_d, q, and KisPaintDevice::Private::setFrameOffset().

testingGetDataObjects()

KisPaintDeviceFramesInterface::TestingDataObjects KisPaintDeviceFramesInterface::testingGetDataObjects

(

)

const

Definition at line 2323 of file kis_paint_device.cc.

{
    TestingDataObjects objects;
 
    objects.m_data = q->m_d->m_data.data();
    objects.m_lodData = q->m_d->m_lodData.data();
    objects.m_externalFrameData = q->m_d->m_externalFrameData.data();
 
    typedef KisPaintDevice::Private::FramesHash FramesHash;
 
    FramesHash::const_iterator it = q->m_d->m_frames.constBegin();
    FramesHash::const_iterator end = q->m_d->m_frames.constEnd();
 
    for (; it != end; ++it) {
        objects.m_frames.insert(it.key(), it.value().data());
    }
 
    objects.m_currentData = q->m_d->currentData();
 
    return objects;
}

References KisPaintDevice::Private::currentData(), KisPaintDeviceFramesInterface::TestingDataObjects::m_currentData, KisPaintDevice::m_d, KisPaintDevice::Private::m_data, KisPaintDeviceFramesInterface::TestingDataObjects::m_data, KisPaintDevice::Private::m_externalFrameData, KisPaintDeviceFramesInterface::TestingDataObjects::m_externalFrameData, KisPaintDevice::Private::m_frames, KisPaintDeviceFramesInterface::TestingDataObjects::m_frames, KisPaintDevice::Private::m_lodData, KisPaintDeviceFramesInterface::TestingDataObjects::m_lodData, and q.

testingGetDataObjectsList()

QList< KisPaintDeviceData * > KisPaintDeviceFramesInterface::testingGetDataObjectsList

(

)

const

Definition at line 2345 of file kis_paint_device.cc.

{
    return q->m_d->allDataObjects();
}

References KisPaintDevice::Private::allDataObjects(), KisPaintDevice::m_d, and q.

uploadFrame() [1/2]

void KisPaintDeviceFramesInterface::uploadFrame	(	int	dstFrameId,
		KisPaintDeviceSP	srcDevice )

Copy the given paint device contents into the specified frame

Parameters

dstFrameId	ID of the frame to be overwritten (must exist)
srcDevice	paint device to copy from

Definition at line 2251 of file kis_paint_device.cc.

{
    q->m_d->uploadFrame(dstFrameId, srcDevice);
}

References KisPaintDevice::m_d, q, and KisPaintDevice::Private::uploadFrame().

uploadFrame() [2/2]

void KisPaintDeviceFramesInterface::uploadFrame	(	int	srcFrameId,
		int	dstFrameId,
		KisPaintDeviceSP	srcDevice )

Copy the given paint device contents into the specified frame

Parameters

srcFrameId	ID of the frame to copy from (must exist)
dstFrameId	ID of the frame to be overwritten (must exist)
srcDevice	paint device to copy from

Definition at line 2246 of file kis_paint_device.cc.

{
    q->m_d->uploadFrame(srcFrameId, dstFrameId, srcDevice);
}

References KisPaintDevice::m_d, q, and KisPaintDevice::Private::uploadFrame().

writeFrame()

bool KisPaintDeviceFramesInterface::writeFrame	(	KisPaintDeviceWriter &	store,
		int	frameId )

Write a frameId onto store

Definition at line 2280 of file kis_paint_device.cc.

{
    KIS_ASSERT_RECOVER(frameId >= 0) {
        return false;
    }
    return q->m_d->writeFrame(store, frameId);
}

References KIS_ASSERT_RECOVER, KisPaintDevice::m_d, q, and KisPaintDevice::Private::writeFrame().

writeFrameToDevice()

void KisPaintDeviceFramesInterface::writeFrameToDevice	(	int	frameId,
		KisPaintDeviceSP	targetDevice )

Copy the given frame into the target device

Parameters

frameId	ID of the frame to be copied
targetDevice	paint device to copy to

Definition at line 2241 of file kis_paint_device.cc.

{
    q->m_d->writeFrameToDevice(frameId, targetDevice);
}

References KisPaintDevice::m_d, q, and KisPaintDevice::Private::writeFrameToDevice().

Member Data Documentation

q

KisPaintDevice* KisPaintDeviceFramesInterface::q

private

Definition at line 143 of file kis_paint_device_frames_interface.h.

---

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

• libs/image/kis_paint_device_frames_interface.h
• libs/image/kis_paint_device.cc