KisSampleRectIterator Class Reference

#include <KisSampleRectIterator.h>

Inheritance diagram for KisSampleRectIterator:

Classes
struct	HaltonSampler

Public Member Functions
	KisSampleRectIterator ()
	KisSampleRectIterator (const KisSampleRectIterator &rhs)
	KisSampleRectIterator (const QRectF &rect)
	KisSampleRectIterator (KisSampleRectIterator &&rhs)
int	numSamples () const
KisSampleRectIterator &	operator= (const KisSampleRectIterator &rhs)
KisSampleRectIterator &	operator= (KisSampleRectIterator &&rhs)
	~KisSampleRectIterator ()

Private Member Functions
QPointF	dereference () const
void	increment ()

Private Attributes
int	m_index = 0
QRectF	m_rect
QSharedDataPointer< HaltonSampler >	m_sampler

Friends
class	boost::iterator_core_access

Detailed Description

A simple generator-style iterator that samples the passed rectangle (QRectF) with semi-random points.

The first nine points returned by the iterator correspond to the corners and midpoints of the rectangle. From 10th and further the iterator returns "random" samples inside the rectangle generated by a fixed Halton sequence.

Usage:

KisSampleRectIterator sampler(rect);
while (1) {
     const QPointF sampledPoint = *sampler++;
}

Definition at line 37 of file KisSampleRectIterator.h.

Constructor & Destructor Documentation

KisSampleRectIterator() [1/4]

KisSampleRectIterator::KisSampleRectIterator ( )

default

KisSampleRectIterator() [2/4]

KisSampleRectIterator::KisSampleRectIterator

(

const QRectF &

rect

)

Definition at line 31 of file KisSampleRectIterator.cpp.

    : m_rect(rect)
{
}

KisSampleRectIterator() [3/4]

KisSampleRectIterator::KisSampleRectIterator ( const KisSampleRectIterator & rhs )

default

KisSampleRectIterator() [4/4]

KisSampleRectIterator::KisSampleRectIterator ( KisSampleRectIterator && rhs )

default

~KisSampleRectIterator()

KisSampleRectIterator::~KisSampleRectIterator ( )

default

Member Function Documentation

dereference()

QPointF KisSampleRectIterator::dereference ( ) const

private

Definition at line 52 of file KisSampleRectIterator.cpp.

                                                 {
    switch (m_index) {
    case 0:
        return m_rect.topLeft();
    case 1:
        return m_rect.topRight();
    case 2:
        return m_rect.bottomRight();
    case 3:
        return m_rect.bottomLeft();
    case 4:
        return 0.5 * (m_rect.bottomLeft() + m_rect.topLeft());
    case 5:
        return 0.5 * (m_rect.topRight() + m_rect.topLeft());
    case 6:
        return 0.5 * (m_rect.topRight() + m_rect.bottomRight());
    case 7:
        return 0.5 * (m_rect.bottomLeft() + m_rect.bottomRight());
    case 8:
        return m_rect.center();
    default:
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_sampler, m_rect.center());
        return KisAlgebra2D::relativeToAbsolute(
            QPointF(m_sampler->x.currentValue(), m_sampler->y.currentValue()),
            m_rect);
    }
 
    Q_UNREACHABLE();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_index, m_rect, m_sampler, and KisAlgebra2D::relativeToAbsolute().

increment()

void KisSampleRectIterator::increment ( )

private

Definition at line 40 of file KisSampleRectIterator.cpp.

                                      {
    m_index++;
 
    if (m_index >= 9) {
        if (m_index == 9) {
            KIS_SAFE_ASSERT_RECOVER_RETURN(!m_sampler);
            m_sampler = new HaltonSampler();
        }
        m_sampler->step();
    }
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_index, and m_sampler.

numSamples()

int KisSampleRectIterator::numSamples

(

)

const

Definition at line 36 of file KisSampleRectIterator.cpp.

                                            {
    return m_index + 1;
}

References m_index.

operator=() [1/2]

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

default

operator=() [2/2]

KisSampleRectIterator & KisSampleRectIterator::operator= ( KisSampleRectIterator && rhs )

default

Friends And Related Symbol Documentation

boost::iterator_core_access

friend class boost::iterator_core_access

friend

Definition at line 56 of file KisSampleRectIterator.h.

Member Data Documentation

m_index

int KisSampleRectIterator::m_index = 0

private

Definition at line 66 of file KisSampleRectIterator.h.

m_rect

QRectF KisSampleRectIterator::m_rect

private

Definition at line 65 of file KisSampleRectIterator.h.

m_sampler

QSharedDataPointer<HaltonSampler> KisSampleRectIterator::m_sampler

private

Definition at line 63 of file KisSampleRectIterator.h.

---

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

• libs/global/KisSampleRectIterator.h
• libs/global/KisSampleRectIterator.cpp