rmagick 2.16.0 → 5.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (404) hide show
  1. checksums.yaml +5 -5
  2. data/.devcontainer/Dockerfile +14 -0
  3. data/.devcontainer/ImageMagick6/devcontainer.json +11 -0
  4. data/.devcontainer/devcontainer.json +11 -0
  5. data/.devcontainer/setup-repo.sh +10 -0
  6. data/.devcontainer/setup-user.sh +45 -0
  7. data/.editorconfig +3 -0
  8. data/.github/ISSUE_TEMPLATE.md +17 -0
  9. data/.github/workflows/ci.yml +138 -0
  10. data/.gitignore +7 -1
  11. data/.rspec +1 -0
  12. data/.rubocop.yml +37 -340
  13. data/.rubocop_todo.yml +448 -0
  14. data/.yardopts +5 -0
  15. data/CHANGELOG.md +455 -0
  16. data/CODE_OF_CONDUCT.md +122 -7
  17. data/CONTRIBUTING.md +37 -6
  18. data/Gemfile +0 -6
  19. data/README.md +316 -0
  20. data/Rakefile +74 -100
  21. data/before_install_linux.sh +65 -28
  22. data/before_install_osx.sh +58 -2
  23. data/ext/RMagick/extconf.rb +287 -393
  24. data/ext/RMagick/rmagick.c +106 -111
  25. data/ext/RMagick/rmagick.h +235 -331
  26. data/ext/RMagick/rmagick_gvl.h +224 -0
  27. data/ext/RMagick/rmdraw.c +516 -843
  28. data/ext/RMagick/rmenum.c +316 -755
  29. data/ext/RMagick/rmfill.c +281 -191
  30. data/ext/RMagick/rmilist.c +451 -456
  31. data/ext/RMagick/rmimage.c +6250 -5290
  32. data/ext/RMagick/rminfo.c +721 -894
  33. data/ext/RMagick/rmkinfo.c +228 -0
  34. data/ext/RMagick/rmmain.c +735 -521
  35. data/ext/RMagick/rmmontage.c +127 -172
  36. data/ext/RMagick/rmpixel.c +638 -431
  37. data/ext/RMagick/rmstruct.c +102 -282
  38. data/ext/RMagick/rmutil.c +450 -363
  39. data/lib/rmagick/version.rb +5 -4
  40. data/lib/rmagick.rb +2 -0
  41. data/lib/rmagick_internal.rb +349 -413
  42. data/lib/rvg/clippath.rb +3 -4
  43. data/lib/rvg/container.rb +30 -22
  44. data/lib/rvg/deep_equal.rb +11 -11
  45. data/lib/rvg/describable.rb +2 -2
  46. data/lib/rvg/embellishable.rb +63 -68
  47. data/lib/rvg/misc.rb +136 -139
  48. data/lib/rvg/paint.rb +2 -1
  49. data/lib/rvg/pathdata.rb +7 -8
  50. data/lib/rvg/rvg.rb +47 -46
  51. data/lib/rvg/stretchable.rb +22 -28
  52. data/lib/rvg/stylable.rb +12 -10
  53. data/lib/rvg/text.rb +169 -165
  54. data/lib/rvg/transformable.rb +17 -16
  55. data/lib/rvg/units.rb +5 -5
  56. data/rmagick.gemspec +16 -39
  57. metadata +114 -392
  58. data/.hound.yml +0 -2
  59. data/.simplecov +0 -27
  60. data/.travis.yml +0 -74
  61. data/Doxyfile +0 -1514
  62. data/README.textile +0 -251
  63. data/deprecated/RMagick.rb +0 -6
  64. data/doc/.cvsignore +0 -1
  65. data/doc/comtasks.html +0 -287
  66. data/doc/constants.html +0 -1581
  67. data/doc/css/doc.css +0 -299
  68. data/doc/css/popup.css +0 -34
  69. data/doc/css/ref.css +0 -67
  70. data/doc/draw.html +0 -3272
  71. data/doc/ex/InitialCoords.rb +0 -22
  72. data/doc/ex/NewCoordSys.rb +0 -30
  73. data/doc/ex/OrigCoordSys.rb +0 -16
  74. data/doc/ex/PreserveAspectRatio.rb +0 -204
  75. data/doc/ex/RotateScale.rb +0 -36
  76. data/doc/ex/Skew.rb +0 -38
  77. data/doc/ex/Use01.rb +0 -15
  78. data/doc/ex/Use02.rb +0 -20
  79. data/doc/ex/Use03.rb +0 -16
  80. data/doc/ex/ViewBox.rb +0 -31
  81. data/doc/ex/adaptive_threshold.rb +0 -9
  82. data/doc/ex/add_noise.rb +0 -16
  83. data/doc/ex/affine.rb +0 -48
  84. data/doc/ex/affine_transform.rb +0 -20
  85. data/doc/ex/arc.rb +0 -49
  86. data/doc/ex/arcpath.rb +0 -32
  87. data/doc/ex/arcs01.rb +0 -28
  88. data/doc/ex/arcs02.rb +0 -59
  89. data/doc/ex/average.rb +0 -15
  90. data/doc/ex/axes.rb +0 -64
  91. data/doc/ex/baseline_shift01.rb +0 -17
  92. data/doc/ex/bilevel_channel.rb +0 -8
  93. data/doc/ex/blur_image.rb +0 -12
  94. data/doc/ex/border.rb +0 -10
  95. data/doc/ex/bounding_box.rb +0 -42
  96. data/doc/ex/cbezier1.rb +0 -41
  97. data/doc/ex/cbezier2.rb +0 -41
  98. data/doc/ex/cbezier3.rb +0 -41
  99. data/doc/ex/cbezier4.rb +0 -42
  100. data/doc/ex/cbezier5.rb +0 -42
  101. data/doc/ex/cbezier6.rb +0 -53
  102. data/doc/ex/channel.rb +0 -25
  103. data/doc/ex/charcoal.rb +0 -12
  104. data/doc/ex/chop.rb +0 -29
  105. data/doc/ex/circle.rb +0 -33
  106. data/doc/ex/circle01.rb +0 -16
  107. data/doc/ex/clip_path.rb +0 -60
  108. data/doc/ex/coalesce.rb +0 -57
  109. data/doc/ex/color_fill_to_border.rb +0 -29
  110. data/doc/ex/color_floodfill.rb +0 -28
  111. data/doc/ex/color_histogram.rb +0 -47
  112. data/doc/ex/color_reset.rb +0 -11
  113. data/doc/ex/colorize.rb +0 -16
  114. data/doc/ex/colors.rb +0 -64
  115. data/doc/ex/compose_mask.rb +0 -22
  116. data/doc/ex/composite.rb +0 -133
  117. data/doc/ex/composite_layers.rb +0 -53
  118. data/doc/ex/composite_tiled.rb +0 -21
  119. data/doc/ex/contrast.rb +0 -36
  120. data/doc/ex/crop.rb +0 -31
  121. data/doc/ex/crop_with_gravity.rb +0 -42
  122. data/doc/ex/cubic01.rb +0 -43
  123. data/doc/ex/cubic02.rb +0 -91
  124. data/doc/ex/cycle_colormap.rb +0 -21
  125. data/doc/ex/dissolve.rb +0 -12
  126. data/doc/ex/drawcomp.rb +0 -42
  127. data/doc/ex/drop_shadow.rb +0 -60
  128. data/doc/ex/edge.rb +0 -11
  129. data/doc/ex/ellipse.rb +0 -45
  130. data/doc/ex/ellipse01.rb +0 -21
  131. data/doc/ex/emboss.rb +0 -11
  132. data/doc/ex/enhance.rb +0 -28
  133. data/doc/ex/equalize.rb +0 -11
  134. data/doc/ex/evenodd.rb +0 -42
  135. data/doc/ex/fill_pattern.rb +0 -23
  136. data/doc/ex/flatten_images.rb +0 -36
  137. data/doc/ex/flip.rb +0 -11
  138. data/doc/ex/flop.rb +0 -11
  139. data/doc/ex/font_styles.rb +0 -32
  140. data/doc/ex/fonts.rb +0 -20
  141. data/doc/ex/frame.rb +0 -12
  142. data/doc/ex/gaussian_blur.rb +0 -11
  143. data/doc/ex/get_multiline_type_metrics.rb +0 -41
  144. data/doc/ex/get_pixels.rb +0 -47
  145. data/doc/ex/get_type_metrics.rb +0 -141
  146. data/doc/ex/gradientfill.rb +0 -27
  147. data/doc/ex/grav.rb +0 -45
  148. data/doc/ex/gravity.rb +0 -80
  149. data/doc/ex/group.rb +0 -26
  150. data/doc/ex/hatchfill.rb +0 -27
  151. data/doc/ex/image.rb +0 -44
  152. data/doc/ex/images/Apple.miff +0 -0
  153. data/doc/ex/images/Ballerina.jpg +0 -0
  154. data/doc/ex/images/Ballerina3.jpg +0 -0
  155. data/doc/ex/images/Button_0.gif +0 -0
  156. data/doc/ex/images/Button_1.gif +0 -0
  157. data/doc/ex/images/Button_2.gif +0 -0
  158. data/doc/ex/images/Button_3.gif +0 -0
  159. data/doc/ex/images/Button_4.gif +0 -0
  160. data/doc/ex/images/Button_5.gif +0 -0
  161. data/doc/ex/images/Button_6.gif +0 -0
  162. data/doc/ex/images/Button_7.gif +0 -0
  163. data/doc/ex/images/Button_8.gif +0 -0
  164. data/doc/ex/images/Button_9.gif +0 -0
  165. data/doc/ex/images/Button_A.gif +0 -0
  166. data/doc/ex/images/Button_B.gif +0 -0
  167. data/doc/ex/images/Button_C.gif +0 -0
  168. data/doc/ex/images/Button_D.gif +0 -0
  169. data/doc/ex/images/Button_E.gif +0 -0
  170. data/doc/ex/images/Button_F.gif +0 -0
  171. data/doc/ex/images/Button_G.gif +0 -0
  172. data/doc/ex/images/Button_H.gif +0 -0
  173. data/doc/ex/images/Button_I.gif +0 -0
  174. data/doc/ex/images/Button_J.gif +0 -0
  175. data/doc/ex/images/Button_K.gif +0 -0
  176. data/doc/ex/images/Button_L.gif +0 -0
  177. data/doc/ex/images/Button_M.gif +0 -0
  178. data/doc/ex/images/Button_N.gif +0 -0
  179. data/doc/ex/images/Button_O.gif +0 -0
  180. data/doc/ex/images/Button_P.gif +0 -0
  181. data/doc/ex/images/Button_Q.gif +0 -0
  182. data/doc/ex/images/Button_R.gif +0 -0
  183. data/doc/ex/images/Button_S.gif +0 -0
  184. data/doc/ex/images/Button_T.gif +0 -0
  185. data/doc/ex/images/Button_U.gif +0 -0
  186. data/doc/ex/images/Button_V.gif +0 -0
  187. data/doc/ex/images/Button_W.gif +0 -0
  188. data/doc/ex/images/Button_X.gif +0 -0
  189. data/doc/ex/images/Button_Y.gif +0 -0
  190. data/doc/ex/images/Button_Z.gif +0 -0
  191. data/doc/ex/images/Cheetah.jpg +0 -0
  192. data/doc/ex/images/Coffee.wmf +0 -0
  193. data/doc/ex/images/Flower_Hat.jpg +0 -0
  194. data/doc/ex/images/Gold_Statue.jpg +0 -0
  195. data/doc/ex/images/Hot_Air_Balloons.jpg +0 -0
  196. data/doc/ex/images/Hot_Air_Balloons_H.jpg +0 -0
  197. data/doc/ex/images/Leaf.miff +0 -0
  198. data/doc/ex/images/No.wmf +0 -0
  199. data/doc/ex/images/Polynesia.jpg +0 -0
  200. data/doc/ex/images/Red_Rocks.jpg +0 -0
  201. data/doc/ex/images/Rocks_On_Beach.miff +0 -0
  202. data/doc/ex/images/Shorts.jpg +0 -0
  203. data/doc/ex/images/Snake.wmf +0 -0
  204. data/doc/ex/images/Violin.jpg +0 -0
  205. data/doc/ex/images/Yellow_Rose.miff +0 -0
  206. data/doc/ex/images/big-duck.gif +0 -0
  207. data/doc/ex/images/duck.gif +0 -0
  208. data/doc/ex/images/duck0.gif +0 -0
  209. data/doc/ex/images/duck1.gif +0 -0
  210. data/doc/ex/images/duck10.gif +0 -0
  211. data/doc/ex/images/duck11.gif +0 -0
  212. data/doc/ex/images/duck12.gif +0 -0
  213. data/doc/ex/images/duck13.gif +0 -0
  214. data/doc/ex/images/duck14.gif +0 -0
  215. data/doc/ex/images/duck15.gif +0 -0
  216. data/doc/ex/images/duck2.gif +0 -0
  217. data/doc/ex/images/duck3.gif +0 -0
  218. data/doc/ex/images/duck4.gif +0 -0
  219. data/doc/ex/images/duck5.gif +0 -0
  220. data/doc/ex/images/duck6.gif +0 -0
  221. data/doc/ex/images/duck7.gif +0 -0
  222. data/doc/ex/images/duck8.gif +0 -0
  223. data/doc/ex/images/duck9.gif +0 -0
  224. data/doc/ex/images/graydient230x6.gif +0 -0
  225. data/doc/ex/images/image_with_profile.jpg +0 -0
  226. data/doc/ex/images/logo400x83.gif +0 -0
  227. data/doc/ex/images/model.miff +0 -0
  228. data/doc/ex/images/notimplemented.gif +0 -0
  229. data/doc/ex/images/smile.miff +0 -0
  230. data/doc/ex/images/spin.gif +0 -0
  231. data/doc/ex/implode.rb +0 -34
  232. data/doc/ex/level.rb +0 -11
  233. data/doc/ex/level_colors.rb +0 -11
  234. data/doc/ex/line.rb +0 -41
  235. data/doc/ex/line01.rb +0 -21
  236. data/doc/ex/mask.rb +0 -35
  237. data/doc/ex/matte_fill_to_border.rb +0 -39
  238. data/doc/ex/matte_floodfill.rb +0 -32
  239. data/doc/ex/matte_replace.rb +0 -39
  240. data/doc/ex/median_filter.rb +0 -28
  241. data/doc/ex/modulate.rb +0 -11
  242. data/doc/ex/mono.rb +0 -23
  243. data/doc/ex/morph.rb +0 -25
  244. data/doc/ex/mosaic.rb +0 -35
  245. data/doc/ex/motion_blur.rb +0 -11
  246. data/doc/ex/negate.rb +0 -11
  247. data/doc/ex/negate_channel.rb +0 -9
  248. data/doc/ex/nested_rvg.rb +0 -21
  249. data/doc/ex/nonzero.rb +0 -42
  250. data/doc/ex/normalize.rb +0 -11
  251. data/doc/ex/oil_paint.rb +0 -11
  252. data/doc/ex/opacity.rb +0 -37
  253. data/doc/ex/ordered_dither.rb +0 -11
  254. data/doc/ex/path.rb +0 -63
  255. data/doc/ex/pattern1.rb +0 -25
  256. data/doc/ex/pattern2.rb +0 -26
  257. data/doc/ex/polaroid.rb +0 -27
  258. data/doc/ex/polygon.rb +0 -23
  259. data/doc/ex/polygon01.rb +0 -21
  260. data/doc/ex/polyline.rb +0 -22
  261. data/doc/ex/polyline01.rb +0 -21
  262. data/doc/ex/posterize.rb +0 -8
  263. data/doc/ex/preview.rb +0 -8
  264. data/doc/ex/qbezierpath.rb +0 -52
  265. data/doc/ex/quad01.rb +0 -34
  266. data/doc/ex/quantize-m.rb +0 -25
  267. data/doc/ex/radial_blur.rb +0 -9
  268. data/doc/ex/raise.rb +0 -8
  269. data/doc/ex/random_threshold_channel.rb +0 -13
  270. data/doc/ex/rect01.rb +0 -14
  271. data/doc/ex/rect02.rb +0 -20
  272. data/doc/ex/rectangle.rb +0 -34
  273. data/doc/ex/reduce_noise.rb +0 -28
  274. data/doc/ex/remap.rb +0 -11
  275. data/doc/ex/remap_images.rb +0 -19
  276. data/doc/ex/resize_to_fill.rb +0 -8
  277. data/doc/ex/resize_to_fit.rb +0 -8
  278. data/doc/ex/roll.rb +0 -9
  279. data/doc/ex/rotate.rb +0 -44
  280. data/doc/ex/rotate_f.rb +0 -14
  281. data/doc/ex/roundrect.rb +0 -33
  282. data/doc/ex/rubyname.rb +0 -30
  283. data/doc/ex/rvg_clippath.rb +0 -12
  284. data/doc/ex/rvg_linecap.rb +0 -42
  285. data/doc/ex/rvg_linejoin.rb +0 -40
  286. data/doc/ex/rvg_opacity.rb +0 -18
  287. data/doc/ex/rvg_pattern.rb +0 -26
  288. data/doc/ex/rvg_stroke_dasharray.rb +0 -11
  289. data/doc/ex/segment.rb +0 -11
  290. data/doc/ex/sepiatone.rb +0 -7
  291. data/doc/ex/shade.rb +0 -11
  292. data/doc/ex/shadow.rb +0 -30
  293. data/doc/ex/shave.rb +0 -15
  294. data/doc/ex/shear.rb +0 -10
  295. data/doc/ex/sketch.rb +0 -17
  296. data/doc/ex/skewx.rb +0 -51
  297. data/doc/ex/skewy.rb +0 -47
  298. data/doc/ex/smile.rb +0 -125
  299. data/doc/ex/solarize.rb +0 -11
  300. data/doc/ex/sparse_color.rb +0 -54
  301. data/doc/ex/splice.rb +0 -8
  302. data/doc/ex/spread.rb +0 -11
  303. data/doc/ex/stegano.rb +0 -55
  304. data/doc/ex/stroke_dasharray.rb +0 -42
  305. data/doc/ex/stroke_fill.rb +0 -10
  306. data/doc/ex/stroke_linecap.rb +0 -44
  307. data/doc/ex/stroke_linejoin.rb +0 -48
  308. data/doc/ex/stroke_width.rb +0 -49
  309. data/doc/ex/swirl.rb +0 -17
  310. data/doc/ex/text.rb +0 -37
  311. data/doc/ex/text01.rb +0 -16
  312. data/doc/ex/text_align.rb +0 -36
  313. data/doc/ex/text_antialias.rb +0 -37
  314. data/doc/ex/text_styles.rb +0 -19
  315. data/doc/ex/text_undercolor.rb +0 -28
  316. data/doc/ex/texture_fill_to_border.rb +0 -34
  317. data/doc/ex/texture_floodfill.rb +0 -32
  318. data/doc/ex/texturefill.rb +0 -24
  319. data/doc/ex/threshold.rb +0 -13
  320. data/doc/ex/to_blob.rb +0 -13
  321. data/doc/ex/translate.rb +0 -39
  322. data/doc/ex/transparent.rb +0 -38
  323. data/doc/ex/transpose.rb +0 -9
  324. data/doc/ex/transverse.rb +0 -9
  325. data/doc/ex/tref01.rb +0 -24
  326. data/doc/ex/triangle01.rb +0 -15
  327. data/doc/ex/trim.rb +0 -23
  328. data/doc/ex/tspan01.rb +0 -17
  329. data/doc/ex/tspan02.rb +0 -17
  330. data/doc/ex/tspan03.rb +0 -19
  331. data/doc/ex/unsharp_mask.rb +0 -28
  332. data/doc/ex/viewex.rb +0 -33
  333. data/doc/ex/vignette.rb +0 -12
  334. data/doc/ex/watermark.rb +0 -27
  335. data/doc/ex/wave.rb +0 -9
  336. data/doc/ex/wet_floor.rb +0 -58
  337. data/doc/ex/writing_mode01.rb +0 -26
  338. data/doc/ex/writing_mode02.rb +0 -26
  339. data/doc/ilist.html +0 -2056
  340. data/doc/image1.html +0 -4680
  341. data/doc/image2.html +0 -3665
  342. data/doc/image3.html +0 -4522
  343. data/doc/imageattrs.html +0 -1638
  344. data/doc/imusage.html +0 -514
  345. data/doc/index.html +0 -416
  346. data/doc/info.html +0 -1499
  347. data/doc/magick.html +0 -565
  348. data/doc/optequiv.html +0 -2435
  349. data/doc/rvg.html +0 -975
  350. data/doc/rvgclip.html +0 -248
  351. data/doc/rvggroup.html +0 -305
  352. data/doc/rvgimage.html +0 -289
  353. data/doc/rvgpattern.html +0 -475
  354. data/doc/rvgshape.html +0 -406
  355. data/doc/rvgstyle.html +0 -270
  356. data/doc/rvgtext.html +0 -465
  357. data/doc/rvgtspan.html +0 -238
  358. data/doc/rvgtut.html +0 -530
  359. data/doc/rvguse.html +0 -145
  360. data/doc/rvgxform.html +0 -294
  361. data/doc/scripts/doc.js +0 -22
  362. data/doc/scripts/stripeTables.js +0 -23
  363. data/doc/struct.html +0 -1339
  364. data/doc/usage.html +0 -1621
  365. data/examples/constitute.rb +0 -7
  366. data/examples/crop_with_gravity.rb +0 -42
  367. data/examples/demo.rb +0 -324
  368. data/examples/describe.rb +0 -43
  369. data/examples/find_similar_region.rb +0 -34
  370. data/examples/histogram.rb +0 -321
  371. data/examples/identify.rb +0 -185
  372. data/examples/image_opacity.rb +0 -29
  373. data/examples/import_export.rb +0 -31
  374. data/examples/pattern_fill.rb +0 -38
  375. data/examples/rotating_text.rb +0 -44
  376. data/examples/spinner.rb +0 -49
  377. data/examples/thumbnail.rb +0 -64
  378. data/examples/vignette.rb +0 -78
  379. data/spec/rmagick/ImageList1_spec.rb +0 -24
  380. data/spec/rmagick/draw_spec.rb +0 -156
  381. data/spec/rmagick/image/blue_shift_spec.rb +0 -16
  382. data/spec/rmagick/image/composite_spec.rb +0 -140
  383. data/spec/rmagick/image/constitute_spec.rb +0 -15
  384. data/spec/rmagick/image/dispatch_spec.rb +0 -18
  385. data/spec/rmagick/image/from_blob_spec.rb +0 -14
  386. data/spec/rmagick/image/ping_spec.rb +0 -14
  387. data/spec/rmagick/image/properties_spec.rb +0 -29
  388. data/spec/spec_helper.rb +0 -4
  389. data/test/Image1.rb +0 -565
  390. data/test/Image2.rb +0 -1304
  391. data/test/Image3.rb +0 -1030
  392. data/test/ImageList1.rb +0 -806
  393. data/test/ImageList2.rb +0 -385
  394. data/test/Image_attributes.rb +0 -697
  395. data/test/Import_Export.rb +0 -121
  396. data/test/Info.rb +0 -345
  397. data/test/Magick.rb +0 -321
  398. data/test/Pixel.rb +0 -116
  399. data/test/Preview.rb +0 -57
  400. data/test/cmyk.icm +0 -0
  401. data/test/srgb.icm +0 -0
  402. data/test/test_all_basic.rb +0 -38
  403. data/test/tmpnam_test.rb +0 -50
  404. data/wercker.yml +0 -10
data/doc/rvgtut.html DELETED
@@ -1,530 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
-
5
- <html xmlns="http://www.w3.org/1999/xhtml">
6
- <!-- $Id: rvgtut.html,v 1.14 2008/03/08 00:28:45 rmagick Exp $ -->
7
-
8
- <head>
9
- <meta name="generator" content=
10
- "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
11
-
12
- <title>RMagick 0.0.0: RVG Tutorial</title>
13
- <meta name="GENERATOR" content="Quanta Plus" />
14
- <link rel="stylesheet" type="text/css" href="css/doc.css" />
15
- <style type="text/css">
16
- /*<![CDATA[*/
17
- img {
18
- padding-bottom:1em;
19
- padding-top:1em;
20
- }
21
- /*]]>*/
22
- </style>
23
- </head>
24
-
25
- <body>
26
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
27
-
28
- <div class="nav">
29
- &laquo;&nbsp;<a href="constants.html">Prev</a> | <a href=
30
- "index.html">Contents</a> | <a href=
31
- "rvg.html">Next</a>&nbsp;&raquo;
32
- </div>
33
-
34
- <h1>Drawing with RVG</h1>
35
-
36
- <div id="toc">
37
- <h2>A tutorial</h2>
38
- </div>
39
-
40
- <div style="position:relative;">
41
- <p><img src="ex/images/duck.gif" alt="duck|type" width="180"
42
- height="180" /></p>
43
-
44
- <div style="position:absolute; left: 200px;top:1em">
45
- <h3>Introduction</h3>
46
-
47
- <p>RVG (Ruby Vector Graphics) is a facade for RMagick's
48
- <a href="draw.html">Draw</a> class that supplies a drawing
49
- API based on the <a href=
50
- "http://www.w3.org/Graphics/SVG/">Scalable Vector
51
- Graphics</a> W3C recommendation.</p>
52
-
53
- <p>RVG is a <em>scalable</em> <em>vector</em> drawing
54
- library. <em>Scalable</em> means that drawings are not fixed
55
- to a single size in pixels. The same drawing can be rendered
56
- for a screen display or for printing. <em>Vector</em> images
57
- are drawn using geometric objects like lines and circles.
58
- Unlike raster images, vector images don't get "pixelated"
59
- when you make them bigger.</p>As an introduction to the RVG
60
- library, let's see how to draw this little duck on the left.
61
- Here is the complete program.
62
- </div>
63
- </div>
64
- <pre class="example">
65
- 1 require 'rvg/rvg'
66
- 2 include Magick
67
- 3
68
- 4 RVG::dpi = 72
69
- 5
70
- 6 rvg = RVG.new(2.5.in, 2.5.in).viewbox(0,0,250,250) do |canvas|
71
- 7 canvas.background_fill = 'white'
72
- 8
73
- 9 canvas.g.translate(100, 150).rotate(-30) do |body|
74
- 10 body.styles(:fill=&gt;'yellow', :stroke=&gt;'black', :stroke_width=&gt;2)
75
- 11 body.ellipse(50, 30)
76
- 12 body.rect(45, 20, -20, -10).skewX(-35)
77
- 13 end
78
- 14
79
- 15 canvas.g.translate(130, 83) do |head|
80
- 16 head.styles(:stroke=&gt;'black', :stroke_width=&gt;2)
81
- 17 head.circle(30).styles(:fill=&gt;'yellow')
82
- 18 head.circle(5, 10, -5).styles(:fill=&gt;'black')
83
- 19 head.polygon(30,0, 70,5, 30,10, 62,25, 23,20).styles(:fill=&gt;'orange')
84
- 20 end
85
- 21
86
- 22 foot = RVG::Group.new do |_foot|
87
- 23 _foot.path('m0,0 v30 l30,10 l5,-10, l-5,-10 l-30,10z').
88
- 24 styles(:stroke_width=&gt;2, :fill=&gt;'orange', :stroke=&gt;'black')
89
- 25 end
90
- 26 canvas.use(foot).translate(75, 188).rotate(15)
91
- 27 canvas.use(foot).translate(100, 185).rotate(-15)
92
- 28
93
- 29 canvas.text(125, 30) do |title|
94
- 30 title.tspan("duck|").styles(:text_anchor=&gt;'end', :font_size=&gt;20,
95
- 31 :font_family=&gt;'helvetica', :fill=&gt;'black')
96
- 32 title.tspan("type").styles(:font_size=&gt;22,
97
- 33 :font_family=&gt;'times', :font_style=&gt;'italic', :fill=&gt;'red')
98
- 34 end
99
- 35 canvas.rect(249,249).styles(:stroke=&gt;'blue', :fill=&gt;'none')
100
- 36 end
101
- 37
102
- 38 rvg.draw.write('duck.gif')
103
- </pre>
104
-
105
- <h2>Summary</h2>
106
-
107
- <p>All drawings follow the same 3 steps:</p>
108
-
109
- <ol>
110
- <li>Create an RVG object. Specify the width and height of the
111
- final image. The <code>RVG.new</code> method yields to a
112
- block.</li>
113
-
114
- <li>Within the block, call methods on the RVG object to specify
115
- a background, add shapes, text, or raster images, or add groups
116
- of shapes, text, or raster images.</li>
117
-
118
- <li>Call the <code>draw</code> method to draw the shapes, text,
119
- or raster images onto the background.</li>
120
- </ol>
121
-
122
- <p>I'll step through the example line-by-line.</p>
123
-
124
- <h2>Lines 1-3</h2>
125
- <pre class="example">
126
- 1 require 'rvg/rvg'
127
- 2 include Magick
128
- </pre>
129
-
130
- <p>These are just the usual Ruby code to load the RVG extension.
131
- To save some typing, I've included the Magick module into
132
- Object's namespace.</p>
133
-
134
- <h2>Lines 4-6</h2>
135
- <pre class="example">
136
- 4 RVG::dpi = 72
137
- 5
138
- 6 rvg = RVG.new(2.5.in, 2.5.in).viewbox(0,0,250,250) do |canvas|
139
- </pre>
140
-
141
- <p><code>RVG::dpi</code> enables the use of <em>unit methods</em>
142
- in RVG. When you set <code>RVG::dpi</code> to a non-nil value,
143
- RVG adds a number of conversion methods to the Fixnum and Float
144
- classes . These methods allow you to specify measurements in
145
- units such as inches, millimeters, and centimeters. <em>DPI</em>
146
- stands for "dots per inch," the image resolution. Here I set
147
- <code>RVG::dpi</code> to 72, a common value for displays.</p>
148
-
149
- <p>The <code>RVG.new</code> method accepts 2 parameters. These
150
- parameters specify the width and height of the final image in
151
- pixels. Since I've defined <code>RVG::dpi</code>, I can specify
152
- these values in inches using the <code>in</code> conversion
153
- method. At 72dpi, the final image will be 2.5*72=180 pixels on a
154
- side.</p>
155
-
156
- <p>By default, RVG uses pixels as its unit of measurement, but
157
- since I'm drawing a scalable picture I don't want to confine
158
- myself to pixels. The <code>viewbox</code> method defines a
159
- coordinate system with a logical unit. <code>Viewbox</code> takes
160
- 4 parameters, <code>min_x</code>, <code>min_y</code>,
161
- <code>width</code>, and <code>height</code>. On line 6 I define
162
- my coordinate system to have its origin at (0,0) and a width and
163
- height of 250 units. By using my own coordinate system, I can
164
- later change the size of the image to 5 inches square or 1 inch
165
- square just by changing the arguments to <code>new</code>.</p>
166
-
167
- <div style="position:relative">
168
- <p><img src="ex/images/duck0.gif" alt=
169
- "default coordinate system" width="180" height="180" /></p>
170
-
171
- <div style="position:absolute; left:200px;top:0;">
172
- <p><strong>The default coordinate system</strong></p>
173
-
174
- <p>By default, the RVG coordinate system has its origin in
175
- the upper-left corner. The x-axis proceeds to the right. The
176
- y-axis proceeds downwards. The image on the left shows the
177
- axes of this coordinate system. I've added a light-blue
178
- "graph-paper" background to the example images to help
179
- associate the coordinate arguments to the actual locations in
180
- the image. Just remember that the axes and graph-paper
181
- background are not actually part of the image I'm
182
- producing.</p>
183
- </div>
184
- </div>
185
-
186
- <p>The RVG class is one of the <em>container</em> classes defined
187
- by RVG. Container objects can contain graphic objects such as
188
- circles and lines, text, raster images, and other container
189
- objects. The outermost container is always an RVG object. I will
190
- add all the graphic objects that form the duck to this
191
- container.</p>
192
-
193
- <p>Container constructors normally yield to a block. However,
194
- here I've chained <code>viewbox</code> to <code>new</code>, so
195
- <code>viewbox</code> takes responsibility for yielding and passes
196
- the new instance of RVG to the <code>canvas</code> argument.</p>
197
-
198
- <h2>Line 7</h2>
199
- <pre class="example">
200
- 7 canvas.background_fill = 'white'
201
- </pre>
202
-
203
- <p>By default, RVG graphics are drawn on a transparent
204
- background. This is convenient when you want to display your
205
- image over another image. You can override the default background
206
- color by assigning a color to the <code>background_fill=</code>
207
- attribute. Here I set the background color to "white."</p>
208
-
209
- <h2>Lines 9-13</h2>
210
- <pre class="example">
211
- 9 canvas.g.translate(100, 150).rotate(-30) do |body|
212
- 10 body.styles(:fill=&gt;'yellow', :stroke=&gt;'black', :stroke_width=&gt;2)
213
- 11 body.ellipse(50, 30)
214
- 12 body.rect(45, 20, -20, -10).skewX(-35)
215
- 13 end
216
- </pre>
217
-
218
- <p>There's a lot going on in these few lines - seven method calls
219
- - so let's take it one method at a time.</p>
220
-
221
- <h3>Groups</h3>
222
-
223
- <p><code>Group</code> is the second container class in RVG. The
224
- purpose of a group is to associate a set of coordinate system
225
- transformations and a set of styles with the graphic objects
226
- within the group. To create a Group object within another
227
- container, call the <code>g</code> method on the container. The
228
- <code>g</code> method yields if a block is present. In this
229
- example, there is no block associated with <code>g</code>, so
230
- <code>g</code> returns the new group. The <code>g</code> method
231
- adds the group to the content of its container. In this example,
232
- the group's container is the canvas object created in line 6. The
233
- graphic objects in the group are drawn as part of drawing the
234
- container. The <code>translate</code> and <code>rotate</code>
235
- chained to <code>g</code> modify the group by adding
236
- <em>coordinate system transforms</em>.</p>
237
-
238
- <p>(Okay, there <em>is</em> a block, but there are 2 method calls
239
- between <code>g</code> and the block. I'll explain more
240
- later.)</p>
241
-
242
- <h3>Transforms</h3>
243
-
244
- <p>I'm going to use this group to contain the ellipse that forms
245
- the duck's body and the rectangle that forms the wing. I could
246
- just specify x- and y-coordinates to position these shapes
247
- relative to the origin, but it's easier to move the origin to
248
- where I want to draw the shapes. This is the purpose of the
249
- <code>translate</code> method. This method moves the origin to
250
- the (x,y) position specified by its arguments. I call
251
- <code>translate</code> on the group object, and since the content
252
- of the group gets the coordinate system transformations specified
253
- for the group, the ellipse and the rectangle will be drawn on a
254
- coordinate system with the origin at (100, 150) relative to the
255
- old coordinate system.</p>
256
-
257
- <p>Also, I want the duck's body to slant upward, so I use the
258
- <code>rotate</code> method to rotate the axes. The argument to
259
- <code>rotate</code> is the number of degrees of rotation. A
260
- negative number indicates counter-clockwise rotation.</p>
261
-
262
- <p>After translating and rotating the coordinate system, the axes
263
- look like this:</p>
264
-
265
- <div style="position:relative">
266
- <p><img src="ex/images/duck1.gif" width="180" height="180" alt=
267
- "duck body" /></p>
268
-
269
- <div style="position:absolute; left:200px;top:0">
270
- <p><strong>The transform methods</strong></p>
271
-
272
- <p>There are six transform methods. In addition to
273
- <code>translate</code> and <code>rotate</code>, there's
274
- <code>scale</code>, <code>skewX</code>, <code>skewY</code>,
275
- and <code>matrix</code>. When groups are nested, any
276
- transforms defined on the inner group(s) are added to the
277
- outer transforms.</p>
278
- </div>
279
- </div>
280
-
281
- <h3>Styles</h3>
282
-
283
- <p>Recall that the <code>styles</code> method modifies the
284
- default group styles. The <code>styles</code> method takes a hash
285
- as an argument. The hash keys are style names, and the hash
286
- values are, well, style values. In this example there are three
287
- style names. The :fill style sets the fill color to 'yellow'. The
288
- :stroke style sets the outline color to 'black'. The
289
- :stroke_width style sets the width of the outline to 2. I want
290
- the styles to apply to all objects within the group so in line 10
291
- I call <code>styles</code> on the new group object.</p>
292
-
293
- <p>The <code>styles</code> method is a real workhorse. It's
294
- defined in almost every class in RVG and there are many other
295
- style names in addition to these three..</p>
296
-
297
- <h3>Basic shapes</h3>
298
-
299
- <p>The group contains two basic shapes, an ellipse and a
300
- rectangle. I add the ellipse to the group with the
301
- <code>ellipse</code> method. <code>Ellipse</code> has four
302
- parameters. The first two, the radius on the x-axis and the
303
- radius on the y-axis, are required. The last two are the (x,y)
304
- coordinate of the center. When these are omitted, as here, they
305
- default to (0,0). I add the rectangle with the <code>rect</code>
306
- method, which also has four parameters. The first two are the
307
- width and height of the rectangle. The last two are the (x,y)
308
- coordinate of the upper-left corner. Both of these methods return
309
- <code>self</code>, so you can chain other methods to them.</p>
310
-
311
- <p>Here's what the group looks like when rendered. The ellipse is
312
- centered on the origin. The upper-left corner of the rectangle is
313
- slightly up and to the left of the origin.</p>
314
-
315
- <div style="position:relative">
316
- <p><img src="ex/images/duck3.gif" alt=
317
- "default coordinate system" width="180" height="180" /></p>
318
-
319
- <div style="position:absolute; left:200px;top:0">
320
- <p><strong>The shape methods</strong></p>
321
-
322
- <p>There are 7 shape methods. In addition to
323
- <code>ellipse</code> and <code>rect</code>, there's
324
- <code>circle</code>, <code>line</code>, <code>path</code>,
325
- <code>polygon</code>, and <code>polyline</code>. You can also
326
- think of text as a shape. Shapes are stroked and filled, and
327
- can be modified by the transform methods and the
328
- <code>styles</code> method.</p>
329
- </div>
330
- </div>
331
-
332
- <h3>SkewX</h3>
333
-
334
- <p>Everybody knows that a wing doesn't look like a rectangle! A
335
- wing looks like a slanted parallelogram. (Well, it does in this
336
- example!) Fortunately, I can use the transform methods on shapes
337
- as well as containers. The <code>skewX</code> method makes it
338
- easy for us to give the rectangle a slant. The <code>skewX</code>
339
- method is another transform. It takes a single argument, the
340
- number of degrees to skew the x-axis. Since all the shape
341
- constructors, including <code>rect</code>, return
342
- <code>self</code>, I can chain <code>skewX</code> directly to
343
- <code>rect</code> and limit the effect of the transform to just
344
- the rectangle. The result looks like this. (I've drawn in the
345
- axes for the wing coordinate system.)</p>
346
-
347
- <p><img src="ex/images/duck4.gif" width="180" height="180" alt=
348
- "duck wing" /></p>
349
-
350
- <p>That's it for the body. Let's tie up one loose end before
351
- moving on. I said earlier that container constructors (such as
352
- <code>g</code>) yield to a block if present. In this case,
353
- though, the <code>translate</code> and <code>rotate</code>
354
- methods intervene between <code>g</code> and the block. All the
355
- transform methods yield when there is an associated block, so I
356
- can easily chain them to a container constructor and still use a
357
- block argument to define the graphic objects in the group. Method
358
- chaining is a common RVG idiom. You'll see it a lot in the
359
- examples.</p>
360
-
361
- <p>The next group draws the head.</p>
362
-
363
- <h2>Lines 15-20</h2>
364
- <pre class="example">
365
- 15 canvas.g.translate(130, 83) do |head|
366
- 16 head.styles(:stroke=&gt;'black', :stroke_width=&gt;2)
367
- 17 head.circle(30).styles(:fill=&gt;'yellow')
368
- 18 head.circle(5, 10, -5).styles(:fill=&gt;'black')
369
- 19 head.polygon(30,0, 70,5, 30,10, 62,25, 23,20).styles(:fill=&gt;'orange')
370
- 20 end
371
- </pre>
372
-
373
- <p>This section is very similar to the previous one. I'm defining
374
- a group to contain the graphic objects that draw the duck's head,
375
- eye, and beak. First I use the translate method to move the
376
- origin to (130,83):</p>
377
-
378
- <p><img src="ex/images/duck6.gif" width="180" height="180" alt=
379
- "duck head" /></p>
380
-
381
- <p>In line 16 I define the <code>stroke</code> and
382
- <code>stroke_width</code> styles on the group. Styles defined on
383
- the group propagate to shapes within the group unless you
384
- override them. To do that, call <code>styles</code> on the
385
- shapes. In this group each shape has its own fill color. The
386
- yellow circle forms the head. The <code>circle</code> method
387
- takes 3 parameters. The first parameter is the radius of the
388
- circle. The other two parameters are the (x,y) coordinate of the
389
- center. If omitted, as here, they default to (0,0). I use a small
390
- black circle for the eye.</p>
391
-
392
- <p>Last, I use the <code>polygon</code> method to draw the beak.
393
- This method draws a polygon from a series of (x,y) coordinates.
394
- If the last coordinate is not the same as the first,
395
- <code>polygon</code> implicitly adds it to close the polygon.
396
- Again, I use <code>styles</code> to set the fill color to
397
- orange.</p>
398
-
399
- <p><img src="ex/images/duck8.gif" width="180" height="180" alt=
400
- "duck head final" /></p>
401
-
402
- <h2>Lines 22-25</h2>
403
- <pre class="example">
404
- 22 foot = RVG::Group.new do |_foot|
405
- 23 _foot.path('m0,0 v30 l30,10 l5,-10, l-5,-10 l-30,10z').
406
- 24 styles(:stroke_width=&gt;2, :fill=&gt;'orange', :stroke=&gt;'black')
407
- 25 end
408
- </pre>
409
-
410
- <p>Here I create a group by directly calling <code>new</code>
411
- instead of calling the <code>g</code> method on a container. This
412
- creates a group object that is not contained within the canvas.
413
- You might think of the foot as not being attached to anything,
414
- like this:</p>
415
-
416
- <p><img src="ex/images/duck9.gif" width="180" height="180" alt=
417
- "duck foot" /></p>
418
-
419
- <h2>Lines 26-27</h2>
420
- <pre class="example">
421
- 26 canvas.use(foot).translate(75, 188).rotate(15)
422
- 27 canvas.use(foot).translate(100, 185).rotate(-15)
423
- </pre>
424
-
425
- <p>To add the group to the canvas I use the <code>use</code>
426
- method. The use method can accept any container or graphic object
427
- as an argument. Optionally you can specify an (x,y) coordinate
428
- that specifies where to position the objects. In this example,
429
- however, I let those arguments default to (0,0) and use
430
- <code>translate</code> to position the feet. Here's how the left
431
- foot attaches to the duck:</p>
432
-
433
- <p><img src="ex/images/duck10.gif" width="180" height="180" alt=
434
- "duck foot 2" /></p>
435
-
436
- <p>Of course, the duck is walking, so I have to give the foot a
437
- little slant with <code>rotate</code>:</p>
438
-
439
- <p><img src="ex/images/duck11.gif" width="180" height="180" alt=
440
- "duck foot 3" /></p>
441
-
442
- <p>Attaching the right foot is easy. Call <code>use</code> again
443
- but give different arguments to <code>translate</code> and
444
- <code>rotate</code>:</p>
445
-
446
- <p><img src="ex/images/duck12.gif" width="180" height="180" alt=
447
- "final duck foot" /></p>
448
-
449
- <h2>Lines 29-34</h2>
450
- <pre class="example">
451
- 29 canvas.text(125, 30) do |title|
452
- 30 title.tspan("duck|").styles(:text_anchor=&gt;'end', :font_size=&gt;20,
453
- 31 :font_family=&gt;'helvetica', :fill=&gt;'black')
454
- 32 title.tspan("type").styles(:font_size=&gt;22,
455
- 33 :font_family=&gt;'times', :font_style=&gt;'italic', :fill=&gt;'red')
456
- 34 end
457
- </pre>
458
-
459
- <p>All I need now is a title for the picture. Text in RVG is a
460
- job for the <code>text</code> method. Like the shape methods,
461
- <code>text</code> can be used with any container object.
462
- <code>Text</code> itself is a container, except that it can only
463
- contain text-related objects. The <code>text</code> method takes
464
- 2 or 3 arguments, an (x,y) pair and optionally a string. The
465
- (x,y) pair define a <em>current text position</em> at which
466
- rendering starts. If there is a string argument, it will be
467
- rendered starting at the current text position. Rendering text
468
- changes the current text position to the end of the text.</p>
469
-
470
- <p>In the example, text is used as a container. Text objects can
471
- contain Tspan objects. Each tspan can specify its own styles. By
472
- default each tspan is rendered starting at the current text
473
- position.</p>
474
-
475
- <p>As usual, I can change the appearance of the text with
476
- <code>styles</code>. Here I choose a font, a font style (the
477
- default is "normal"), its size in points, and the color.</p>
478
-
479
- <p><img src="ex/images/duck14.gif" width="180" height="180" alt=
480
- "duck title" /></p>
481
-
482
- <h2>Line 35</h2>
483
- <pre class="example">
484
- 35 canvas.rect(249,249).styles(:stroke=&gt;'blue', :fill=&gt;'none')
485
- </pre>
486
-
487
- <p>I'm almost done. All I need to do it add a blue border. (I'm
488
- going to remove the graph paper background because we don't need
489
- it any more.)</p>
490
-
491
- <p><img src="ex/images/duck15.gif" width="180" height="180" alt=
492
- "duck with border" /></p>
493
-
494
- <h2>Line 38</h2>
495
- <pre class="example">
496
- 38 rvg.draw.write('duck.gif')
497
- </pre>
498
-
499
- <p>The <code>draw</code> method call doesn't occupy a lot of
500
- space - just 4 letters - but does a lot of work. The
501
- <code>draw</code> method goes through all the graphics objects
502
- that I've added to the outermost RVG container and draws them on
503
- the background. When the drawing is complete, <code>draw</code>
504
- returns the drawing in the form of an RMagick Image object. You
505
- can use any Image class methods on the drawing. Here I simply
506
- write the image to a GIF file.</p>
507
-
508
- <h2>Scalable graphics</h2>
509
-
510
- <p>Are RVG images really scalable? Let's try. Change the RVG.new
511
- call to make an image that's 4 times as big. That's 5 inches on a
512
- side:</p>
513
- <pre class="example">
514
- 6 rvg = RVG.new(5.in, 5.in).viewbox(0,0,250,250) do |canvas|
515
- </pre>
516
-
517
- <p>Change nothing else. Run the program again and see what you
518
- get.</p>
519
-
520
- <p><img src="ex/images/big-duck.gif" width="360" height="360"
521
- alt="big duck" /></p>
522
-
523
- <p class="spacer">&nbsp;</p>
524
-
525
- <div class="nav">
526
- &laquo; <a href="constants.html">Prev</a> | <a href=
527
- "index.html">Contents</a> | <a href="rvg.html">Next</a> &raquo;
528
- </div>
529
- </body>
530
- </html>
data/doc/rvguse.html DELETED
@@ -1,145 +0,0 @@
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=
7
- "HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
8
-
9
- <title>RMagick 0.0.0: RVG Reference: RVG::Use Class</title>
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=
14
- "Copyright (C) 2006 by Timothy P. Hunter" />
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>
30
- <h6 id="header">RMagick 0.0.0 User's Guide and Reference</h6>
31
-
32
- <div class="nav">
33
- &laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href=
34
- "index.html">Contents</a> | <a href=
35
- "rvgstyle.html">Next</a>&nbsp;&raquo;
36
- </div>
37
-
38
- <h1>class RVG::Use <span class="superclass">&lt;
39
- Object</span></h1>
40
-
41
- <div id="toc">
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>shared methods</h3>
51
-
52
- <p>This class implements the <a href="rvgstyle.html">styles</a>
53
- method and the <a href="rvgxform.html">transform
54
- methods</a>.</p>
55
- </div>
56
-
57
- <h2 class="methods">class methods</h2>
58
-
59
- <div class="sig">
60
- <h3 id="new">new</h3>
61
-
62
- <p>RVG::Use.new(<span class="arg">obj</span>, <span class=
63
- "arg">x</span>=0, <span class="arg">y</span>=0, <span class=
64
- "arg">width</span>=nil, <span class=
65
- "arg">height</span>=nil)-&gt; <em>use</em></p>
66
- </div>
67
-
68
- <div class="desc">
69
- <h4>Description</h4>
70
-
71
- <p>This method is usually invoked indirectly via the
72
- <code>use</code> method in the <a href=
73
- "rvg.html#RVG_use">RVG</a>, <a href=
74
- "rvgclip.html#use">RVG::ClipPath</a>, <a href=
75
- "rvggroup.html#use">RVG::Group</a>, and <a href=
76
- "rvgpattern.html#use">RVG::Pattern</a> classes.</p>
77
-
78
- <p>The use object is similar to a group. Any styles specified
79
- on the use will propagate to the referenced object. However,
80
- styles on the referenced object will override the styles
81
- specified on the RVG::Use object.</p>
82
-
83
- <h4>Arguments</h4>
84
-
85
- <dl>
86
- <dt>obj</dt>
87
-
88
- <dd>The object to be re-used. This is typically a <a href=
89
- "rvggroup.html#new">group</a> or <a href=
90
- "rvg.html#RVG_new">RVG object</a> but can also be any
91
- <a href="rvgshape.html">shape</a>, <a href=
92
- "rvgtext.html#new">text</a>, or <a href=
93
- "rvgimage.html#new">raster image</a>, or even another
94
- <code>use</code>.</dd>
95
-
96
- <dt>x, y</dt>
97
-
98
- <dd>These arguments can be used to specify an additional
99
- <strong>translate</strong> transformation to be applied to
100
- the object within the user coordinate system.</dd>
101
-
102
- <dt>width, height</dt>
103
-
104
- <dd>The width and height of the rectangular region in which
105
- this object is placed. These arguments are ignored unless
106
- object is an RVG object. In this case, the values of
107
- <span class="arg">width</span> and <span class=
108
- "arg">height</span> override the values of the width and
109
- height arguments that were specified when the RVG object was
110
- created.</dd>
111
- </dl>
112
-
113
- <h4>Example</h4>
114
-
115
- <p><strong>A simple 'use' on a 'rect'</strong><a href=
116
- "javascript:popup('Use01.rb.html')"><img src="ex/Use01.gif"
117
- title="Click to see the example script" alt=
118
- "use example" /></a></p>
119
-
120
- <p><strong>What happens when a 'use' has chained transform
121
- methods</strong><a href=
122
- "javascript:popup('Use03.rb.html')"><img src="ex/Use03.gif"
123
- title="Click to see the example script" alt=
124
- "use example" /></a></p>
125
-
126
- <p><strong>What happens when a 'use' has a chained 'style'
127
- method</strong><a href=
128
- "javascript:popup('Use02.rb.html')"><img src="ex/Use02.gif"
129
- title="Click to see the example script" alt=
130
- "use example" /></a></p>
131
-
132
- <p>Also see the example for <a href=
133
- "rvg.html#RVG_new">RVG.new</a> and the example for <a href=
134
- "rvggroup.html#new">RVG::Group.new</a>.</p>
135
- </div>
136
-
137
- <p class="spacer">&nbsp;</p>
138
-
139
- <div class="nav">
140
- &laquo;&nbsp;<a href="rvgtspan.html">Prev</a> | <a href=
141
- "index.html">Contents</a> | <a href=
142
- "rvgstyle.html">Next</a>&nbsp;&raquo;
143
- </div>
144
- </body>
145
- </html>