Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Pastel::Geometry::AffineTransform.3
CommitLineData
86530b38
AT
1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Pastel::Geometry::AffineTransform 3"
132.TH Pastel::Geometry::AffineTransform 3 "2003-01-06" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134Pastel::Geometry::AffineTranform\r
135.PP
136This module encapsulates the 2D tranformation matrix of graphics.\r
137.SH "DESCRIPTION"
138.IX Header "DESCRIPTION"
139Every elements of the graphics object can be geometrically transformed. \r
140\&\s-1SVG\s0 specification allows \- Translation, Scaling, Roatation and Skew. \r
141Transformation itself is represented by a 3 X 3 matrix. Like in Java \r
142AffineTranform class we will represent it here like this\-\r
143.PP
144.Vb 3
145\& [ x'] [ m00 m01 m02 ] [ x ] [ m00x + m01y + m02 ]\r
146\& [ y'] = [ m10 m11 m12 ] [ y ] = [ m10x + m11y + m12 ]\r
147\& [ 1 ] [ 0 0 1 ] [ 1 ] [ 1 ]
148.Ve
149.PP
150.Vb 3
151\& Where x' and y' are the new coordinates and x and y are the old ones.\r
152\& In SVG it is represented as-\r
153\& <g transform="matrix(m00,m10,m01,m11,m02,m12)">...</g>
154.Ve
155.PP
156<B>Translation:</B>\r
157.PP
158.Vb 3
159\& [ x'] [ 1 0 tx ] [ x ] \r
160\& [ y'] = [ 0 1 ty ] [ y ] \r
161\& [ 1 ] [ 0 0 1 ] [ 1 ]
162.Ve
163.PP
164.Vb 3
165\& Where tx and ty are the distances to translate. It is represented\r
166\& in SVG as-\r
167\& <g transform="translate(tx, ty)">...</g>
168.Ve
169.PP
170<B>Scaling:</B> \r
171.PP
172.Vb 3
173\& [ x'] [ Sx 0 0 ] [ x ] \r
174\& [ y'] = [ 0 Sy 0 ] [ y ] \r
175\& [ 1 ] [ 0 0 1 ] [ 1 ]
176.Ve
177.PP
178In \s-1SVG\-\s0\r
179 <g transform=\*(L"scale(Sx, Sy)\*(R">...</g>\r
180 If Sy is not provided it is assumed to be equals to Sx.\r
181.PP
182<b>Rotation:</b>\r
183 [ x'] [ cos(a) \-sin(a) 0 ] [ x ] \r
184 [ y'] = [ sin(a) cos(a) 0 ] [ y ] \r
185 [ 1 ] [ 0 0 1 ] [ 1 ]\r
186.PP
187In \s-1SVG\-\s0\r
188.PP
189.Vb 3
190\& <g transform="rotate(a, [x, y])">...</g>\r
191\& If x and y are provided is like translating to that point then rotating\r
192\& and then coming to the original position.
193.Ve
194.PP
195<b>SkewX and Y:</b>\r
196.PP
197.Vb 2
198\& <g transform="skewX(a)">...</g>\r
199\& <g transform="skewY(a)">...</g>
200.Ve
201.SH "SYNOPSIS"
202.IX Header "SYNOPSIS"
203.Vb 5
204\& use Pastel;\r
205\& my $g2 = Pastel::Graphics->new(...);\r
206\& # Create two tranfoms\r
207\& my $transform1 = Pastel::Geometry::AffineTranform->new();\r
208\& my $transform2 = Pastel::Geometry::AffineTranform->new();
209.Ve
210.PP
211.Vb 3
212\& # Modify Transfom1\r
213\& $transform1->set_to_indentity();\r
214\& $transform1->rotate(45);
215.Ve
216.PP
217.Vb 2
218\& # Modify Transform2\r
219\& $transform2->scale(0.5,0.5);
220.Ve
221.PP
222.Vb 2
223\& # Join both the transform\r
224\& $transform1->concatanate($transform2);
225.Ve
226.PP
227.Vb 2
228\& # To concatanate to existing transform in $g2 call transform()\r
229\& $g2->transform($transform1);
230.Ve
231.PP
232.Vb 2
233\& # To replace the existing transform\r
234\& $g2->set_transform($transform2);
235.Ve
236.SH "CONSTRUCTORS"
237.IX Header "CONSTRUCTORS"
238.IP "Pastel::Geometry::AffineTransform\->\fInew()\fR" 4
239.IX Item "Pastel::Geometry::AffineTransform->new()"
240.PD 0
241.IP "Pastel::Geometry::AffineTransform\->new(\-transform=>$tx)" 4
242.IX Item "Pastel::Geometry::AffineTransform->new(-transform=>$tx)"
243.PD
244$tx is another Pastel::Geometry::AffineTransform object. \r
245.IP "Pastel::Geometry::AffineTransform\->new(@array)" 4
246.IX Item "Pastel::Geometry::AffineTransform->new(@array)"
247@array is 4 or 6 elements numbers representing 4 non-tranaslatable entries\r
248or the complete array of 6 specifiable entries of 3 X 3 transformation matrix.\r
249.ie n .IP "Pastel::Geometry::AffineTransform\->new(\-m00=>$n, \-m10=>$n, \-m01=>$n, \-m11=>$n, \-m02=>$n, \-m12=>, $n)" 4
250.el .IP "Pastel::Geometry::AffineTransform\->new(\-m00=>$n, \-m10=>$n, \-m01=>$n, \-m11=>$n, \-m02=>$n, \-m12=>, \f(CW$n\fR)" 4
251.IX Item "Pastel::Geometry::AffineTransform->new(-m00=>$n, -m10=>$n, -m01=>$n, -m11=>$n, -m02=>$n, -m12=>, $n)"
252Complete transformation matrix. \f(CW$n\fR = numbers.\r
253.IP "Pastel::Geometry::AffineTransform\->new($n1,$n2,$n3,$n4,$n5,$n6)" 4
254.IX Item "Pastel::Geometry::AffineTransform->new($n1,$n2,$n3,$n4,$n5,$n6)"
255.PD 0
256.IP "Pastel::Geometry::AffineTransform\->new(\-m00=>$n, \-m10=>$n, \-m01=>$n, \-m11=>$n)" 4
257.IX Item "Pastel::Geometry::AffineTransform->new(-m00=>$n, -m10=>$n, -m01=>$n, -m11=>$n)"