Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 476 lines (348 sloc) 13.573 kB
3b7d2a5 New
rmagick authored
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
4 <html xmlns="http://www.w3.org/1999/xhtml">
5 <head>
6 <meta name="generator" content=
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
7 "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
3b7d2a5 New
rmagick authored
8
df65846 Replace version number placeholder "MAJOR.MINOR.TEENY" with "0.0.0"
rmagick authored
9 <title>RMagick 0.0.0: RVG Reference: RVG::Pattern Class</title>
3b7d2a5 New
rmagick authored
10 <meta http-equiv="Content-Type" content=
11 "text/html; charset=us-ascii" />
12 <meta name="GENERATOR" content="Quanta Plus" />
13 <meta name="Copyright" content=
3829d21 Change copyright date to 2006
rmagick authored
14 "Copyright (C) 2006 by Timothy P. Hunter" />
3b7d2a5 New
rmagick authored
15 <link rel="stylesheet" type="text/css" href="css/doc.css" />
16 <script type="text/javascript" src="scripts/doc.js">
17 </script>
18 <script type="text/javascript">
19 //<![CDATA[
20 //]]>
21 </script>
22 <style type="text/css">
23 /*<![CDATA[*/
24 }
25 /*]]>*/
26 </style>
27 </head>
28
29 <body>
df65846 Replace version number placeholder "MAJOR.MINOR.TEENY" with "0.0.0"
rmagick authored
30 <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
3b7d2a5 New
rmagick authored
31
32 <div class="nav">
33 &laquo;&nbsp;<a href="rvgimage.html">Prev</a> | <a href=
34 "index.html">Contents</a> | <a href=
35 "rvgclip.html">Next</a>&nbsp;&raquo;
36 </div>
37
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
38 <h1>class RVG::Pattern <span class="superclass">&lt;
39 Object</span></h1>
3b7d2a5 New
rmagick authored
40
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
41 <div id="toc">
3b7d2a5 New
rmagick authored
42 <h2>Table of Contents</h2>
43
44 <h3>class methods</h3>
45
46 <ul>
47 <li><a href="#new">new</a></li>
48 </ul>
49
50 <h3>instance methods</h3>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
51
52 <div>
3b7d2a5 New
rmagick authored
53 <div class="toccol">
54 <ul>
55 <li><a href="#g">g</a></li>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
56
3b7d2a5 New
rmagick authored
57 <li><a href="#image">image</a></li>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
58
3b7d2a5 New
rmagick authored
59 <li><a href=
60 "#preserve_aspect_ratio">preserve_aspect_ratio</a></li>
61 </ul>
62 </div>
63
64 <div class="toccol">
65 <ul>
66 <li><a href="#rvg">rvg</a></li>
67
d6f71b0 Fix misspelled and otherwise broken links.
rmagick authored
68 <li><a href="#RVG_text">text</a></li>
3b7d2a5 New
rmagick authored
69 </ul>
70 </div>
71
72 <div class="toccol">
73 <ul>
d6f71b0 Fix misspelled and otherwise broken links.
rmagick authored
74 <li><a href="#RVG_use">use</a></li>
3b7d2a5 New
rmagick authored
75
76 <li><a href="#viewbox">viewbox</a></li>
77 </ul>
78 </div>
79 </div>
80
81 <h3>shared methods</h3>
82
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
83 <p>In addition to the methods listed above, this class also
84 implements the <a href="rvgstyle.html">styles</a> method, the
85 <a href="rvgshape.html">shape methods</a> and the <a href=
86 "rvgxform.html">transform methods</a>.</p>
3b7d2a5 New
rmagick authored
87 </div>
88
89 <h2 class="methods">class methods</h2>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
90
3b7d2a5 New
rmagick authored
91 <div class="sig">
92 <h3 id="new">new</h3>
93
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
94 <p>RVG::Pattern.new(<span class="arg">width</span>=0,
95 <span class="arg">height</span>=0, <span class=
96 "arg">x</span>=0, <span class="arg">y</span>=0) [ <span class=
97 "arg">{ |pattern| drawing method calls }</span> ] -&gt;
98 <em>pattern</em></p>
3b7d2a5 New
rmagick authored
99 </div>
100
101 <div class="desc">
102 <h4>Description</h4>
103
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
104 <p>Creates a pattern that can be used with the
105 <code>:fill</code> and <code>:stroke</code> styles.</p>
106
107 <p>Define the pattern in the associated block. The pattern can
108 be composed of <a href="rvgshape.html">shapes</a>, <a href=
109 "rvgtext.html#new">text</a>, <a href="rvgimage.html#new">raster
110 images</a>, <a href="rvggroup.html#new">groups</a>, and
111 <a href="rvg.html#RVG_new">RVG objects</a>. You can use the
112 <a href="rvguse.html#new">use</a> method to include graphic
113 objects in the pattern.</p>
3b7d2a5 New
rmagick authored
114
115 <h4>Arguments</h4>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
116
3b7d2a5 New
rmagick authored
117 <dl>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
118 <dt>width, height</dt>
119
120 <dd>These arguments define the pattern viewport.</dd>
121
122 <dt>x, y</dt>
123
124 <dd>Specify the starting offset of the pattern. The pattern
125 will be repeated at <span class=
126 "arg">x</span><code>+m*width</code> and <span class=
127 "arg">y</span><code>+n*height</code> offsets.</dd>
3b7d2a5 New
rmagick authored
128 </dl>
129
130 <h4>Example</h4>
131
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
132 <p><a href="javascript:popup('rvg_pattern.rb.html')"><img src=
133 "ex/rvg_pattern.gif" title="Click to see the example script"
134 alt="pattern example" /></a></p>
3b7d2a5 New
rmagick authored
135 </div>
136
137 <h2 class="methods">instance methods</h2>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
138
3b7d2a5 New
rmagick authored
139 <div class="sig">
140 <h3 id='g'>g</h3>
141
142 <p><span class="arg">pattern.</span>g [{|<span class=
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
143 "arg">grp</span>| ...}] -&gt; <em>group</em></p>
3b7d2a5 New
rmagick authored
144 </div>
145
146 <div class="desc">
147 <h4>Description</h4>
148
149 <p>Calls <a href="rvggroup.html#new">RVG::Group.new</a> to
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
150 construct a group and adds it to the pattern. Yields to a block
151 if one is present, passing the new group as an argument.</p>
3b7d2a5 New
rmagick authored
152
153 <h4>Returns</h4>
154
155 <p>Returns the new group, so <code>RVG::Group</code> methods
156 can be chained to this method.</p>
157 </div>
158
159 <div class="sig">
160 <h3 id='image'>image</h3>
161
162 <p><span class="arg">pattern.</span>image(<span class=
163 "arg">raster_image</span>, <span class="arg">width</span>=nil,
164 <span class="arg">height</span>=nil, <span class=
165 "arg">x</span>=0, <span class="arg">y</span>=0) -&gt;
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
166 <em>image</em></p>
3b7d2a5 New
rmagick authored
167 </div>
168
169 <div class="desc">
170 <h4>Description</h4>
171
172 <p>Calls <a href="rvgimage.html#new">RVG::Image.new</a> to
173 construct an image and adds it to the pattern.</p>
174
175 <h4>Returns</h4>
176
177 <p>Returns the new image, so <code>RVG::Image</code> methods
178 can be chained to this method.</p>
179 </div>
180
181 <div class="sig">
182 <h3 id='preserve_aspect_ratio'>preserve_aspect_ratio</h3>
183
184 <p><span class=
185 "arg">pattern</span>.preserve_aspect_ratio(<span class=
186 "arg">align</span>, <span class=
187 "arg">meet_or_slice</span>='meet') [{|<span class=
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
188 "arg">self</span>| ...}] -&gt; <em>self</em></p>
3b7d2a5 New
rmagick authored
189 </div>
190
191 <div class="desc">
192 <h4>Description</h4>
193
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
194 <p>If you use the <a href="#viewbox">viewbox</a> method and the
195 user coordinate system does not scale uniformly to the default
196 coordinate system, use the <code>preserve_aspect_ratio</code>
197 method to specify whether or not the content is stretched to
198 fit. If not, you can specify how to fit the content into the
199 space.</p>
3b7d2a5 New
rmagick authored
200
201 <p><code>Preserve_aspect_ratio</code> yields to a block if one
202 is present, passing <span class="arg">self</span> as an
203 argument.</p>
204
205 <h4>Arguments</h4>
206
207 <dl>
208 <dt>align</dt>
209
210 <dd>
211 When the value of the <code>meet_or_slice</code> argument
212 is 'meet' or 'slice', this argument controls the placement
213 of the content within the viewport. The <code>align</code>
38641e0 Fix spelling errors
rmagick authored
214 argument is the concatenation of an <em>x</em>-alignment and
3b7d2a5 New
rmagick authored
215 a <em>y</em>-alignment. The values are shown in these
216 lists:
217
218 <h6><em>x</em>-alignment</h6>
219
220 <dl>
221 <dt>xMin</dt>
222
223 <dd>align the minimum <em>x</em> value of the content
224 with the left corner of the viewport.</dd>
225
226 <dt>xMid</dt>
227
228 <dd>vertically center the content within the
229 viewport.</dd>
230
231 <dt>xMax</dt>
232
233 <dd>align the maximum <em>x</em> value of the content
234 with the right corner of the viewport.</dd>
235 </dl>
236
237 <h6><em>y</em>-alignment</h6>
238
239 <dl>
240 <dt>YMin</dt>
241
242 <dd>align the minimum <em>y</em> value of the content
243 with the top of the viewport.</dd>
244
245 <dt>YMid</dt>
246
247 <dd>horizontally center the content within the
248 viewport.</dd>
249
250 <dt>YMax</dt>
251
252 <dd>align the maximum <em>y</em> value of the content
253 with the bottom of the viewport</dd>
254 </dl>
255 </dd>
256
257 <dt>meet_or_slice</dt>
258
259 <dd>
260 This argument can have one of these three values:
261
262 <dl>
263 <dt>'none'</dt>
264
265 <dd>The content is scaled as necessary so that it fits
266 exactly within the viewport. The aspect ratio is
267 <em>not</em> maintained.</dd>
268
269 <dt>'meet'</dt>
270
271 <dd>The content is scaled as necessary so that the larger
272 dimension exactly fits the viewport. There may be some
273 unused space in the viewport. The aspect ratio is
274 maintained.</dd>
275
276 <dt>'slice'</dt>
277
278 <dd>The content is scaled as necessary so that the
279 smaller dimension exactly fits the viewport. Some of the
280 content in the larger dimension may be cut off. The
281 aspect ratio is maintained.</dd>
282 </dl>
283 </dd>
284 </dl>
285
286 <h4>Example</h4>
287
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
288 <p>See the RVG class <a href=
289 "rvg.html#RVG_preserve_aspect_ratio">example</a>.</p>
3b7d2a5 New
rmagick authored
290
291 <h4>Returns</h4>
292
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
293 <p><span class="arg">Self</span>, so other
294 <code>RVG::Pattern</code> methods can be chained to this
295 method.</p>
3b7d2a5 New
rmagick authored
296
297 <h4>See Also</h4>
298
299 <p><a href="#viewbox">viewbox</a></p>
300 </div>
301
302 <div class="sig">
303 <h3 id="rvg">rvg</h3>
304
305 <p><span class="arg">pattern</span>.rvg(<span class=
306 "arg">width</span>, <span class="arg">height</span>,
307 <span class="arg">x</span>=0, <span class="arg">y</span>=0)
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
308 [{|<span class="arg">new_rvg</span>| ...}] -&gt;
309 <em>pattern</em></p>
3b7d2a5 New
rmagick authored
310 </div>
311
312 <div class="desc">
313 <h4>Description</h4>
314
315 <p>This method constructs a new RVG object and adds it to the
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
316 pattern. Each nested RVG object can use the <a href=
317 "rvg.html#RVG_viewbox">viewbox</a> method to define its own
3b7d2a5 New
rmagick authored
318 coordinate system. The <code>rvg</code> method yields to a
319 block, passing the nested RVG object as an argument. Within the
320 block, any drawing objects added to the nested RVG object are
321 rendered within the nested RVG object's viewport.</p>
322
323 <h4>Arguments</h4>
324
325 <dl>
326 <dt>width, height</dt>
327
328 <dd>Specifies the viewport width and height. The units are in
329 the user coordinate system of the parent container.</dd>
330
331 <dt>x, y</dt>
332
333 <dd>The x- and y-axis offsets of the viewport upper-left
334 corner. The units are in the user coordinate system of the
335 parent container.</dd>
336 </dl>
337
338 <h4>Example</h4>
339
340 <p>See the example for <a href=
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
341 "#RVG_preserve_aspect_ratio">preserve_aspect_ratio</a> in
342 <code>class RVG</code>.</p>
3b7d2a5 New
rmagick authored
343
344 <h4>Returns</h4>
345
346 <p>The <code>RVG</code> object, so other <code>RVG</code>
347 methods can be chained to this method.</p>
348 </div>
349
350 <div class="sig">
351 <h3 id='RVG_text'>text</h3>
352
353 <p><span class="arg">pattern.</span>text(<span class=
354 "arg">x</span>=0, <span class="arg">y</span>=0, <span class=
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
355 "arg">text</span>=nil) [{|<span class="arg">text</span>| ...}]
356 -&gt; <em>text</em></p>
3b7d2a5 New
rmagick authored
357 </div>
358
359 <div class="desc">
360 <h4>Description</h4>
361
362 <p>Calls <a href="rvgtext.html#new">RVG::Text.new</a> to
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
363 construct a text object and adds it to the pattern. Yields to a
364 block if one is present, passing the new text object as an
365 argument.</p>
3b7d2a5 New
rmagick authored
366
367 <h4>Returns</h4>
368
369 <p>The <code>RVG::Text</code> object, so other
370 <code>RVG::Text</code> methods can be chained to this
371 method.</p>
372 </div>
373
374 <div class="sig">
375 <h3 id="RVG_use">use</h3>
376
377 <p><span class="arg">pattern</span>.use(<span class=
378 "arg">obj</span>, <span class="arg">x</span>=0, <span class=
379 "arg">y</span>=0, <span class="arg">width</span>=nil,
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
380 <span class="arg">height</span>=nil) -&gt; <em>use</em></p>
3b7d2a5 New
rmagick authored
381 </div>
382
383 <div class="desc">
384 <h4>Description</h4>
385
386 <p>Calls <a href="rvguse.html#new">RVG::Use.new</a> to
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
387 constructs a <code>use</code> object and adds it to the
388 pattern.</p>
3b7d2a5 New
rmagick authored
389
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
390 <p>When the referenced argument is an RVG object, <span class=
391 "arg">width</span> and <span class="arg">height</span> can be
392 used to specify the width and height of the viewport. If
393 present and non-nil, these arguments override any width and
394 height specified when the RVG object was created. You must
395 specify the viewport size either when creating the RVG object
396 or when referencing it with <code>use</code>.</p>
3b7d2a5 New
rmagick authored
397
398 <h4>Examples</h4>
399
400 <p>See <a href="rvguse.html#new">RVG::Use.new</a></p>
401
402 <h4>Returns</h4>
403
404 <p>The <code>RVG::Use</code> object, so other
405 <code>RVG::Use</code> methods can be chained to this
406 method.</p>
407 </div>
408
409 <div class="sig">
410 <h3 id="viewbox">viewbox</h3>
411
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
412 <p><span class="arg">pattern</span>.viewbox(<span class=
413 "arg">min_x</span>, <span class="arg">min_y</span>,
414 <span class="arg">width</span>, <span class=
415 "arg">height</span>) [{|<span class="arg">self</span>| ...}]
416 -&gt; <em>self</em></p>
3b7d2a5 New
rmagick authored
417 </div>
418
419 <div class="desc">
420 <h4>Description</h4>
421
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
422 <p>The area of the pattern is called the <em>viewport</em>. By
423 default the origin of the coordinate system for an pattern is
424 (0,0). The user coordinates are pixels and the width and height
425 are established by the <span class="arg">width</span> and
426 <span class="arg">height</span> arguments to
427 <code>RVG::Pattern.new</code>.</p>
3b7d2a5 New
rmagick authored
428
429 <p>Use the <code>viewbox</code> method to superimpose a user
430 coordinate system on the viewport. The <code>viewbox</code>
431 method lets you set up a coordinate system using the units of
432 your choice.</p>
433
434 <p>The <code>viewbox</code> method yields to a block if one is
435 present, passing <code>self</code> as an argument.</p>
436
437 <h4>Arguments</h4>
438
439 <dl>
440 <dt>min_x, min_y</dt>
441
442 <dd>The minimum <em>x</em>-coordinate and
443 <em>y</em>-coordinate of the user coordinate system.</dd>
444
445 <dt>width, height</dt>
446
447 <dd>The width and height of the user coordinate system.</dd>
448 </dl>
449
450 <h4>Example</h4>
451
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
452 <p>See the <a href="rvg.html#RVG_viewbox">example</a> for the
453 <code>RVG</code> class.</p>
3b7d2a5 New
rmagick authored
454
455 <h4>Returns</h4>
456
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
457 <p><span class="arg">Self</span>, so other
458 <code>RVG::Pattern</code> methods may be chained to
459 <code>viewbox</code>.</p>
3b7d2a5 New
rmagick authored
460
461 <h4>See Also</h4>
462
463 <p><a href=
464 "#preserve_aspect_ratio">preserve_aspect_ratio</a></p>
465 </div>
466
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
467 <p class="spacer">&nbsp;</p>
3b7d2a5 New
rmagick authored
468
469 <div class="nav">
470 &laquo;&nbsp;<a href="rvgimage.html">Prev</a> | <a href=
471 "index.html">Contents</a> | <a href=
472 "rvgclip.html">Next</a>&nbsp;&raquo;
473 </div>
b39952f Change "aClass" convention to just "class" in method signatures. Nume…
rmagick authored
474 </body>
475 </html>
Something went wrong with that request. Please try again.