chalk

KisRectIterator Class Reference

#include <kis_iterator.h>

Inherited by KisRectIteratorPixel.

Public Member Functions

 KisRectIterator (KisDataManager *dm, TQ_INT32 x, TQ_INT32 y, TQ_INT32 w, TQ_INT32 h, bool writable)
 
 KisRectIterator (const KisRectIterator &rhs)
 
KisRectIterator & operator= (const KisRectIterator &rhs)
 
TQ_UINT8 * rawData () const
 
const TQ_UINT8 * oldRawData () const
 
TQ_INT32 nConseqPixels () const
 
KisRectIterator & operator+= (int n)
 
KisRectIterator & operator++ ()
 
bool isDone () const
 
TQ_INT32 x () const
 
TQ_INT32 y () const
 

Detailed Description

The KisRectIterator iterators over a rectangular area in the most efficient order.

That is, there is no guarantee that the iterator will work scanline by scanline.

Definition at line 40 of file kis_iterator.h.

Constructor & Destructor Documentation

◆ KisRectIterator() [1/2]

KisRectIterator::KisRectIterator ( KisDataManager *  dm,
TQ_INT32  x,
TQ_INT32  y,
TQ_INT32  w,
TQ_INT32  h,
bool  writable 
)

Definition at line 28 of file kis_iterator.cpp.

◆ ~KisRectIterator()

KisRectIterator::~KisRectIterator ( )
virtual

Definition at line 43 of file kis_iterator.cpp.

◆ KisRectIterator() [2/2]

KisRectIterator::KisRectIterator ( const KisRectIterator &  rhs)

Definition at line 32 of file kis_iterator.cpp.

Member Function Documentation

◆ isDone()

bool KisRectIterator::isDone ( ) const

returns true when iterators has reached the end

Definition at line 57 of file kis_iterator.cpp.

◆ nConseqPixels()

TQ_INT32 KisRectIterator::nConseqPixels ( ) const

Returns the number of consequtive pixels that we point at This is useful for optimizing.

Definition at line 51 of file kis_iterator.cpp.

◆ oldRawData()

const TQ_UINT8 * KisRectIterator::oldRawData ( ) const

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

Definition at line 49 of file kis_iterator.cpp.

◆ operator++()

KisRectIterator & KisRectIterator::operator++ ( )

Advances one pixel going to the beginning of the next line when it reaches the end of a line.

Definition at line 55 of file kis_iterator.cpp.

◆ operator+=()

KisRectIterator & KisRectIterator::operator+= ( int  n)

Advances a number of pixels until it reaches the end of the rect.

Definition at line 53 of file kis_iterator.cpp.

◆ operator=()

KisRectIterator & KisRectIterator::operator= ( const KisRectIterator &  rhs)

Definition at line 37 of file kis_iterator.cpp.

◆ rawData()

TQ_UINT8 * KisRectIterator::rawData ( ) const

returns a pointer to the pixel data. Do NOT interpret the data - leave that to a colorstrategy

Definition at line 47 of file kis_iterator.cpp.

◆ x()

TQ_INT32 KisRectIterator::x ( ) const

Definition at line 59 of file kis_iterator.cpp.

◆ y()

TQ_INT32 KisRectIterator::y ( ) const

Definition at line 60 of file kis_iterator.cpp.


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