SkRegion::Iterator Class Reference

#include <SkRegion.h>

Public Member Functions
	Iterator ()
	Iterator (const SkRegion &region)
bool	rewind ()
void	reset (const SkRegion &region)
bool	done () const
void	next ()
const SkIRect &	rect () const
const SkRegion *	rgn () const

Detailed Description

Returns sequence of rectangles, sorted along y-axis, then x-axis, that make up SkRegion.

Definition at line 447 of file SkRegion.h.

Constructor & Destructor Documentation

Iterator() [1/2]

SkRegion::Iterator::Iterator ( )

inline

Initializes SkRegion::Iterator with an empty SkRegion. done() on SkRegion::Iterator returns true. Call reset() to initialized SkRegion::Iterator at a later time.

Returns

empty SkRegion iterator

Definition at line 456 of file SkRegion.h.

: fRgn(nullptr), fDone(true) {}

Iterator() [2/2]

SkRegion::Iterator::Iterator

(

const SkRegion &

region

)

Sets SkRegion::Iterator to return elements of SkIRect array in region.

Parameters

region

SkRegion to iterate

Returns

SkRegion iterator

example: https://fiddle.skia.org/c/@Region_Iterator_copy_const_SkRegion

Definition at line 1357 of file SkRegion.cpp.

                                              {
    this->reset(rgn);
}

Member Function Documentation

done()

bool SkRegion::Iterator::done ( ) const

inline

Returns true if SkRegion::Iterator is pointing to final SkIRect in SkRegion.

Returns

true if data parsing is complete

Definition at line 488 of file SkRegion.h.

{ return fDone; }

next()

void SkRegion::Iterator::next

(

)

Advances SkRegion::Iterator to next SkIRect in SkRegion if it is not done.

example: https://fiddle.skia.org/c/@Region_Iterator_next

Definition at line 1387 of file SkRegion.cpp.

                            {
    if (fDone) {
        return;
    }
 
    if (fRuns == nullptr) {   // rect case
        fDone = true;
        return;
    }
 
    const RunType* runs = fRuns;
 
    if (runs[0] < SkRegion_kRunTypeSentinel) { // valid X value
        fRect.fLeft = runs[0];
        fRect.fRight = runs[1];
        runs += 2;
    } else {    // we're at the end of a line
        runs += 1;
        if (runs[0] < SkRegion_kRunTypeSentinel) { // valid Y value
            int intervals = runs[1];
            if (0 == intervals) {    // empty line
                fRect.fTop = runs[0];
                runs += 3;
            } else {
                fRect.fTop = fRect.fBottom;
            }
 
            fRect.fBottom = runs[0];
            assert_sentinel(runs[2], false);
            assert_sentinel(runs[3], false);
            fRect.fLeft = runs[2];
            fRect.fRight = runs[3];
            runs += 4;
        } else {    // end of rgn
            fDone = true;
        }
    }
    fRuns = runs;
}

rect()

const SkIRect & SkRegion::Iterator::rect ( ) const

inline

Returns SkIRect element in SkRegion. Does not return predictable results if SkRegion is empty.

Returns

part of SkRegion as SkIRect

Definition at line 501 of file SkRegion.h.

{ return fRect; }

reset()

void SkRegion::Iterator::reset

(

const SkRegion &

region

)

Resets iterator, using the new SkRegion.

Parameters

region

SkRegion to iterate

example: https://fiddle.skia.org/c/@Region_Iterator_reset

Definition at line 1369 of file SkRegion.cpp.

                                                {
    fRgn = &rgn;
    if (rgn.isEmpty()) {
        fDone = true;
    } else {
        fDone = false;
        if (rgn.isRect()) {
            fRect = rgn.fBounds;
            fRuns = nullptr;
        } else {
            fRuns = rgn.fRunHead->readonly_runs();
            fRect.setLTRB(fRuns[3], fRuns[0], fRuns[4], fRuns[1]);
            fRuns += 5;
            // Now fRuns points to the 2nd interval (or x-sentinel)
        }
    }
}

rewind()

bool SkRegion::Iterator::rewind

(

)

SkPoint SkRegion::Iterator to start of SkRegion. Returns true if SkRegion was set; otherwise, returns false.

Returns

true if SkRegion was set

example: https://fiddle.skia.org/c/@Region_Iterator_rewind

Definition at line 1361 of file SkRegion.cpp.

                              {
    if (fRgn) {
        this->reset(*fRgn);
        return true;
    }
    return false;
}

rgn()

const SkRegion * SkRegion::Iterator::rgn ( ) const

inline

Returns SkRegion if set; otherwise, returns nullptr.

Returns

iterated SkRegion

Definition at line 507 of file SkRegion.h.

{ return fRgn; }

---

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

• third_party/skia/include/core/SkRegion.h
• third_party/skia/src/core/SkRegion.cpp