2 * Copyright 2006 The Android Open Source Project
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
8 #ifndef SkDashPathEffect_DEFINED
9 #define SkDashPathEffect_DEFINED
11 #include "SkPathEffect.h"
13 /** \class SkDashPathEffect
15 SkDashPathEffect is a subclass of SkPathEffect that implements dashing
17 class SK_API SkDashPathEffect : public SkPathEffect {
19 /** intervals: array containing an even number of entries (>=2), with
20 the even indices specifying the length of "on" intervals, and the odd
21 indices specifying the length of "off" intervals.
22 count: number of elements in the intervals array
23 phase: offset into the intervals array (mod the sum of all of the
26 For example: if intervals[] = {10, 20}, count = 2, and phase = 25,
27 this will set up a dashed path like so:
34 A phase of -5, 25, 55, 85, etc. would all result in the same path,
35 because the sum of all the intervals is 30.
37 Note: only affects stroked paths.
39 static SkDashPathEffect* Create(const SkScalar intervals[], int count,
41 return SkNEW_ARGS(SkDashPathEffect, (intervals, count, phase));
43 virtual ~SkDashPathEffect();
45 virtual bool filterPath(SkPath* dst, const SkPath& src,
46 SkStrokeRec*, const SkRect*) const SK_OVERRIDE;
48 virtual bool asPoints(PointData* results, const SkPath& src,
49 const SkStrokeRec&, const SkMatrix&,
50 const SkRect*) const SK_OVERRIDE;
52 virtual DashType asADash(DashInfo* info) const SK_OVERRIDE;
54 virtual Factory getFactory() const SK_OVERRIDE;
56 static SkFlattenable* CreateProc(SkReadBuffer&);
59 SkDashPathEffect(SkReadBuffer&);
60 virtual void flatten(SkWriteBuffer&) const SK_OVERRIDE;
62 #ifdef SK_SUPPORT_LEGACY_PUBLICEFFECTCONSTRUCTORS
65 SkDashPathEffect(const SkScalar intervals[], int count, SkScalar phase);
68 void setInternalMembers(SkScalar phase);
73 // computed from phase
74 SkScalar fInitialDashLength;
75 int32_t fInitialDashIndex;
76 SkScalar fIntervalLength;
78 typedef SkPathEffect INHERITED;