cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame^] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <HTML> |
| 3 | <HEAD> |
| 4 | <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1"> |
| 5 | <TITLE>Magick::Geometry</TITLE> |
| 6 | <META NAME="GENERATOR" CONTENT="StarOffice 7 (Solaris Sparc)"> |
| 7 | <META NAME="AUTHOR" CONTENT="Bob Friesenhahn"> |
| 8 | <META NAME="CREATED" CONTENT="20020805;15172876"> |
| 9 | <META NAME="CHANGEDBY" CONTENT="Bob Friesenhahn"> |
| 10 | <META NAME="CHANGED" CONTENT="20050103;22481700"> |
| 11 | <META NAME="DESCRIPTION" CONTENT="Documentation for Magick::Geometry class"> |
| 12 | <STYLE> |
| 13 | <!-- |
| 14 | TD P { color: #000000 } |
| 15 | H1 { color: #000000 } |
| 16 | P { color: #000000 } |
| 17 | H3 { color: #000000 } |
| 18 | A:link { color: #0000ee } |
| 19 | A:visited { color: #551a8b } |
| 20 | --> |
| 21 | </STYLE> |
| 22 | </HEAD> |
| 23 | <BODY LANG="en-US" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" BGCOLOR="#ffffff" DIR="LTR"> |
| 24 | <H1 ALIGN=CENTER>Magick::Geometry</H1> |
| 25 | <P>Geometry provides a convenient means to specify a geometry |
| 26 | argument. The object may be initialized from a C string or C++ string |
| 27 | containing a geometry specification. It may also be initialized by |
| 28 | more efficient parameterized constructors. |
| 29 | </P> |
| 30 | <H3><A NAME="X11GeometrySpecifications"></A>X11 Geometry |
| 31 | Specifications</H3> |
| 32 | <P>X11 geometry specifications are in the form |
| 33 | <TT>"<width>x<height>{+-}<xoffset>{+-}<yoffset>"</TT> |
| 34 | (where <I>width</I>, <I>height</I>, <I>xoffset</I>, and <I>yoffset</I> |
| 35 | are numbers) for specifying the size and placement location for an |
| 36 | object. |
| 37 | </P> |
| 38 | <P STYLE="margin-bottom: 0in">The <I>width</I> and <I>height</I> |
| 39 | parts of the geometry specification are measured in pixels. The |
| 40 | <I>xoffset</I> and <I>yoffset</I> parts are also measured in pixels |
| 41 | and are used to specify the distance of the placement coordinate from |
| 42 | the left and top and edges of the image, respectively. Both types of |
| 43 | offsets are measured from the indicated edge of the object to the |
| 44 | corresponding edge of the image. The X offset may be specified in the |
| 45 | following ways: |
| 46 | </P> |
| 47 | <CENTER> |
| 48 | <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> |
| 49 | <COL WIDTH=21*> |
| 50 | <COL WIDTH=235*> |
| 51 | <TR> |
| 52 | <TD WIDTH=8%> |
| 53 | <P>+<I>xoffset</I></P> |
| 54 | </TD> |
| 55 | <TD WIDTH=92%> |
| 56 | <P>The left edge of the object is to be placed <I>xoffset</I> |
| 57 | pixels in from the <B>left edge </B>of the image.</P> |
| 58 | </TD> |
| 59 | </TR> |
| 60 | <TR> |
| 61 | <TD WIDTH=8%> |
| 62 | <P>-<I>xoffset</I></P> |
| 63 | </TD> |
| 64 | <TD WIDTH=92%> |
| 65 | <P>The left edge of the object is to be placed outside the image, |
| 66 | <I>xoffset</I> pixels out from the <B>left edge </B>of the image.</P> |
| 67 | </TD> |
| 68 | </TR> |
| 69 | </TABLE> |
| 70 | </CENTER> |
| 71 | <P STYLE="margin-bottom: 0in">The Y offset has similar meanings: |
| 72 | </P> |
| 73 | <CENTER> |
| 74 | <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> |
| 75 | <COL WIDTH=27*> |
| 76 | <COL WIDTH=229*> |
| 77 | <TR> |
| 78 | <TD WIDTH=11%> |
| 79 | <P>+<I>yoffset</I></P> |
| 80 | </TD> |
| 81 | <TD WIDTH=89%> |
| 82 | <P>The top edge of the object is to be <I>yoffset</I> pixels |
| 83 | <B>below</B> the <B>top edge </B>of the image.</P> |
| 84 | </TD> |
| 85 | </TR> |
| 86 | <TR> |
| 87 | <TD WIDTH=11%> |
| 88 | <P>-<I>yoffset</I></P> |
| 89 | </TD> |
| 90 | <TD WIDTH=89%> |
| 91 | <P>The top edge of the object is to be <I>yoffset</I> pixels |
| 92 | <B>above</B> the <B>top edge</B> of the image.</P> |
| 93 | </TD> |
| 94 | </TR> |
| 95 | </TABLE> |
| 96 | </CENTER> |
| 97 | <P>Offsets must be given as pairs; in other words, in order to |
| 98 | specify either <I>xoffset</I> or <I>yoffset</I> both must be present. |
| 99 | </P> |
| 100 | <H3><A NAME="ExtendedX11GeometrySpecifications"></A>ImageMagick |
| 101 | Extensions To X11 Geometry Specifications</H3> |
| 102 | <P STYLE="margin-bottom: 0in">ImageMagick has added a number of |
| 103 | qualifiers to the standard geometry string for use when resizing |
| 104 | images. The form of an extended geometry string is |
| 105 | "<TT><width>x<height>{+-}<xoffset>{+-}<yoffset>{%}{!}{<}{>}". |
| 106 | Extended geometry strings should <B>only</B> be used <B>when resizing |
| 107 | an image</B>. Using an extended geometry string for other |
| 108 | applications may cause the API call to fail. </TT>The available |
| 109 | qualifiers are shown in the following table: |
| 110 | </P> |
| 111 | <P ALIGN=CENTER STYLE="margin-bottom: 0in"><B>ImageMagick Geometry |
| 112 | Qualifiers</B></P> |
| 113 | <CENTER> |
| 114 | <TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3> |
| 115 | <COL WIDTH=36*> |
| 116 | <COL WIDTH=220*> |
| 117 | <TR> |
| 118 | <TD WIDTH=14%> |
| 119 | <P ALIGN=CENTER><B>Qualifier</B></P> |
| 120 | </TD> |
| 121 | <TD WIDTH=86%> |
| 122 | <P ALIGN=CENTER><B>Description</B></P> |
| 123 | </TD> |
| 124 | </TR> |
| 125 | <TR> |
| 126 | <TD WIDTH=14%> |
| 127 | <P ALIGN=CENTER><B>%</B></P> |
| 128 | </TD> |
| 129 | <TD WIDTH=86%> |
| 130 | <P>Interpret width and height as a <B>percentage</B> of the |
| 131 | current size.</P> |
| 132 | </TD> |
| 133 | </TR> |
| 134 | <TR> |
| 135 | <TD WIDTH=14%> |
| 136 | <P ALIGN=CENTER><B>!</B></P> |
| 137 | </TD> |
| 138 | <TD WIDTH=86%> |
| 139 | <P>Resize to width and height <B>exactly</B>, loosing original |
| 140 | aspect ratio.</P> |
| 141 | </TD> |
| 142 | </TR> |
| 143 | <TR> |
| 144 | <TD WIDTH=14%> |
| 145 | <P ALIGN=CENTER><B><</B></P> |
| 146 | </TD> |
| 147 | <TD WIDTH=86%> |
| 148 | <P>Resize only if the image is <B>smaller</B> than the geometry |
| 149 | specification.</P> |
| 150 | </TD> |
| 151 | </TR> |
| 152 | <TR> |
| 153 | <TD WIDTH=14%> |
| 154 | <P ALIGN=CENTER><B>></B></P> |
| 155 | </TD> |
| 156 | <TD WIDTH=86%> |
| 157 | <P>Resize only if the image is <B>greater</B> than the geometry |
| 158 | specification.</P> |
| 159 | </TD> |
| 160 | </TR> |
| 161 | </TABLE> |
| 162 | </CENTER> |
| 163 | <H3><A NAME="PostscriptPageSize"></A>Postscript Page Size Extension |
| 164 | To Geometry Specifications</H3> |
| 165 | <P>Any geometry string specification supplied to the Geometry |
| 166 | constructor is considered to be a Postscript page size nickname if |
| 167 | the first character is not numeric. The Geometry constructor converts |
| 168 | these page size specifications into the equivalent numeric geometry |
| 169 | string specification (preserving any offset component) prior to |
| 170 | conversion to the internal object format. Postscript page size |
| 171 | specifications are short-hand for the pixel geometry required to fill |
| 172 | a page of that size. Since the 11x17 inch page size used in the US |
| 173 | starts with a digit, it is not supported as a Postscript page size |
| 174 | nickname. Instead, substitute the geometry specification "<TT>792x1224>"</TT> |
| 175 | when 11x17 output is desired. |
| 176 | </P> |
| 177 | <P STYLE="margin-bottom: 0in">An example of a Postscript page size |
| 178 | specification is <TT>"letter+43+43>"</TT>. |
| 179 | </P> |
| 180 | <P ALIGN=CENTER STYLE="margin-bottom: 0in"><B>Postscript Page Size |
| 181 | Nicknames</B></P> |
| 182 | <CENTER> |
| 183 | <TABLE WIDTH=70% BORDER=1 CELLPADDING=2 CELLSPACING=3> |
| 184 | <COL WIDTH=105*> |
| 185 | <COL WIDTH=151*> |
| 186 | <TR> |
| 187 | <TD WIDTH=41%> |
| 188 | <P ALIGN=CENTER><B>Postscript Page Size Nickname</B></P> |
| 189 | </TD> |
| 190 | <TD WIDTH=59%> |
| 191 | <P ALIGN=CENTER><B>Equivalent Extended Geometry Specification</B></P> |
| 192 | </TD> |
| 193 | </TR> |
| 194 | <TR> |
| 195 | <TD WIDTH=41%> |
| 196 | <P ALIGN=CENTER><FONT SIZE=2>Ledger</FONT></P> |
| 197 | </TD> |
| 198 | <TD WIDTH=59%> |
| 199 | <P ALIGN=CENTER><FONT SIZE=2>1224x792></FONT></P> |
| 200 | </TD> |
| 201 | </TR> |
| 202 | <TR> |
| 203 | <TD WIDTH=41%> |
| 204 | <P ALIGN=CENTER><FONT SIZE=2>Legal</FONT></P> |
| 205 | </TD> |
| 206 | <TD WIDTH=59%> |
| 207 | <P ALIGN=CENTER><FONT SIZE=2>612x1008></FONT></P> |
| 208 | </TD> |
| 209 | </TR> |
| 210 | <TR> |
| 211 | <TD WIDTH=41%> |
| 212 | <P ALIGN=CENTER><FONT SIZE=2>Letter</FONT></P> |
| 213 | </TD> |
| 214 | <TD WIDTH=59%> |
| 215 | <P ALIGN=CENTER><FONT SIZE=2>612x792></FONT></P> |
| 216 | </TD> |
| 217 | </TR> |
| 218 | <TR> |
| 219 | <TD WIDTH=41%> |
| 220 | <P ALIGN=CENTER><FONT SIZE=2>LetterSmall</FONT></P> |
| 221 | </TD> |
| 222 | <TD WIDTH=59%> |
| 223 | <P ALIGN=CENTER><FONT SIZE=2>612x792></FONT></P> |
| 224 | </TD> |
| 225 | </TR> |
| 226 | <TR> |
| 227 | <TD WIDTH=41%> |
| 228 | <P ALIGN=CENTER><FONT SIZE=2>ArchE</FONT></P> |
| 229 | </TD> |
| 230 | <TD WIDTH=59%> |
| 231 | <P ALIGN=CENTER><FONT SIZE=2>2592x3456></FONT></P> |
| 232 | </TD> |
| 233 | </TR> |
| 234 | <TR> |
| 235 | <TD WIDTH=41%> |
| 236 | <P ALIGN=CENTER><FONT SIZE=2>ArchD</FONT></P> |
| 237 | </TD> |
| 238 | <TD WIDTH=59%> |
| 239 | <P ALIGN=CENTER><FONT SIZE=2>1728x2592></FONT></P> |
| 240 | </TD> |
| 241 | </TR> |
| 242 | <TR> |
| 243 | <TD WIDTH=41%> |
| 244 | <P ALIGN=CENTER><FONT SIZE=2>ArchC</FONT></P> |
| 245 | </TD> |
| 246 | <TD WIDTH=59%> |
| 247 | <P ALIGN=CENTER><FONT SIZE=2>1296x1728></FONT></P> |
| 248 | </TD> |
| 249 | </TR> |
| 250 | <TR> |
| 251 | <TD WIDTH=41%> |
| 252 | <P ALIGN=CENTER><FONT SIZE=2>ArchB</FONT></P> |
| 253 | </TD> |
| 254 | <TD WIDTH=59%> |
| 255 | <P ALIGN=CENTER><FONT SIZE=2>864x1296></FONT></P> |
| 256 | </TD> |
| 257 | </TR> |
| 258 | <TR> |
| 259 | <TD WIDTH=41%> |
| 260 | <P ALIGN=CENTER><FONT SIZE=2>ArchA</FONT></P> |
| 261 | </TD> |
| 262 | <TD WIDTH=59%> |
| 263 | <P ALIGN=CENTER><FONT SIZE=2>648x864></FONT></P> |
| 264 | </TD> |
| 265 | </TR> |
| 266 | <TR> |
| 267 | <TD WIDTH=41%> |
| 268 | <P ALIGN=CENTER><FONT SIZE=2>A0</FONT></P> |
| 269 | </TD> |
| 270 | <TD WIDTH=59%> |
| 271 | <P ALIGN=CENTER><FONT SIZE=2>2380x3368></FONT></P> |
| 272 | </TD> |
| 273 | </TR> |
| 274 | <TR> |
| 275 | <TD WIDTH=41%> |
| 276 | <P ALIGN=CENTER><FONT SIZE=2>A1</FONT></P> |
| 277 | </TD> |
| 278 | <TD WIDTH=59%> |
| 279 | <P ALIGN=CENTER><FONT SIZE=2>1684x2380></FONT></P> |
| 280 | </TD> |
| 281 | </TR> |
| 282 | <TR> |
| 283 | <TD WIDTH=41%> |
| 284 | <P ALIGN=CENTER><FONT SIZE=2>A2</FONT></P> |
| 285 | </TD> |
| 286 | <TD WIDTH=59%> |
| 287 | <P ALIGN=CENTER><FONT SIZE=2>1190x1684></FONT></P> |
| 288 | </TD> |
| 289 | </TR> |
| 290 | <TR> |
| 291 | <TD WIDTH=41%> |
| 292 | <P ALIGN=CENTER><FONT SIZE=2>A3</FONT></P> |
| 293 | </TD> |
| 294 | <TD WIDTH=59%> |
| 295 | <P ALIGN=CENTER><FONT SIZE=2>842x1190></FONT></P> |
| 296 | </TD> |
| 297 | </TR> |
| 298 | <TR> |
| 299 | <TD WIDTH=41%> |
| 300 | <P ALIGN=CENTER><FONT SIZE=2>A4</FONT></P> |
| 301 | </TD> |
| 302 | <TD WIDTH=59%> |
| 303 | <P ALIGN=CENTER><FONT SIZE=2>595x842></FONT></P> |
| 304 | </TD> |
| 305 | </TR> |
| 306 | <TR> |
| 307 | <TD WIDTH=41%> |
| 308 | <P ALIGN=CENTER><FONT SIZE=2>A4Small</FONT></P> |
| 309 | </TD> |
| 310 | <TD WIDTH=59%> |
| 311 | <P ALIGN=CENTER><FONT SIZE=2>595x842></FONT></P> |
| 312 | </TD> |
| 313 | </TR> |
| 314 | <TR> |
| 315 | <TD WIDTH=41%> |
| 316 | <P ALIGN=CENTER><FONT SIZE=2>A5</FONT></P> |
| 317 | </TD> |
| 318 | <TD WIDTH=59%> |
| 319 | <P ALIGN=CENTER><FONT SIZE=2>421x595></FONT></P> |
| 320 | </TD> |
| 321 | </TR> |
| 322 | <TR> |
| 323 | <TD WIDTH=41%> |
| 324 | <P ALIGN=CENTER><FONT SIZE=2>A6</FONT></P> |
| 325 | </TD> |
| 326 | <TD WIDTH=59%> |
| 327 | <P ALIGN=CENTER><FONT SIZE=2>297x421></FONT></P> |
| 328 | </TD> |
| 329 | </TR> |
| 330 | <TR> |
| 331 | <TD WIDTH=41%> |
| 332 | <P ALIGN=CENTER><FONT SIZE=2>A7</FONT></P> |
| 333 | </TD> |
| 334 | <TD WIDTH=59%> |
| 335 | <P ALIGN=CENTER><FONT SIZE=2>210x297></FONT></P> |
| 336 | </TD> |
| 337 | </TR> |
| 338 | <TR> |
| 339 | <TD WIDTH=41%> |
| 340 | <P ALIGN=CENTER><FONT SIZE=2>A8</FONT></P> |
| 341 | </TD> |
| 342 | <TD WIDTH=59%> |
| 343 | <P ALIGN=CENTER><FONT SIZE=2>148x210></FONT></P> |
| 344 | </TD> |
| 345 | </TR> |
| 346 | <TR> |
| 347 | <TD WIDTH=41%> |
| 348 | <P ALIGN=CENTER><FONT SIZE=2>A9</FONT></P> |
| 349 | </TD> |
| 350 | <TD WIDTH=59%> |
| 351 | <P ALIGN=CENTER><FONT SIZE=2>105x148></FONT></P> |
| 352 | </TD> |
| 353 | </TR> |
| 354 | <TR> |
| 355 | <TD WIDTH=41%> |
| 356 | <P ALIGN=CENTER><FONT SIZE=2>A10</FONT></P> |
| 357 | </TD> |
| 358 | <TD WIDTH=59%> |
| 359 | <P ALIGN=CENTER><FONT SIZE=2>74x105></FONT></P> |
| 360 | </TD> |
| 361 | </TR> |
| 362 | <TR> |
| 363 | <TD WIDTH=41%> |
| 364 | <P ALIGN=CENTER><FONT SIZE=2>B0</FONT></P> |
| 365 | </TD> |
| 366 | <TD WIDTH=59%> |
| 367 | <P ALIGN=CENTER><FONT SIZE=2>2836x4008></FONT></P> |
| 368 | </TD> |
| 369 | </TR> |
| 370 | <TR> |
| 371 | <TD WIDTH=41%> |
| 372 | <P ALIGN=CENTER><FONT SIZE=2>B1</FONT></P> |
| 373 | </TD> |
| 374 | <TD WIDTH=59%> |
| 375 | <P ALIGN=CENTER><FONT SIZE=2>2004x2836></FONT></P> |
| 376 | </TD> |
| 377 | </TR> |
| 378 | <TR> |
| 379 | <TD WIDTH=41%> |
| 380 | <P ALIGN=CENTER><FONT SIZE=2>B2</FONT></P> |
| 381 | </TD> |
| 382 | <TD WIDTH=59%> |
| 383 | <P ALIGN=CENTER><FONT SIZE=2>1418x2004></FONT></P> |
| 384 | </TD> |
| 385 | </TR> |
| 386 | <TR> |
| 387 | <TD WIDTH=41%> |
| 388 | <P ALIGN=CENTER><FONT SIZE=2>B3</FONT></P> |
| 389 | </TD> |
| 390 | <TD WIDTH=59%> |
| 391 | <P ALIGN=CENTER><FONT SIZE=2>1002x1418></FONT></P> |
| 392 | </TD> |
| 393 | </TR> |
| 394 | <TR> |
| 395 | <TD WIDTH=41%> |
| 396 | <P ALIGN=CENTER><FONT SIZE=2>B4</FONT></P> |
| 397 | </TD> |
| 398 | <TD WIDTH=59%> |
| 399 | <P ALIGN=CENTER><FONT SIZE=2>709x1002></FONT></P> |
| 400 | </TD> |
| 401 | </TR> |
| 402 | <TR> |
| 403 | <TD WIDTH=41%> |
| 404 | <P ALIGN=CENTER><FONT SIZE=2>B5</FONT></P> |
| 405 | </TD> |
| 406 | <TD WIDTH=59%> |
| 407 | <P ALIGN=CENTER><FONT SIZE=2>501x709></FONT></P> |
| 408 | </TD> |
| 409 | </TR> |
| 410 | <TR> |
| 411 | <TD WIDTH=41%> |
| 412 | <P ALIGN=CENTER><FONT SIZE=2>C0</FONT></P> |
| 413 | </TD> |
| 414 | <TD WIDTH=59%> |
| 415 | <P ALIGN=CENTER><FONT SIZE=2>2600x3677></FONT></P> |
| 416 | </TD> |
| 417 | </TR> |
| 418 | <TR> |
| 419 | <TD WIDTH=41%> |
| 420 | <P ALIGN=CENTER><FONT SIZE=2>C1</FONT></P> |
| 421 | </TD> |
| 422 | <TD WIDTH=59%> |
| 423 | <P ALIGN=CENTER><FONT SIZE=2>1837x2600></FONT></P> |
| 424 | </TD> |
| 425 | </TR> |
| 426 | <TR> |
| 427 | <TD WIDTH=41%> |
| 428 | <P ALIGN=CENTER><FONT SIZE=2>C2</FONT></P> |
| 429 | </TD> |
| 430 | <TD WIDTH=59%> |
| 431 | <P ALIGN=CENTER><FONT SIZE=2>1298x1837></FONT></P> |
| 432 | </TD> |
| 433 | </TR> |
| 434 | <TR> |
| 435 | <TD WIDTH=41%> |
| 436 | <P ALIGN=CENTER><FONT SIZE=2>C3</FONT></P> |
| 437 | </TD> |
| 438 | <TD WIDTH=59%> |
| 439 | <P ALIGN=CENTER><FONT SIZE=2>918x1298></FONT></P> |
| 440 | </TD> |
| 441 | </TR> |
| 442 | <TR> |
| 443 | <TD WIDTH=41%> |
| 444 | <P ALIGN=CENTER><FONT SIZE=2>C4</FONT></P> |
| 445 | </TD> |
| 446 | <TD WIDTH=59%> |
| 447 | <P ALIGN=CENTER><FONT SIZE=2>649x918></FONT></P> |
| 448 | </TD> |
| 449 | </TR> |
| 450 | <TR> |
| 451 | <TD WIDTH=41%> |
| 452 | <P ALIGN=CENTER><FONT SIZE=2>C5</FONT></P> |
| 453 | </TD> |
| 454 | <TD WIDTH=59%> |
| 455 | <P ALIGN=CENTER><FONT SIZE=2>459x649></FONT></P> |
| 456 | </TD> |
| 457 | </TR> |
| 458 | <TR> |
| 459 | <TD WIDTH=41%> |
| 460 | <P ALIGN=CENTER><FONT SIZE=2>C6</FONT></P> |
| 461 | </TD> |
| 462 | <TD WIDTH=59%> |
| 463 | <P ALIGN=CENTER><FONT SIZE=2>323x459></FONT></P> |
| 464 | </TD> |
| 465 | </TR> |
| 466 | <TR> |
| 467 | <TD WIDTH=41%> |
| 468 | <P ALIGN=CENTER><FONT SIZE=2>Flsa</FONT></P> |
| 469 | </TD> |
| 470 | <TD WIDTH=59%> |
| 471 | <P ALIGN=CENTER><FONT SIZE=2>612x936></FONT></P> |
| 472 | </TD> |
| 473 | </TR> |
| 474 | <TR> |
| 475 | <TD WIDTH=41%> |
| 476 | <P ALIGN=CENTER><FONT SIZE=2>Flse</FONT></P> |
| 477 | </TD> |
| 478 | <TD WIDTH=59%> |
| 479 | <P ALIGN=CENTER><FONT SIZE=2>612x936></FONT></P> |
| 480 | </TD> |
| 481 | </TR> |
| 482 | <TR> |
| 483 | <TD WIDTH=41%> |
| 484 | <P ALIGN=CENTER><FONT SIZE=2>HalfLetter</FONT></P> |
| 485 | </TD> |
| 486 | <TD WIDTH=59%> |
| 487 | <P ALIGN=CENTER><FONT SIZE=2>396x612></FONT></P> |
| 488 | </TD> |
| 489 | </TR> |
| 490 | </TABLE> |
| 491 | </CENTER> |
| 492 | <H3 ALIGN=CENTER>Geometry Methods</H3> |
| 493 | <P STYLE="margin-bottom: 0in">Geometry provides methods to initialize |
| 494 | its value from strings, from a set of parameters, or via attributes. |
| 495 | The methods available for use in Geometry are shown in the following |
| 496 | table: |
| 497 | </P> |
| 498 | <P ALIGN=CENTER STYLE="margin-bottom: 0in"><B>Geometry Methods</B></P> |
| 499 | <TABLE WIDTH=100% BORDER=1 CELLPADDING=2 CELLSPACING=3> |
| 500 | <COL WIDTH=25*> |
| 501 | <COL WIDTH=26*> |
| 502 | <COL WIDTH=111*> |
| 503 | <COL WIDTH=94*> |
| 504 | <TR> |
| 505 | <TD WIDTH=10%> |
| 506 | <P ALIGN=CENTER><B>Method</B></P> |
| 507 | </TD> |
| 508 | <TD WIDTH=10%> |
| 509 | <P ALIGN=CENTER><B>Return Type</B></P> |
| 510 | </TD> |
| 511 | <TD WIDTH=44%> |
| 512 | <P ALIGN=CENTER><B>Signature(s)</B></P> |
| 513 | </TD> |
| 514 | <TD WIDTH=37%> |
| 515 | <P ALIGN=CENTER><B>Description</B></P> |
| 516 | </TD> |
| 517 | </TR> |
| 518 | <TR> |
| 519 | <TD ROWSPAN=3 WIDTH=10%> |
| 520 | <P>Geometry</P> |
| 521 | </TD> |
| 522 | <TD ROWSPAN=3 WIDTH=10% BGCOLOR="#666666"> |
| 523 | <P> </P> |
| 524 | </TD> |
| 525 | <TD WIDTH=44%> |
| 526 | <P>unsigned int width_, unsigned int height_, unsigned int xOff_ = |
| 527 | 0, unsigned int yOff_ = 0, bool xNegative_ = false, bool |
| 528 | yNegative_ = false</P> |
| 529 | </TD> |
| 530 | <TD WIDTH=37%> |
| 531 | <P>Construct X11 geometry via explicit parameters.</P> |
| 532 | </TD> |
| 533 | </TR> |
| 534 | <TR> |
| 535 | <TD WIDTH=44%> |
| 536 | <P>const string geometry_</P> |
| 537 | </TD> |
| 538 | <TD WIDTH=37%> |
| 539 | <P>Construct geometry from C++ string</P> |
| 540 | </TD> |
| 541 | </TR> |
| 542 | <TR> |
| 543 | <TD WIDTH=44%> |
| 544 | <P>const char * geometry_</P> |
| 545 | </TD> |
| 546 | <TD WIDTH=37%> |
| 547 | <P>Construct geometry from C string</P> |
| 548 | </TD> |
| 549 | </TR> |
| 550 | <TR> |
| 551 | <TD ROWSPAN=2 WIDTH=10%> |
| 552 | <P>width</P> |
| 553 | </TD> |
| 554 | <TD WIDTH=10%> |
| 555 | <P>void</P> |
| 556 | </TD> |
| 557 | <TD WIDTH=44%> |
| 558 | <P>unsigned int width_</P> |
| 559 | </TD> |
| 560 | <TD ROWSPAN=2 WIDTH=37%> |
| 561 | <P>Width</P> |
| 562 | </TD> |
| 563 | </TR> |
| 564 | <TR> |
| 565 | <TD WIDTH=10%> |
| 566 | <P>unsigned int</P> |
| 567 | </TD> |
| 568 | <TD WIDTH=44%> |
| 569 | <P>void</P> |
| 570 | </TD> |
| 571 | </TR> |
| 572 | <TR> |
| 573 | <TD ROWSPAN=2 WIDTH=10%> |
| 574 | <P>height</P> |
| 575 | </TD> |
| 576 | <TD WIDTH=10%> |
| 577 | <P>void</P> |
| 578 | </TD> |
| 579 | <TD WIDTH=44%> |
| 580 | <P>unsigned int height_</P> |
| 581 | </TD> |
| 582 | <TD ROWSPAN=2 WIDTH=37%> |
| 583 | <P>Height</P> |
| 584 | </TD> |
| 585 | </TR> |
| 586 | <TR> |
| 587 | <TD WIDTH=10%> |
| 588 | <P>unsigned int</P> |
| 589 | </TD> |
| 590 | <TD WIDTH=44%> |
| 591 | <P>void</P> |
| 592 | </TD> |
| 593 | </TR> |
| 594 | <TR> |
| 595 | <TD ROWSPAN=2 WIDTH=10%> |
| 596 | <P>xOff</P> |
| 597 | </TD> |
| 598 | <TD WIDTH=10%> |
| 599 | <P>void</P> |
| 600 | </TD> |
| 601 | <TD WIDTH=44%> |
| 602 | <P>unsigned int xOff_</P> |
| 603 | </TD> |
| 604 | <TD ROWSPAN=2 WIDTH=37%> |
| 605 | <P>X offset from origin</P> |
| 606 | </TD> |
| 607 | </TR> |
| 608 | <TR> |
| 609 | <TD WIDTH=10%> |
| 610 | <P>int</P> |
| 611 | </TD> |
| 612 | <TD WIDTH=44%> |
| 613 | <P>void</P> |
| 614 | </TD> |
| 615 | </TR> |
| 616 | <TR> |
| 617 | <TD ROWSPAN=2 WIDTH=10%> |
| 618 | <P>yOff</P> |
| 619 | </TD> |
| 620 | <TD WIDTH=10%> |
| 621 | <P>void</P> |
| 622 | </TD> |
| 623 | <TD WIDTH=44%> |
| 624 | <P>unsigned int yOff_</P> |
| 625 | </TD> |
| 626 | <TD ROWSPAN=2 WIDTH=37%> |
| 627 | <P>Y offset from origin</P> |
| 628 | </TD> |
| 629 | </TR> |
| 630 | <TR> |
| 631 | <TD WIDTH=10%> |
| 632 | <P>int</P> |
| 633 | </TD> |
| 634 | <TD WIDTH=44%> |
| 635 | <P>void</P> |
| 636 | </TD> |
| 637 | </TR> |
| 638 | <TR> |
| 639 | <TD ROWSPAN=2 WIDTH=10%> |
| 640 | <P>xNegative</P> |
| 641 | </TD> |
| 642 | <TD WIDTH=10%> |
| 643 | <P>void</P> |
| 644 | </TD> |
| 645 | <TD WIDTH=44%> |
| 646 | <P>bool xNegative_</P> |
| 647 | </TD> |
| 648 | <TD ROWSPAN=2 WIDTH=37%> |
| 649 | <P>Sign of X offset negative? (X origin at right)</P> |
| 650 | </TD> |
| 651 | </TR> |
| 652 | <TR> |
| 653 | <TD WIDTH=10%> |
| 654 | <P>bool</P> |
| 655 | </TD> |
| 656 | <TD WIDTH=44%> |
| 657 | <P>void</P> |
| 658 | </TD> |
| 659 | </TR> |
| 660 | <TR> |
| 661 | <TD ROWSPAN=2 WIDTH=10%> |
| 662 | <P>yNegative</P> |
| 663 | </TD> |
| 664 | <TD WIDTH=10%> |
| 665 | <P>void</P> |
| 666 | </TD> |
| 667 | <TD WIDTH=44%> |
| 668 | <P>bool yNegative_</P> |
| 669 | </TD> |
| 670 | <TD ROWSPAN=2 WIDTH=37%> |
| 671 | <P>Sign of Y offset negative? (Y origin at bottom)</P> |
| 672 | </TD> |
| 673 | </TR> |
| 674 | <TR> |
| 675 | <TD WIDTH=10%> |
| 676 | <P>bool</P> |
| 677 | </TD> |
| 678 | <TD WIDTH=44%> |
| 679 | <P>void</P> |
| 680 | </TD> |
| 681 | </TR> |
| 682 | <TR> |
| 683 | <TD ROWSPAN=2 WIDTH=10%> |
| 684 | <P>percent</P> |
| 685 | </TD> |
| 686 | <TD WIDTH=10%> |
| 687 | <P>void</P> |
| 688 | </TD> |
| 689 | <TD WIDTH=44%> |
| 690 | <P>bool percent_</P> |
| 691 | </TD> |
| 692 | <TD ROWSPAN=2 WIDTH=37%> |
| 693 | <P>Width and height are expressed as percentages</P> |
| 694 | </TD> |
| 695 | </TR> |
| 696 | <TR> |
| 697 | <TD WIDTH=10%> |
| 698 | <P>bool</P> |
| 699 | </TD> |
| 700 | <TD WIDTH=44%> |
| 701 | <P>void</P> |
| 702 | </TD> |
| 703 | </TR> |
| 704 | <TR> |
| 705 | <TD ROWSPAN=2 WIDTH=10%> |
| 706 | <P>aspect</P> |
| 707 | </TD> |
| 708 | <TD WIDTH=10%> |
| 709 | <P>void</P> |
| 710 | </TD> |
| 711 | <TD WIDTH=44%> |
| 712 | <P>bool aspect_</P> |
| 713 | </TD> |
| 714 | <TD ROWSPAN=2 WIDTH=37%> |
| 715 | <P>Resize without preserving aspect ratio (!)</P> |
| 716 | </TD> |
| 717 | </TR> |
| 718 | <TR> |
| 719 | <TD WIDTH=10%> |
| 720 | <P>bool</P> |
| 721 | </TD> |
| 722 | <TD WIDTH=44%> |
| 723 | <P>void</P> |
| 724 | </TD> |
| 725 | </TR> |
| 726 | <TR> |
| 727 | <TD ROWSPAN=2 WIDTH=10%> |
| 728 | <P>greater</P> |
| 729 | </TD> |
| 730 | <TD WIDTH=10%> |
| 731 | <P>void</P> |
| 732 | </TD> |
| 733 | <TD WIDTH=44%> |
| 734 | <P>bool greater_</P> |
| 735 | </TD> |
| 736 | <TD ROWSPAN=2 WIDTH=37%> |
| 737 | <P>Resize if image is greater than size (>)</P> |
| 738 | </TD> |
| 739 | </TR> |
| 740 | <TR> |
| 741 | <TD WIDTH=10%> |
| 742 | <P>bool</P> |
| 743 | </TD> |
| 744 | <TD WIDTH=44%> |
| 745 | <P>void</P> |
| 746 | </TD> |
| 747 | </TR> |
| 748 | <TR> |
| 749 | <TD ROWSPAN=2 WIDTH=10%> |
| 750 | <P>less</P> |
| 751 | </TD> |
| 752 | <TD WIDTH=10%> |
| 753 | <P>void</P> |
| 754 | </TD> |
| 755 | <TD WIDTH=44%> |
| 756 | <P>bool less_</P> |
| 757 | </TD> |
| 758 | <TD ROWSPAN=2 WIDTH=37%> |
| 759 | <P>Resize if image is less than size (<)</P> |
| 760 | </TD> |
| 761 | </TR> |
| 762 | <TR> |
| 763 | <TD WIDTH=10%> |
| 764 | <P>bool</P> |
| 765 | </TD> |
| 766 | <TD WIDTH=44%> |
| 767 | <P>void</P> |
| 768 | </TD> |
| 769 | </TR> |
| 770 | <TR> |
| 771 | <TD ROWSPAN=2 WIDTH=10%> |
| 772 | <P>isValid</P> |
| 773 | </TD> |
| 774 | <TD WIDTH=10%> |
| 775 | <P>void</P> |
| 776 | </TD> |
| 777 | <TD WIDTH=44%> |
| 778 | <P>bool isValid_</P> |
| 779 | </TD> |
| 780 | <TD ROWSPAN=2 WIDTH=37%> |
| 781 | <P>Does object contain a valid geometry? May be set to <I>false</I> |
| 782 | in order to invalidate an existing geometry object.</P> |
| 783 | </TD> |
| 784 | </TR> |
| 785 | <TR> |
| 786 | <TD WIDTH=10%> |
| 787 | <P>bool</P> |
| 788 | </TD> |
| 789 | <TD WIDTH=44%> |
| 790 | <P>void</P> |
| 791 | </TD> |
| 792 | </TR> |
| 793 | <TR> |
| 794 | <TD WIDTH=10%> |
| 795 | <P>operator =</P> |
| 796 | </TD> |
| 797 | <TD WIDTH=10%> |
| 798 | <P>const Geometry&</P> |
| 799 | </TD> |
| 800 | <TD WIDTH=44%> |
| 801 | <P>const string geometry_</P> |
| 802 | </TD> |
| 803 | <TD WIDTH=37%> |
| 804 | <P>Set geometry via C++ string</P> |
| 805 | </TD> |
| 806 | </TR> |
| 807 | <TR> |
| 808 | <TD WIDTH=10%> |
| 809 | <P>operator =</P> |
| 810 | </TD> |
| 811 | <TD WIDTH=10%> |
| 812 | <P>const Geometry&</P> |
| 813 | </TD> |
| 814 | <TD WIDTH=44%> |
| 815 | <P>const char * geometry_</P> |
| 816 | </TD> |
| 817 | <TD WIDTH=37%> |
| 818 | <P>Set geometry via C string</P> |
| 819 | </TD> |
| 820 | </TR> |
| 821 | <TR> |
| 822 | <TD WIDTH=10%> |
| 823 | <P>operator string</P> |
| 824 | </TD> |
| 825 | <TD WIDTH=10%> |
| 826 | <P>string</P> |
| 827 | </TD> |
| 828 | <TD WIDTH=44%> |
| 829 | <P>Geometry&</P> |
| 830 | </TD> |
| 831 | <TD WIDTH=37%> |
| 832 | <P>Obtain C++ string representation of geometry</P> |
| 833 | </TD> |
| 834 | </TR> |
| 835 | </TABLE> |
| 836 | <P><BR><BR> |
| 837 | </P> |
| 838 | </BODY> |
| 839 | </HTML> |