KisInterstrokeData Class Reference

#include <KisInterstrokeData.h>

Inheritance diagram for KisInterstrokeData:

Public Member Functions
virtual void	beginTransaction ()=0
virtual KUndo2Command *	endTransaction ()=0
bool	isStillCompatible () const
	KisInterstrokeData (KisPaintDeviceSP device)
virtual	~KisInterstrokeData ()

Private Attributes
const KoColorSpace *	m_linkedColorSpace = 0
QPoint	m_linkedDeviceOffset
KisPaintDeviceWSP	m_linkedPaintDevice

Detailed Description

A special base class for storing temporary data inside a paint device between brush strokes. That might be used by the brushes to store data that needs to be passes between different strokes of the same brush, e.g. paint drying or heightmap information.

The data is stored inside device->interstrokeData() and added via passing a factory to the transaction.

The data is automatically removed when an incompatible change happens to a device, e.g. colorspace change or painting with incompatible brush.

Definition at line 31 of file KisInterstrokeData.h.

Constructor & Destructor Documentation

KisInterstrokeData()

KisInterstrokeData::KisInterstrokeData

(

KisPaintDeviceSP

device

)

Definition at line 12 of file KisInterstrokeData.cpp.

    : m_linkedDeviceOffset(device->offset())
    , m_linkedColorSpace(device->colorSpace())
    , m_linkedPaintDevice(device)
{
 
}

~KisInterstrokeData()

KisInterstrokeData::~KisInterstrokeData ( )

virtual

Definition at line 20 of file KisInterstrokeData.cpp.

{
}

Member Function Documentation

beginTransaction()

virtual void KisInterstrokeData::beginTransaction ( )

pure virtual

Implemented in KisColorSmudgeInterstrokeData.

endTransaction()

virtual KUndo2Command * KisInterstrokeData::endTransaction ( )

pure virtual

Implemented in KisColorSmudgeInterstrokeData.

isStillCompatible()

bool KisInterstrokeData::isStillCompatible

(

)

const

Definition at line 24 of file KisInterstrokeData.cpp.

{
    KIS_ASSERT_RECOVER_RETURN_VALUE(m_linkedPaintDevice, false);
 
    return m_linkedDeviceOffset == m_linkedPaintDevice->offset() &&
        *m_linkedColorSpace == *m_linkedPaintDevice->colorSpace();
}

References KisPaintDevice::colorSpace(), KIS_ASSERT_RECOVER_RETURN_VALUE, m_linkedColorSpace, m_linkedDeviceOffset, m_linkedPaintDevice, and KisPaintDevice::offset().

Member Data Documentation

m_linkedColorSpace

const KoColorSpace* KisInterstrokeData::m_linkedColorSpace = 0

private

Definition at line 44 of file KisInterstrokeData.h.

m_linkedDeviceOffset

QPoint KisInterstrokeData::m_linkedDeviceOffset

private

Definition at line 43 of file KisInterstrokeData.h.

m_linkedPaintDevice

KisPaintDeviceWSP KisInterstrokeData::m_linkedPaintDevice

private

Definition at line 45 of file KisInterstrokeData.h.

---

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

• libs/image/KisInterstrokeData.h
• libs/image/KisInterstrokeData.cpp