Google Git
Sign in
android / toolchain / benchmark / honeycomb / . / skia / src / docs / html / class_sk_discrete_path_effect.html
blob: 98be4ffc2d1066e2809e3cc383fa3c97ed3da1a3 [file] [log] [blame]
<!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: SkDiscretePathEffect 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>SkDiscretePathEffect Class Reference</h1><!-- doxytag: class="SkDiscretePathEffect" --><!-- doxytag: inherits="SkPathEffect" -->
<p><code>#include &lt;<a class="el" href="_sk_discrete_path_effect_8h_source.html">SkDiscretePathEffect.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_sk_path_effect.html">SkPathEffect</a>.</p>
<div class="dynheader">
Collaboration diagram for SkDiscretePathEffect:</div>
<div class="dynsection">
<div class="center"><img src="class_sk_discrete_path_effect__coll__graph.png" border="0" usemap="#_sk_discrete_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_discrete_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_discrete_path_effect.html#a65731498341a9fd76d36186f3eb810a5">SkDiscretePathEffect</a> (<a class="el" href="_sk_scalar_8h.html#a407e363d56d824ed93bd6d1fda2effcf">SkScalar</a> segLength, <a class="el" href="_sk_scalar_8h.html#a407e363d56d824ed93bd6d1fda2effcf">SkScalar</a> deviation)</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_discrete_path_effect.html#a580bf711589a3a2829a6e6caf4be9342">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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_sk_flattenable.html#a66e7fa054ae7ef77e452e6e23c2650ad">Factory</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_discrete_path_effect.html#a8df566f0ef8592375183a7d9be8d83e6">getFactory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_discrete_path_effect.html#a5af18bc0f5bb6bc8f3470a0d6a4d25c1">flatten</a> (<a class="el" href="class_sk_flattenable_write_buffer.html">SkFlattenableWriteBuffer</a> &amp;)</td></tr>
<tr><td colspan="2"><h2>Protected 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_discrete_path_effect.html#a48ab68e682e467faa19730866a9c0717">SkDiscretePathEffect</a> (<a class="el" href="class_sk_flattenable_read_buffer.html">SkFlattenableReadBuffer</a> &amp;)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This path effect chops a path into discrete segments, and randomly displaces them. </p>
<p>Definition at line <a class="el" href="_sk_discrete_path_effect_8h_source.html#l00026">26</a> of file <a class="el" href="_sk_discrete_path_effect_8h_source.html">SkDiscretePathEffect.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a65731498341a9fd76d36186f3eb810a5"></a><!-- doxytag: member="SkDiscretePathEffect::SkDiscretePathEffect" ref="a65731498341a9fd76d36186f3eb810a5" args="(SkScalar segLength, SkScalar deviation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkDiscretePathEffect::SkDiscretePathEffect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_sk_scalar_8h.html#a407e363d56d824ed93bd6d1fda2effcf">SkScalar</a>&nbsp;</td>
<td class="paramname"> <em>segLength</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>deviation</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Break the path into segments of segLength length, and randomly move the endpoints away from the original path by a maximum of deviation. Note: works on filled or framed paths </p>
</div>
</div>
<a class="anchor" id="a48ab68e682e467faa19730866a9c0717"></a><!-- doxytag: member="SkDiscretePathEffect::SkDiscretePathEffect" ref="a48ab68e682e467faa19730866a9c0717" args="(SkFlattenableReadBuffer &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkDiscretePathEffect::SkDiscretePathEffect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_flattenable_read_buffer.html">SkFlattenableReadBuffer</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a580bf711589a3a2829a6e6caf4be9342"></a><!-- doxytag: member="SkDiscretePathEffect::filterPath" ref="a580bf711589a3a2829a6e6caf4be9342" args="(SkPath *dst, const SkPath &amp;src, SkScalar *width)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SkDiscretePathEffect::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> [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>Implements <a class="el" href="class_sk_path_effect.html#a37dc2b47391c92f42983a838c23cb26c">SkPathEffect</a>.</p>
</div>
</div>
<a class="anchor" id="a5af18bc0f5bb6bc8f3470a0d6a4d25c1"></a><!-- doxytag: member="SkDiscretePathEffect::flatten" ref="a5af18bc0f5bb6bc8f3470a0d6a4d25c1" args="(SkFlattenableWriteBuffer &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SkDiscretePathEffect::flatten </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_flattenable_write_buffer.html">SkFlattenableWriteBuffer</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this to write data specific to your subclass into the buffer, being sure to call your super-class' version first. This data will later be passed to your Factory function, returned by <a class="el" href="class_sk_discrete_path_effect.html#a8df566f0ef8592375183a7d9be8d83e6">getFactory()</a>. </p>
<p>Reimplemented from <a class="el" href="class_sk_flattenable.html#a672baebeed8d8e81cd2a6b0da825fe9f">SkFlattenable</a>.</p>
</div>
</div>
<a class="anchor" id="a8df566f0ef8592375183a7d9be8d83e6"></a><!-- doxytag: member="SkDiscretePathEffect::getFactory" ref="a8df566f0ef8592375183a7d9be8d83e6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_sk_flattenable.html#a66e7fa054ae7ef77e452e6e23c2650ad">Factory</a> SkDiscretePathEffect::getFactory </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>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 <a class="el" href="class_sk_discrete_path_effect.html#a5af18bc0f5bb6bc8f3470a0d6a4d25c1">flatten()</a>. </p>
<p>Implements <a class="el" href="class_sk_flattenable.html#a899954e816a929a02e28d835707ca966">SkFlattenable</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/effects/<a class="el" href="_sk_discrete_path_effect_8h_source.html">SkDiscretePathEffect.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>