SkPath::Iter Class Reference

#include <SkPath.h>

Public Member Functions
	Iter ()
	Iter (const SkPath &path, bool forceClose)
void	setPath (const SkPath &path, bool forceClose)
Verb	next (SkPoint pts[4])
SkScalar	conicWeight () const
bool	isCloseLine () const
bool	isClosedContour () const

Detailed Description

Iterates through verb array, and associated SkPoint array and conic weight. Provides options to treat open contours as closed, and to ignore degenerate data.

Definition at line 1480 of file SkPath.h.

Constructor & Destructor Documentation

Iter() [1/2]

SkPath::Iter::Iter

(

)

Initializes SkPath::Iter with an empty SkPath. next() on SkPath::Iter returns kDone_Verb. Call setPath to initialize SkPath::Iter at a later time.

Returns

SkPath::Iter of empty SkPath

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

Definition at line 1820 of file SkPath.cpp.

                 {
#ifdef SK_DEBUG
    fPts = nullptr;
    fConicWeights = nullptr;
    fMoveTo.fX = fMoveTo.fY = fLastPt.fX = fLastPt.fY = 0;
    fForceClose = fCloseLine = false;
#endif
    // need to init enough to make next() harmlessly return kDone_Verb
    fVerbs = nullptr;
    fVerbStop = nullptr;
    fNeedClose = false;
}

Iter() [2/2]

SkPath::Iter::Iter	(	const SkPath &	path,
		bool	forceClose
	)

Sets SkPath::Iter to return elements of verb array, SkPoint array, and conic weight in path. If forceClose is true, SkPath::Iter will add kLine_Verb and kClose_Verb after each open contour. path is not altered.

Parameters

path	SkPath to iterate
forceClose	true if open contours generate kClose_Verb

Returns

SkPath::Iter of path

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

Definition at line 1833 of file SkPath.cpp.

                                                    {
    this->setPath(path, forceClose);
}

Member Function Documentation

conicWeight()

SkScalar SkPath::Iter::conicWeight ( ) const

inline

Returns conic weight if next() returned kConic_Verb.

If next() has not been called, or next() did not return kConic_Verb, result is undefined.

Returns

conic weight for conic SkPoint returned by next()

Definition at line 1535 of file SkPath.h.

{ return *fConicWeights; }

isClosedContour()

bool SkPath::Iter::isClosedContour

(

)

const

Returns true if subsequent calls to next() return kClose_Verb before returning kMove_Verb. if true, contour SkPath::Iter is processing may end with kClose_Verb, or SkPath::Iter may have been initialized with force close set to true.

Returns

true if contour is closed

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

Definition at line 1851 of file SkPath.cpp.

                                       {
    if (fVerbs == nullptr || fVerbs == fVerbStop) {
        return false;
    }
    if (fForceClose) {
        return true;
    }
 
    const uint8_t* verbs = fVerbs;
    const uint8_t* stop = fVerbStop;
 
    if (kMove_Verb == *verbs) {
        verbs += 1; // skip the initial moveto
    }
 
    while (verbs < stop) {
        // verbs points one beyond the current verb, decrement first.
        unsigned v = *verbs++;
        if (kMove_Verb == v) {
            break;
        }
        if (kClose_Verb == v) {
            return true;
        }
    }
    return false;
}

isCloseLine()

bool SkPath::Iter::isCloseLine ( ) const

inline

Returns true if last kLine_Verb returned by next() was generated by kClose_Verb. When true, the end point returned by next() is also the start point of contour.

If next() has not been called, or next() did not return kLine_Verb, result is undefined.

Returns

true if last kLine_Verb was generated by kClose_Verb

Definition at line 1546 of file SkPath.h.

{ return SkToBool(fCloseLine); }

next()

SkPath::Verb SkPath::Iter::next

(

SkPoint

pts[4]

)

Returns next SkPath::Verb in verb array, and advances SkPath::Iter. When verb array is exhausted, returns kDone_Verb.

Zero to four SkPoint are stored in pts, depending on the returned SkPath::Verb.

Parameters

pts	storage for SkPoint data describing returned SkPath::Verb

Returns

next SkPath::Verb from verb array

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

Definition at line 1901 of file SkPath.cpp.

                                               {
    SkASSERT(ptsParam);
 
    if (fVerbs == fVerbStop) {
        // Close the curve if requested and if there is some curve to close
        if (fNeedClose) {
            if (kLine_Verb == this->autoClose(ptsParam)) {
                return kLine_Verb;
            }
            fNeedClose = false;
            return kClose_Verb;
        }
        return kDone_Verb;
    }
 
    unsigned verb = *fVerbs++;
    const SkPoint* SK_RESTRICT srcPts = fPts;
    SkPoint* SK_RESTRICT       pts = ptsParam;
 
    switch (verb) {
        case kMove_Verb:
            if (fNeedClose) {
                fVerbs--; // move back one verb
                verb = this->autoClose(pts);
                if (verb == kClose_Verb) {
                    fNeedClose = false;
                }
                return (Verb)verb;
            }
            if (fVerbs == fVerbStop) {    // might be a trailing moveto
                return kDone_Verb;
            }
            fMoveTo = *srcPts;
            pts[0] = *srcPts;
            srcPts += 1;
            fLastPt = fMoveTo;
            fNeedClose = fForceClose;
            break;
        case kLine_Verb:
            pts[0] = fLastPt;
            pts[1] = srcPts[0];
            fLastPt = srcPts[0];
            fCloseLine = false;
            srcPts += 1;
            break;
        case kConic_Verb:
            fConicWeights += 1;
            [[fallthrough]];
        case kQuad_Verb:
            pts[0] = fLastPt;
            memcpy(&pts[1], srcPts, 2 * sizeof(SkPoint));
            fLastPt = srcPts[1];
            srcPts += 2;
            break;
        case kCubic_Verb:
            pts[0] = fLastPt;
            memcpy(&pts[1], srcPts, 3 * sizeof(SkPoint));
            fLastPt = srcPts[2];
            srcPts += 3;
            break;
        case kClose_Verb:
            verb = this->autoClose(pts);
            if (verb == kLine_Verb) {
                fVerbs--; // move back one verb
            } else {
                fNeedClose = false;
            }
            fLastPt = fMoveTo;
            break;
    }
    fPts = srcPts;
    return (Verb)verb;
}

setPath()

void SkPath::Iter::setPath	(	const SkPath &	path,
		bool	forceClose
	)

Sets SkPath::Iter to return elements of verb array, SkPoint array, and conic weight in path. If forceClose is true, SkPath::Iter will add kLine_Verb and kClose_Verb after each open contour. path is not altered.

Parameters

path	SkPath to iterate
forceClose	true if open contours generate kClose_Verb

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

Definition at line 1837 of file SkPath.cpp.

                                                            {
    fPts = path.fPathRef->points();
    fVerbs = path.fPathRef->verbsBegin();
    fVerbStop = path.fPathRef->verbsEnd();
    fConicWeights = path.fPathRef->conicWeights();
    if (fConicWeights) {
      fConicWeights -= 1;  // begin one behind
    }
    fLastPt.fX = fLastPt.fY = 0;
    fMoveTo.fX = fMoveTo.fY = 0;
    fForceClose = SkToU8(forceClose);
    fNeedClose = false;
}

---

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

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