GD::Text::Align.3pm
上传用户:qdrechuli
上传日期:2022-08-01
资源大小:917k
文件大小:9k
源码类别:

视频捕捉/采集

开发平台:

Visual C++

  1. ." Automatically generated by Pod::Man version 1.15
  2. ." Tue Oct  8 11:46:54 2002
  3. ."
  4. ." Standard preamble:
  5. ." ======================================================================
  6. .de Sh " Subsection heading
  7. .br
  8. .if t .Sp
  9. .ne 5
  10. .PP
  11. fB\$1fR
  12. .PP
  13. ..
  14. .de Sp " Vertical space (when we can't use .PP)
  15. .if t .sp .5v
  16. .if n .sp
  17. ..
  18. .de Ip " List item
  19. .br
  20. .ie \n(.$>=3 .ne \$3
  21. .el .ne 3
  22. .IP "\$1" \$2
  23. ..
  24. .de Vb " Begin verbatim text
  25. .ft CW
  26. .nf
  27. .ne \$1
  28. ..
  29. .de Ve " End verbatim text
  30. .ft R
  31. .fi
  32. ..
  33. ." Set up some character translations and predefined strings.  *(-- will
  34. ." give an unbreakable dash, *(PI will give pi, *(L" will give a left
  35. ." double quote, and *(R" will give a right double quote.  | will give a
  36. ." real vertical bar.  *(C+ will give a nicer C++.  Capital omega is used
  37. ." to do unbreakable dashes and therefore won't be available.  *(C` and
  38. ." *(C' expand to `' in nroff, nothing in troff, for use with C<>
  39. .tr (*W-|(bv*(Tr
  40. .ds C+ Cv'-.1v'h'-1p's-2+h'-1p'+s0v'.1v'h'-1p'
  41. .ie n {
  42. .    ds -- (*W-
  43. .    ds PI pi
  44. .    if (n(.H=4u)&(1m=24u) .ds -- (*Wh'-12u'(*Wh'-12u'-" diablo 10 pitch
  45. .    if (n(.H=4u)&(1m=20u) .ds -- (*Wh'-12u'(*Wh'-8u'-"  diablo 12 pitch
  46. .    ds L" ""
  47. .    ds R" ""
  48. .    ds C` ""
  49. .    ds C' ""
  50. 'br}
  51. .el{
  52. .    ds -- |(em|
  53. .    ds PI (*p
  54. .    ds L" ``
  55. .    ds R" ''
  56. 'br}
  57. ."
  58. ." If the F register is turned on, we'll generate index entries on stderr
  59. ." for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  60. ." index entries marked with X<> in POD.  Of course, you'll have to process
  61. ." the output yourself in some meaningful fashion.
  62. .if nF {
  63. .    de IX
  64. .    tm Index:\$1t\n%t"\$2"
  65. ..
  66. .    nr % 0
  67. .    rr F
  68. .}
  69. ."
  70. ." For nroff, turn off justification.  Always turn off hyphenation; it
  71. ." makes way too many mistakes in technical documents.
  72. .hy 0
  73. .if n .na
  74. ."
  75. ." Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  76. ." Fear.  Run.  Save yourself.  No user-serviceable parts.
  77. .bd B 3
  78. .    " fudge factors for nroff and troff
  79. .if n {
  80. .    ds #H 0
  81. .    ds #V .8m
  82. .    ds #F .3m
  83. .    ds #[ f1
  84. .    ds #] fP
  85. .}
  86. .if t {
  87. .    ds #H ((1u-(\\n(.fu%2u))*.13m)
  88. .    ds #V .6m
  89. .    ds #F 0
  90. .    ds #[ &
  91. .    ds #] &
  92. .}
  93. .    " simple accents for nroff and troff
  94. .if n {
  95. .    ds ' &
  96. .    ds ` &
  97. .    ds ^ &
  98. .    ds , &
  99. .    ds ~ ~
  100. .    ds /
  101. .}
  102. .if t {
  103. .    ds ' \k:h'-(\n(.wu*8/10-*(#H)''h"|\n:u"
  104. .    ds ` \k:h'-(\n(.wu*8/10-*(#H)'`h'|\n:u'
  105. .    ds ^ \k:h'-(\n(.wu*10/11-*(#H)'^h'|\n:u'
  106. .    ds , \k:h'-(\n(.wu*8/10)',h'|\n:u'
  107. .    ds ~ \k:h'-(\n(.wu-*(#H-.1m)'~h'|\n:u'
  108. .    ds / \k:h'-(\n(.wu*8/10-*(#H)'z(slh'|\n:u'
  109. .}
  110. .    " troff and (daisy-wheel) nroff accents
  111. .ds : \k:h'-(\n(.wu*8/10-*(#H+.1m+*(#F)'v'-*(#V'z.h'.2m+*(#F'.h'|\n:u'v'*(#V'
  112. .ds 8 h'*(#H'(*bh'-*(#H'
  113. .ds o \k:h'-(\n(.wu+w'(de'u-*(#H)/2u'v'-.3n'*(#[z(dev'.3n'h'|\n:u'*(#]
  114. .ds d- h'*(#H'(pdh'-w'~'u'v'-.25m'f2(hyfPv'.25m'h'-*(#H'
  115. .ds D- D\k:h'-w'D'u'v'-.11m'z(hyv'.11m'h'|\n:u'
  116. .ds th *(#[v'.3m's+1Is-1v'-.3m'h'-(w'I'u*2/3)'s-1os+1*(#]
  117. .ds Th *(#[s+2Is-2h'-w'I'u*3/5'v'-.3m'ov'.3m'*(#]
  118. .ds ae ah'-(w'a'u*4/10)'e
  119. .ds Ae Ah'-(w'A'u*4/10)'E
  120. .    " corrections for vroff
  121. .if v .ds ~ \k:h'-(\n(.wu*9/10-*(#H)'s-2u~ds+2h'|\n:u'
  122. .if v .ds ^ \k:h'-(\n(.wu*10/11-*(#H)'v'-.4m'^v'.4m'h'|\n:u'
  123. .    " for low resolution devices (crt and lpr)
  124. .if n(.H>23 .if n(.V>19 
  125. {
  126. .    ds : e
  127. .    ds 8 ss
  128. .    ds o a
  129. .    ds d- dh'-1'(ga
  130. .    ds D- Dh'-1'(hy
  131. .    ds th o'bp'
  132. .    ds Th o'LP'
  133. .    ds ae ae
  134. .    ds Ae AE
  135. .}
  136. .rm #[ #] #H #V #F C
  137. ." ======================================================================
  138. ."
  139. .IX Title "Text::Align 3"
  140. .TH Text::Align 3 "perl v5.6.1" "2000-03-18" "User Contributed Perl Documentation"
  141. .UC
  142. .SH "NAME"
  143. &s-1GD:s0:Text::Align - Draw aligned strings
  144. .SH "SYNOPSIS"
  145. .IX Header "SYNOPSIS"
  146. .Vb 2
  147. &  use GD;
  148. &  use GD::Text::Align;
  149. .Ve
  150. .Vb 2
  151. &  my $gd = GD::Image->new(800,600);
  152. &  # allocate colours, do other things.
  153. .Ve
  154. .Vb 9
  155. &  my $align = GD::Text::Align->new($gd
  156. &    valign => 'top',
  157. &    halign => 'right',
  158. &  );
  159. &  $align->set_font('cetus.ttf', 12);
  160. &  $align->set_text('some string');
  161. &  @bb = $align->bounding_box(200, 400, PI/3);
  162. &  # you can do things based on the bounding box here
  163. &  $align->draw(200, 400, PI/3);
  164. .Ve
  165. .SH "DESCRIPTION"
  166. .IX Header "DESCRIPTION"
  167. &s-1GD:s0:Text::Align provides an object that draws a string aligned
  168. to a coordinate at an angle.
  169. .PP
  170. For builtin fonts only two angles are valid: 0 and *(PI/2s0. All other
  171. angles will be converted to one of these two.
  172. .SH "METHODS"
  173. .IX Header "METHODS"
  174. This class inherits everything from s-1GD:s0:Text. I will only discuss the
  175. methods and attributes here that are not discussed there, or that have a
  176. different interface or behaviour. Methods directly inherited include
  177. &f(CW*(C`set_text*(C'fR and f(CW*(C`set_font*(C'fR.
  178. .Sh "s-1GD:s0:Text::Align->new($gd_object, attrib => value, ...)"
  179. .IX Subsection "GD::Text::Align->new($gd_object, attrib => value, ...)"
  180. Create a new object. The first argument to new has to be a valid
  181. &s-1GD:s0:Image object. The other arguments will be passed on to the set
  182. method.
  183. .Sh "$align->set(attrib => value, ...)"
  184. .IX Subsection "$align->set(attrib => value, ...)"
  185. Set an attribute. Valid attributes are the ones discussed in
  186. the GD::Text manpage and:
  187. .Ip "valign, halign" 4
  188. .IX Item "valign, halign"
  189. Vertical and horizontal alignment of the string. See also set_valign and
  190. set_halign.
  191. .Ip "colour, color" 4
  192. .IX Item "colour, color"
  193. Synonyms. The colour to use to draw the string. This should be the index
  194. of the colour in the s-1GD:s0:Image object's palette. The default value is
  195. the last colour in the s-1GDs0 object's palette at the time of the creation
  196. of f(CW*(C`$align*(C'fR.
  197. .Sh "$align->get(attribute)"
  198. .IX Subsection "$align->get(attribute)"
  199. Get the value of an attribute.
  200. Valid attributes are all the attributes mentioned in the GD::Text manpage, the
  201. attributes mentioned under the f(CW*(C`set*(C'fR method and
  202. .Ip "x, y and angle" 4
  203. .IX Item "x, y and angle"
  204. The x and y coordinate and the angle to be used. You can only do this
  205. after a call to the draw or bounding_box methods. Note that these
  206. coordinates are not necessarily the same ones that were passed in.
  207. Instead, they are the coordinates from where the s-1GDs0 methods will start
  208. drawing. I doubt that this is very useful to anyone.
  209. .PP
  210. Note that while you can set the colour with both 'color' and 'colour',
  211. you can only get it as 'colour'. Sorry, but such is life in Australia.
  212. .Sh "$align->set_valign(value)"
  213. .IX Subsection "$align->set_valign(value)"
  214. Set the vertical alignment of the string to one of 'top', 'center',
  215. &'base' or 'bottom'. For builtin fonts the last two are the same. The
  216. value 'base' denotes the baseline of a TrueType font.
  217. Returns true on success, false on failure.
  218. .Sh "$align->set_halign(value)"
  219. .IX Subsection "$align->set_halign(value)"
  220. Set the horizontal alignment of the string to one of 'left', 'center',
  221. or 'right'. 
  222. Returns true on success, false on failure.
  223. .Sh "$align->set_align(valign, halign)"
  224. .IX Subsection "$align->set_align(valign, halign)"
  225. Set the vertical and horizontal alignment. Just here for convenience.
  226. See also f(CW*(C`set_valign*(C'fR and f(CW*(C`set_halign*(C'fR.
  227. Returns true on success, false on failure.
  228. .Sh "$align->draw(x, y, angle)"
  229. .IX Subsection "$align->draw(x, y, angle)"
  230. Draw the string at coordinates fIxfR, fIyfR at an angle fIanglefR in
  231. radians. The x and y coordinate become the pivot around which the
  232. string rotates.
  233. .PP
  234. Note that for the builtin s-1GDs0 fonts the only two valid angles are 0 and
  235. &*(PI/2s0.
  236. .PP
  237. Returns the bounding box of the drawn string (see f(CW*(C`bounding_box()*(C'fR).
  238. .Sh "$align->bounding_box(x, y, angle)"
  239. .IX Subsection "$align->bounding_box(x, y, angle)"
  240. Return the bounding box of the string to draw. This returns an
  241. eight-element list (exactly like the s-1GD:s0:Image->stringTTF method):
  242. .PP
  243. .Vb 4
  244. &  (x1,y1) lower left corner
  245. &  (x2,y2) lower right corner
  246. &  (x3,y3) upper right corner
  247. &  (x4,y4) upper left corner
  248. .Ve
  249. Note that upper, lower, left and right are relative to the string, not
  250. to the canvas.
  251. .PP
  252. The bounding box can be used to make decisions about whether to move the
  253. string or change the font size prior to actually drawing the string.
  254. .SH "NOTES"
  255. .IX Header "NOTES"
  256. As with all Modules for Perl: Please stick to using the interface. If
  257. you try to fiddle too much with knowledge of the internals of this
  258. module, you may get burned. I may change them at any time.
  259. .PP
  260. You can only use TrueType fonts with version of s-1GDs0 > 1.20, and then
  261. only if compiled with support for this. If you attempt to do it
  262. anyway, you will get errors.
  263. .PP
  264. In the following, terms like 'top', 'upper', 'left' and the like are all
  265. relative to the string to be drawn, not to the canvas.
  266. .SH "BUGS"
  267. .IX Header "BUGS"
  268. Any bugs inherited from s-1GD:s0:Text.
  269. .SH "COPYRIGHT"
  270. .IX Header "COPYRIGHT"
  271. copyright 1999
  272. Martien Verbruggen (mgjv@comdyn.com.au)
  273. .SH "SEE ALSO"
  274. .IX Header "SEE ALSO"
  275. the GD manpage, the GD::Text manpage, the GD::Text::Wrap manpage