Skia
2DGraphicsLibrary
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SkDashPathEffect Class Reference

SkDashPathEffect is a subclass of SkPathEffect that implements dashing. More...

#include <SkDashPathEffect.h>

Inheritance diagram for SkDashPathEffect:
SkPathEffect SkFlattenable SkRefCnt SkRefCntBase

Public Member Functions

virtual bool filterPath (SkPath *dst, const SkPath &src, SkStrokeRec *, const SkRect *) const override
 Given a src path (input) and a stroke-rec (input and output), apply this effect to the src path, returning the new path in dst, and return true. More...
 
virtual bool asPoints (PointData *results, const SkPath &src, const SkStrokeRec &, const SkMatrix &, const SkRect *) const override
 Does applying this path effect to 'src' yield a set of points? If so, optionally return the points in 'results'.
 
DashType asADash (DashInfo *info) const override
 
- Public Member Functions inherited from SkPathEffect
virtual void computeFastBounds (SkRect *dst, const SkRect &src) const
 Compute a conservative bounds for its effect, given the src bounds. More...
 
- Public Member Functions inherited from SkFlattenable
virtual Factory getFactory () const =0
 Implement this to return a factory function pointer that can be called to recreate your class given a buffer (previously written to by your override of flatten().
 
virtual const char * getTypeName () const
 Returns the name of the object's class. More...
 
- Public Member Functions inherited from SkRefCntBase
 SkRefCntBase ()
 Default construct, initializing the reference count to 1.
 
virtual ~SkRefCntBase ()
 Destruct, asserting that the reference count is 1.
 
int32_t getRefCnt () const
 Return the reference count. More...
 
void validate () const
 
bool unique () const
 May return true if the caller is the only owner. More...
 
void ref () const
 Increment the reference count. More...
 
void unref () const
 Decrement the reference count. More...
 

Static Public Member Functions

static sk_sp< SkPathEffectMake (const SkScalar intervals[], int count, SkScalar phase)
 intervals: array containing an even number of entries (>=2), with the even indices specifying the length of "on" intervals, and the odd indices specifying the length of "off" intervals. More...
 
- Static Public Member Functions inherited from SkFlattenable
static Factory NameToFactory (const char name[])
 
static const char * FactoryToName (Factory)
 
static bool NameToType (const char name[], Type *type)
 
static void Register (const char name[], Factory, Type)
 

Protected Member Functions

 SkDashPathEffect (const SkScalar intervals[], int count, SkScalar phase)
 
void flatten (SkWriteBuffer &) const override
 Override this if your subclass needs to record data that it will need to recreate itself from its CreateProc (returned by getFactory()).
 
- Protected Member Functions inherited from SkRefCntBase
void internal_dispose_restore_refcnt_to_1 () const
 Allow subclasses to call this if they've overridden internal_dispose so they can reset fRefCnt before the destructor is called or if they choose not to call the destructor (e.g. More...
 

Private Types

typedef SkPathEffect INHERITED
 

Private Attributes

SkScalar * fIntervals
 
int32_t fCount
 
SkScalar fPhase
 
SkScalar fInitialDashLength
 
int32_t fInitialDashIndex
 
SkScalar fIntervalLength
 

Additional Inherited Members

- Public Types inherited from SkPathEffect
enum  DashType { kNone_DashType, kDash_DashType }
 If the PathEffect can be represented as a dash pattern, asADash will return kDash_DashType and None otherwise. More...
 
- Public Types inherited from SkFlattenable
enum  Type {
  kSkColorFilter_Type, kSkDrawable_Type, kSkDrawLooper_Type, kSkImageFilter_Type,
  kSkMaskFilter_Type, kSkPathEffect_Type, kSkPixelRef_Type, kSkRasterizer_Type,
  kSkShader_Type, kSkUnused_Type, kSkXfermode_Type, kSkNormalSource_Type
}
 
typedef sk_sp< SkFlattenable >(* Factory )(SkReadBuffer &)
 

Detailed Description

SkDashPathEffect is a subclass of SkPathEffect that implements dashing.

Member Function Documentation

virtual bool SkDashPathEffect::filterPath ( SkPath dst,
const SkPath src,
SkStrokeRec ,
const SkRect cullR 
) const
overridevirtual

Given a src path (input) and a stroke-rec (input and output), apply this effect to the src path, returning the new path in dst, and return true.

If this effect cannot be applied, return false and ignore dst and stroke-rec.

The stroke-rec specifies the initial request for stroking (if any). The effect can treat this as input only, or it can choose to change the rec as well. For example, the effect can decide to change the stroke's width or join, or the effect can change the rec from stroke to fill (or fill to stroke) in addition to returning a new (dst) path.

If this method returns true, the caller will apply (as needed) the resulting stroke-rec to dst and then draw.

Implements SkPathEffect.

static sk_sp<SkPathEffect> SkDashPathEffect::Make ( const SkScalar  intervals[],
int  count,
SkScalar  phase 
)
static

intervals: array containing an even number of entries (>=2), with the even indices specifying the length of "on" intervals, and the odd indices specifying the length of "off" intervals.

count: number of elements in the intervals array phase: offset into the intervals array (mod the sum of all of the intervals).

For example: if intervals[] = {10, 20}, count = 2, and phase = 25, this will set up a dashed path like so: 5 pixels off 10 pixels on 20 pixels off 10 pixels on 20 pixels off ... A phase of -5, 25, 55, 85, etc. would all result in the same path, because the sum of all the intervals is 30.

Note: only affects stroked paths.


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