Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 249 lines (190 sloc) 7.263 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta name="generator" content=
  "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />

  <title>RMagick 0.0.0: RVG Reference: RVG::ClipPath Class</title>
  <meta http-equiv="Content-Type" content=
  "text/html; charset=us-ascii" />
  <meta name="GENERATOR" content="Quanta Plus" />
  <meta name="Copyright" content=
  "Copyright (C) 2006 by Timothy P. Hunter" />
  <link rel="stylesheet" type="text/css" href="css/doc.css" />
<script type="text/javascript" src="scripts/doc.js">
</script>
<script type="text/javascript">
  //<![CDATA[
  //]]>
</script>
<style type="text/css">
  /*<![CDATA[*/
    }
  /*]]>*/
</style>
</head>

<body>
  <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>

  <div class="nav">
    &laquo;&nbsp;<a href="rvgpattern.html">Prev</a> | <a href=
    "index.html">Contents</a> | <a href=
    "rvgtext.html">Next</a>&nbsp;&raquo;
  </div>

  <h1>class RVG::ClipPath <span class="superclass">&lt;
  Object</span></h1>

  <div id="toc">
    <h2>Table of Contents</h2>

    <h3>class methods</h3>

    <ul>
      <li><a href="#new">new</a></li>
    </ul>

    <h3>attributes</h3>

    <div class="toccol">
      <ul>
        <li><a href="#desc">desc, desc=</a></li>

        <li><a href="#metadata">metadata, metadata=</a></li>

        <li><a href="#title">title, title=</a></li>
      </ul>
    </div>

    <h3>instance methods</h3>

    <div class="toccol">
      <ul>
        <li><a href="#text">text</a></li>

        <li><a href="#use">use</a></li>
      </ul>
    </div>

    <h3>shared methods</h3>

    <p>In addition to the methods listed above, <code>class
    RVG::ClipPath</code> also implements the <a href=
    "rvgstyle.html">styles</a> method and the <a href=
    "rvgshape.html">shape methods</a>.</p>
  </div>

  <h2 class="methods">class methods</h2>

  <div class="sig">
    <h3 id="new">new</h3>

    <p>RVG::ClipPath.new(<span class="arg">clip_path_units</span>)
    [ <span class="arg">{ |clippath| drawing method calls }</span>
    ] -&gt; <em>clippath</em></p>
  </div>

  <div class="desc">
    <h4>Description</h4>

    <p>Creates a <em>clipping path</em>. A clipping path is a
    combination of path, text, and basic shape objects that define
    an outline. Attach the clipping path to an object such as a
    raster image or RVG object with the :clip_path style. When RVG
    draws the object, things "outside" the path are not drawn.</p>

    <p>The ClipPath.new method yields to a block. Within the block
    define the clipping path with a combination of path, basic
    shape, and <a href="#text">text</a> objects. You can also use
    the <a href="#use">use</a> method to refer to a
    previously-defined object or group of objects.</p>

    <h4>Arguments</h4>

    <dl>
      <dt>clip_path_units</dt>

      <dd>Defines the coordinate system for the contents of the
      clipping path. This argument can take either of two values,
      <strong>userSpaceOnUse</strong>, or
      <strong>objectBoundingBox</strong>. If
      <code>userSpaceOnUse</code>, the contents of the clipping
      path represent values in the current user coordinate system
      in place at the time when the clipping path is referenced. if
      objectBoundingBox, then the user coordinate system for the
      contents of the clipping path is established using the
      bounding box of the object to which the clipping path is
      applied. The default is <code>userSpaceOnUse</code>.</dd>
    </dl>

    <h4>Example</h4>

    <p><a href="javascript:popup('rvg_clippath.rb.html')"><img src=
    "ex/rvg_clippath.gif" title="Click to see the example script"
    alt="clipping path example" /></a></p>

    <h4>See Also</h4>

    <p>The <a href="rvgstyle.html">:clip_rule</a> style.</p>
  </div>

  <h2 class="methods">attributes</h2>

  <div class="sig">
    <h3 id="desc">desc, desc=</h3>

    <p><span class="arg">clippath</span>.desc -&gt;
    <em>string</em><br />
    <span class="arg">clippath</span>.desc = <span class=
    "arg">string</span></p>
  </div>

  <div class="desc">
    <h4>Description</h4>Use the <code>desc</code> attribute to
    assign a text description to the clipping path.
  </div>

  <div class="sig">
    <h3 id="metadata">metadata, metadata=</h3>

    <p><span class="arg">clippath</span>.metadata -&gt;
    <em>string</em><br />
    <span class="arg">clippath</span>.metadata = <span class=
    "arg">string</span></p>
  </div>

  <div class="desc">
    <h4>Description</h4>Use the <code>metadata</code> attribute to
    assign additional metadata to the clipping path.
  </div>

  <div class="sig">
    <h3 id="title">title, title=</h3>

    <p><span class="arg">clippath</span>.title -&gt;
    <em>string</em><br />
    <span class="arg">clippath</span>.title = <span class=
    "arg">string</span></p>
  </div>

  <div class="desc">
    <h4>Description</h4>Use the <code>title</code> attribute to
    assign a title to the clipping path.
  </div>

  <h2 class="methods">instance methods</h2>

  <div class="sig">
    <h3 id='text'>text</h3>

    <p><span class="arg">clippath.</span>text(<span class=
    "arg">x</span>=0, <span class="arg">y</span>=0, <span class=
    "arg">text</span>=nil) [{|<span class="arg">text</span>| ...}]
    -&gt; <em>text</em></p>
  </div>

  <div class="desc">
    <h4>Description</h4>

    <p>Calls <a href="rvgtext.html#new">RVG::Text.new</a> to
    construct a text object and adds it to the clipping path.
    Yields to a block if one is present, passing the new text
    object as an argument.</p>

    <h4>Returns</h4>

    <p>The <code>RVG::Text</code> object, so other
    <code>RVG::Text</code> methods can be chained to this
    method.</p>
  </div>

  <div class="sig">
    <h3 id="use">use</h3>

    <p><span class="arg">clippath.</span>use(<span class=
    "arg">obj</span>, <span class="arg">x</span>=0, <span class=
    "arg">y</span>=0, <span class="arg">width</span>=nil,
    <span class="arg">height</span>=nil) -&gt; <em>use</em></p>
  </div>

  <div class="desc">
    <h4>Description</h4>

    <p>Calls <a href="rvguse.html#new">RVG::Use.new</a> to
    constructs a <code>use</code> object and adds it to the
    clipping path.</p>

    <p>When the referenced argument is another RVG object,
    <span class="arg">width</span> and <span class=
    "arg">height</span> can be used to specify the width and height
    of the viewport. If present and non-nil, these arguments
    override any width and height specified when the RVG object was
    created. You must specify the viewport size either when
    creating the RVG object or when referencing it with
    <code>use</code>.</p>

    <h4>Examples</h4>

    <p>See <a href="rvguse.html#new">RVG::Use.new</a></p>

    <h4>Returns</h4>

    <p>The <code>RVG::Use</code> object, so other
    <code>RVG::Use</code> methods can be chained to this
    method.</p>
  </div>

  <p class="spacer">&nbsp;</p>

  <div class="nav">
    &laquo;&nbsp;<a href="rvgpattern.html">Prev</a> | <a href=
    "index.html">Contents</a> | <a href=
    "rvgtext.html">Next</a>&nbsp;&raquo;
  </div>
</body>
</html>
Something went wrong with that request. Please try again.