blob: 97cd66df60945b61f37b239b823e4b973dc0d29e [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Skia: SkPathEffect Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SkPathEffect Class Reference</h1><!-- doxytag: class="SkPathEffect" --><!-- doxytag: inherits="SkFlattenable" -->
<p><code>#include &lt;<a class="el" href="_sk_path_effect_8h_source.html">SkPathEffect.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_sk_flattenable.html">SkFlattenable</a>.</p>
<p>Inherited by <a class="el" href="class_sk1_d_path_effect.html">Sk1DPathEffect</a>, <a class="el" href="class_sk2_d_path_effect.html">Sk2DPathEffect</a>, <a class="el" href="class_sk_corner_path_effect.html">SkCornerPathEffect</a>, <a class="el" href="class_sk_dash_path_effect.html">SkDashPathEffect</a>, <a class="el" href="class_sk_discrete_path_effect.html">SkDiscretePathEffect</a>, <a class="el" href="class_sk_pair_path_effect.html">SkPairPathEffect</a>, and <a class="el" href="class_sk_stroke_path_effect.html">SkStrokePathEffect</a>.</p>
<div class="dynheader">
Collaboration diagram for SkPathEffect:</div>
<div class="dynsection">
<div class="center"><img src="class_sk_path_effect__coll__graph.png" border="0" usemap="#_sk_path_effect_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_sk_path_effect-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_path_effect.html#afe751714f164e9f99d4abd8106ad1772">SkPathEffect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_path_effect.html#a37dc2b47391c92f42983a838c23cb26c">filterPath</a> (<a class="el" href="class_sk_path.html">SkPath</a> *dst, const <a class="el" href="class_sk_path.html">SkPath</a> &amp;src, <a class="el" href="_sk_scalar_8h.html#a407e363d56d824ed93bd6d1fda2effcf">SkScalar</a> *width)=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_sk_path_effect.html">SkPathEffect</a> is the base class for objects in the <a class="el" href="class_sk_paint.html">SkPaint</a> that affect the geometry of a drawing primitive before it is transformed by the canvas' matrix and drawn.</p>
<p>Dashing is implemented as a subclass of <a class="el" href="class_sk_path_effect.html">SkPathEffect</a>. </p>
<p>Definition at line <a class="el" href="_sk_path_effect_8h_source.html#l00032">32</a> of file <a class="el" href="_sk_path_effect_8h_source.html">SkPathEffect.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afe751714f164e9f99d4abd8106ad1772"></a><!-- doxytag: member="SkPathEffect::SkPathEffect" ref="afe751714f164e9f99d4abd8106ad1772" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkPathEffect::SkPathEffect </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_path_effect_8h_source.html#l00035">35</a> of file <a class="el" href="_sk_path_effect_8h_source.html">SkPathEffect.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a37dc2b47391c92f42983a838c23cb26c"></a><!-- doxytag: member="SkPathEffect::filterPath" ref="a37dc2b47391c92f42983a838c23cb26c" args="(SkPath *dst, const SkPath &amp;src, SkScalar *width)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SkPathEffect::filterPath </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_path.html">SkPath</a> *&nbsp;</td>
<td class="paramname"> <em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_path.html">SkPath</a> &amp;&nbsp;</td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_sk_scalar_8h.html#a407e363d56d824ed93bd6d1fda2effcf">SkScalar</a> *&nbsp;</td>
<td class="paramname"> <em>width</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a src path and a width value, return true if the patheffect has produced a new path (dst) and a new width value. If false is returned, ignore dst and width. On input, width &gt;= 0 means the src should be stroked On output, width &gt;= 0 means the dst should be stroked </p>
<p>Implemented in <a class="el" href="class_sk_stroke_path_effect.html#ac7022222841f13ad8f6389e5528ddd6c">SkStrokePathEffect</a>, <a class="el" href="class_sk_compose_path_effect.html#a566b837bc53f891162bd9cbe8d00eb12">SkComposePathEffect</a>, <a class="el" href="class_sk_sum_path_effect.html#a6b972d7ad89ea0fa236a41fc518c758d">SkSumPathEffect</a>, <a class="el" href="class_sk1_d_path_effect.html#a28f8c1c65a276a6b53b7e3734803d163">Sk1DPathEffect</a>, <a class="el" href="class_sk_path1_d_path_effect.html#a8ef32647de789f0cc78e03b4f72db4b6">SkPath1DPathEffect</a>, <a class="el" href="class_sk2_d_path_effect.html#ab4173f7bf1919e6c598f6499d7da4a0d">Sk2DPathEffect</a>, <a class="el" href="class_sk_corner_path_effect.html#ac5e0b00eb904d7738acdd29903853fb5">SkCornerPathEffect</a>, <a class="el" href="class_sk_dash_path_effect.html#a10fda68457db533c9a0be4a6c562f6ad">SkDashPathEffect</a>, and <a class="el" href="class_sk_discrete_path_effect.html#a580bf711589a3a2829a6e6caf4be9342">SkDiscretePathEffect</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/core/<a class="el" href="_sk_path_effect_8h_source.html">SkPathEffect.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Oct 20 11:03:42 2009 for Skia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>