SkStrokeRec Class Reference

#include <SkStrokeRec.h>

Public Types
enum	InitStyle { kHairline_InitStyle , kFill_InitStyle }
enum	Style { kHairline_Style , kFill_Style , kStroke_Style , kStrokeAndFill_Style }

Public Member Functions
	SkStrokeRec (InitStyle style)
	SkStrokeRec (const SkPaint &, SkPaint::Style, SkScalar resScale=1)
	SkStrokeRec (const SkPaint &, SkScalar resScale=1)
Style	getStyle () const
SkScalar	getWidth () const
SkScalar	getMiter () const
SkPaint::Cap	getCap () const
SkPaint::Join	getJoin () const
bool	isHairlineStyle () const
bool	isFillStyle () const
void	setFillStyle ()
void	setHairlineStyle ()
void	setStrokeStyle (SkScalar width, bool strokeAndFill=false)
void	setStrokeParams (SkPaint::Cap cap, SkPaint::Join join, SkScalar miterLimit)
SkScalar	getResScale () const
void	setResScale (SkScalar rs)
bool	needToApply () const
bool	applyToPath (SkPath *dst, const SkPath &src) const
void	applyToPaint (SkPaint *paint) const
SkScalar	getInflationRadius () const
bool	hasEqualEffect (const SkStrokeRec &other) const

Static Public Member Functions
static SkScalar	GetInflationRadius (const SkPaint &, SkPaint::Style)
static SkScalar	GetInflationRadius (SkPaint::Join, SkScalar miterLimit, SkPaint::Cap, SkScalar strokeWidth)

Static Public Attributes
static constexpr int	kStyleCount = kStrokeAndFill_Style + 1

Detailed Description

Definition at line 22 of file SkStrokeRec.h.

Member Enumeration Documentation

InitStyle

enum SkStrokeRec::InitStyle

Enumerator
kHairline_InitStyle
kFill_InitStyle

Definition at line 24 of file SkStrokeRec.h.

                   {
        kHairline_InitStyle,
        kFill_InitStyle
    };

Style

enum SkStrokeRec::Style

Enumerator
kHairline_Style
kFill_Style
kStroke_Style
kStrokeAndFill_Style

Definition at line 32 of file SkStrokeRec.h.

               {
        kHairline_Style,
        kFill_Style,
        kStroke_Style,
        kStrokeAndFill_Style
    };

Constructor & Destructor Documentation

SkStrokeRec() [1/3]

SkStrokeRec::SkStrokeRec

(

InitStyle

style

)

Definition at line 18 of file SkStrokeRec.cpp.

                                    {
    fResScale       = 1;
    fWidth          = (kFill_InitStyle == s) ? kStrokeRec_FillStyleWidth : 0;
    fMiterLimit     = SkPaintDefaults_MiterLimit;
    fCap            = SkPaint::kDefault_Cap;
    fJoin           = SkPaint::kDefault_Join;
    fStrokeAndFill  = false;
}

SkStrokeRec() [2/3]

SkStrokeRec::SkStrokeRec	(	const SkPaint &	paint,
		SkPaint::Style	styleOverride,
		SkScalar	resScale = 1
	)

Definition at line 31 of file SkStrokeRec.cpp.

                                                                                            {
    this->init(paint, styleOverride, resScale);
}

SkStrokeRec() [3/3]

SkStrokeRec::SkStrokeRec ( const SkPaint &  paint, SkScalar  resScale = 1  )

explicit

Definition at line 27 of file SkStrokeRec.cpp.

                                                                {
    this->init(paint, paint.getStyle(), resScale);
}

Member Function Documentation

applyToPaint()

void SkStrokeRec::applyToPaint

(

SkPaint *

paint

)

const

Apply these stroke parameters to a paint.

Definition at line 127 of file SkStrokeRec.cpp.

                                                   {
    if (fWidth < 0) {  // fill
        paint->setStyle(SkPaint::kFill_Style);
        return;
    }
 
    paint->setStyle(fStrokeAndFill ? SkPaint::kStrokeAndFill_Style : SkPaint::kStroke_Style);
    paint->setStrokeWidth(fWidth);
    paint->setStrokeMiter(fMiterLimit);
    paint->setStrokeCap((SkPaint::Cap)fCap);
    paint->setStrokeJoin((SkPaint::Join)fJoin);
}

applyToPath()

bool SkStrokeRec::applyToPath	(	SkPath *	dst,
		const SkPath &	src
	)		const

Apply these stroke parameters to the src path, returning the result in dst.

If there was no change (i.e. style == hairline or fill) this returns false and dst is unchanged. Otherwise returns true and the result is stored in dst.

src and dst may be the same path.

Definition at line 107 of file SkStrokeRec.cpp.

                                                                  {
    if (fWidth <= 0) {  // hairline or fill
        return false;
    }
 
    SkStroke stroker;
    stroker.setCap((SkPaint::Cap)fCap);
    stroker.setJoin((SkPaint::Join)fJoin);
    stroker.setMiterLimit(fMiterLimit);
    stroker.setWidth(fWidth);
    stroker.setDoFill(fStrokeAndFill);
#ifdef SK_DEBUG
    stroker.setResScale(gDebugStrokerErrorSet ? gDebugStrokerError : fResScale);
#else
    stroker.setResScale(fResScale);
#endif
    stroker.strokePath(src, dst);
    return true;
}

getCap()

SkPaint::Cap SkStrokeRec::getCap ( ) const

inline

Definition at line 44 of file SkStrokeRec.h.

{ return (SkPaint::Cap)fCap; }

getInflationRadius()

SkScalar SkStrokeRec::getInflationRadius

(

)

const

Gives a conservative value for the outset that should applied to a geometries bounds to account for any inflation due to applying this strokeRec to the geometry.

Definition at line 140 of file SkStrokeRec.cpp.

                                               {
    return GetInflationRadius((SkPaint::Join)fJoin, fMiterLimit, (SkPaint::Cap)fCap, fWidth);
}

GetInflationRadius() [1/2]

SkScalar SkStrokeRec::GetInflationRadius ( const SkPaint &  paint, SkPaint::Style  style  )

static

Equivalent to: SkStrokeRec rec(paint, style); rec.getInflationRadius(); This does not account for other effects on the paint (i.e. path effect).

Definition at line 144 of file SkStrokeRec.cpp.

                                                                                 {
    SkScalar width = SkPaint::kFill_Style == style ? -SK_Scalar1 : paint.getStrokeWidth();
    return GetInflationRadius(paint.getStrokeJoin(), paint.getStrokeMiter(), paint.getStrokeCap(),
                              width);
 
}

GetInflationRadius() [2/2]

SkScalar SkStrokeRec::GetInflationRadius ( SkPaint::Join  join, SkScalar  miterLimit, SkPaint::Cap  cap, SkScalar  strokeWidth  )

static

Definition at line 151 of file SkStrokeRec.cpp.

                                                               {
    if (strokeWidth < 0) {  // fill
        return 0;
    } else if (0 == strokeWidth) {
        // FIXME: We need a "matrixScale" parameter here in order to properly handle hairlines.
        // Their with is determined in device space, unlike other strokes.
        // http://skbug.com/8157
        return SK_Scalar1;
    }
 
    // since we're stroked, outset the rect by the radius (and join type, caps)
    SkScalar multiplier = SK_Scalar1;
    if (SkPaint::kMiter_Join == join) {
        multiplier = std::max(multiplier, miterLimit);
    }
    if (SkPaint::kSquare_Cap == cap) {
        multiplier = std::max(multiplier, SK_ScalarSqrt2);
    }
    return strokeWidth/2 * multiplier;
}

getJoin()

SkPaint::Join SkStrokeRec::getJoin ( ) const

inline

Definition at line 45 of file SkStrokeRec.h.

{ return (SkPaint::Join)fJoin; }

getMiter()

SkScalar SkStrokeRec::getMiter ( ) const

inline

Definition at line 43 of file SkStrokeRec.h.

{ return fMiterLimit; }

getResScale()

SkScalar SkStrokeRec::getResScale ( ) const

inline

Definition at line 71 of file SkStrokeRec.h.

                                 {
        return fResScale;
    }

getStyle()

SkStrokeRec::Style SkStrokeRec::getStyle

(

)

const

Definition at line 71 of file SkStrokeRec.cpp.

                                             {
    if (fWidth < 0) {
        return kFill_Style;
    } else if (0 == fWidth) {
        return kHairline_Style;
    } else {
        return fStrokeAndFill ? kStrokeAndFill_Style : kStroke_Style;
    }
}

getWidth()

SkScalar SkStrokeRec::getWidth ( ) const

inline

Definition at line 42 of file SkStrokeRec.h.

{ return fWidth; }

hasEqualEffect()

bool SkStrokeRec::hasEqualEffect ( const SkStrokeRec &  other ) const

inline

Compare if two SkStrokeRecs have an equal effect on a path. Equal SkStrokeRecs produce equal paths. Equality of produced paths does not take the ResScale parameter into account.

Definition at line 130 of file SkStrokeRec.h.

                                                        {
        if (!this->needToApply()) {
            return this->getStyle() == other.getStyle();
        }
        return fWidth == other.fWidth &&
               (fJoin != SkPaint::kMiter_Join || fMiterLimit == other.fMiterLimit) &&
               fCap == other.fCap &&
               fJoin == other.fJoin &&
               fStrokeAndFill == other.fStrokeAndFill;
    }

isFillStyle()

bool SkStrokeRec::isFillStyle ( ) const

inline

Definition at line 51 of file SkStrokeRec.h.

                             {
        return kFill_Style == this->getStyle();
    }

isHairlineStyle()

bool SkStrokeRec::isHairlineStyle ( ) const

inline

Definition at line 47 of file SkStrokeRec.h.

                                 {
        return kHairline_Style == this->getStyle();
    }

needToApply()

bool SkStrokeRec::needToApply ( ) const

inline

Returns true if this specifes any thick stroking, i.e. applyToPath() will return true.

Definition at line 84 of file SkStrokeRec.h.

                             {
        Style style = this->getStyle();
        return (kStroke_Style == style) || (kStrokeAndFill_Style == style);
    }

setFillStyle()

void SkStrokeRec::setFillStyle

(

)

Definition at line 81 of file SkStrokeRec.cpp.

                               {
    fWidth = kStrokeRec_FillStyleWidth;
    fStrokeAndFill = false;
}

setHairlineStyle()

void SkStrokeRec::setHairlineStyle

(

)

Definition at line 86 of file SkStrokeRec.cpp.

                                   {
    fWidth = 0;
    fStrokeAndFill = false;
}

setResScale()

void SkStrokeRec::setResScale ( SkScalar  rs )

inline

Definition at line 75 of file SkStrokeRec.h.

                                  {
        SkASSERT(rs > 0 && std::isfinite(rs));
        fResScale = rs;
    }

setStrokeParams()

void SkStrokeRec::setStrokeParams ( SkPaint::Cap  cap, SkPaint::Join  join, SkScalar  miterLimit  )

inline

Definition at line 65 of file SkStrokeRec.h.

                                                                                {
        fCap = cap;
        fJoin = join;
        fMiterLimit = miterLimit;
    }

setStrokeStyle()

void SkStrokeRec::setStrokeStyle	(	SkScalar	width,
		bool	strokeAndFill = false
	)

Specify the strokewidth, and optionally if you want stroke + fill. Note, if width==0, then this request is taken to mean: strokeAndFill==true -> new style will be Fill strokeAndFill==false -> new style will be Hairline

Definition at line 91 of file SkStrokeRec.cpp.

                                                                   {
    if (strokeAndFill && (0 == width)) {
        // hairline+fill == fill
        this->setFillStyle();
    } else {
        fWidth = width;
        fStrokeAndFill = strokeAndFill;
    }
}

Member Data Documentation

kStyleCount

constexpr int SkStrokeRec::kStyleCount = kStrokeAndFill_Style + 1

staticconstexpr

Definition at line 39 of file SkStrokeRec.h.

---

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

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