[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Math::Geometry.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Geometry 3"
.TH Geometry 3 "2002-11-19" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Math::Geometry \- Geometry related functions
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Math::Geometry;
.Ve
.PP
.Vb 4
\&        @P2=rotx(@P1,$angle);
\&        @P3=rotx(@P1,$angle);
\&        @N =triangle_normal(@P1,@P2,@P3);
\&        @ZP=zplane_project(@P1,$d);
.Ve
.SH "NOTES"
.IX Header "NOTES"
This is about to get a massive overhaul, but first im adding tests,
lots of lovely lovely tests.
.PP
Currently for zplane_project onto a plane with normal of the z axis and z=0,
the function returns the orthographic projections as opposed to a perspective
projection. I'm currently looking into how to properly handle z=0 and will
update it shortly.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package implements classic geometry methods. It should be considered alpha
software and any feedback at all is greatly appreciated. The following methods
are available:
.Sh "vector_product."
.IX Subsection "vector_product."
Also known as the cross product, given two vectors in Geometry space, the
vector_product of the two vectors, is a vector which is perpendicular
to the plane of \s-1AB\s0 with length equal to the length of A multiplied
by the length of B, multiplied by the sin of @, where @ is the angle
between the two vectors.
.Sh "triangle_normal"
.IX Subsection "triangle_normal"
Given a triangle \s-1ABC\s0 that defines a plane P. This function will return
a vector N, which is a normal to the plane P.
.PP
.Vb 2
\&    ($Nx,$Ny,$Nz) =
\&       triangle_normal(($Ax,$Ay,$Az),($Bx,$By,$Bz),($Cx,$Cy,$Cz));
.Ve
.Sh "zplane_project"
.IX Subsection "zplane_project"
Project a point in Geometry space onto a plane with the z\-axis as the normal,
at a distance d from z=0.
.PP
.Vb 1
\&    ($x2,$y2,$z2) = zplane_project ($x1,$y1,$z1,$d);
.Ve
.Sh "rotx"
.IX Subsection "rotx"
Rotate about the x axis r radians.
.PP
.Vb 1
\&    ($x2,$y2,$z2) = rotx ($x1,$y1,$z1,$r);
.Ve
.Sh "roty"
.IX Subsection "roty"
Rotate about the y axis r radians.
.PP
.Vb 1
\&    ($x2,$y2,$z2) = roty ($x1,$y1,$z1,$r);
.Ve
.Sh "rotz"
.IX Subsection "rotz"
Rotate about the z axis r radians.
.PP
.Vb 1
\&    ($x2,$y2,$z2) = rotz ($x1,$y1,$z1,$r);
.Ve
.Sh "deg2rad"
.IX Subsection "deg2rad"
Convert degree's to radians.
.Sh "rad2deg"
.IX Subsection "rad2deg"
Convert radians to degree's.
.Sh "pi"
.IX Subsection "pi"
Returns an approximate value of Pi, the code has been cribed from Pg146, Programming Perl
2nd Ed.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 1
\&    use Math::Geometry;
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&    Greg McCarroll <greg@mccarroll.demon.co.uk>
.Ve
Commit	Line	Data
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(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/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(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/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'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/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(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/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 "Geometry 3"
132	.TH Geometry 3 "2002-11-19" "perl v5.8.0" "User Contributed Perl Documentation"
133	.SH "NAME"
134	Math::Geometry \- Geometry related functions
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 1
138	\& use Math::Geometry;
139	.Ve
140	.PP
141	.Vb 4
142	\& @P2=rotx(@P1,$angle);
143	\& @P3=rotx(@P1,$angle);
144	\& @N =triangle_normal(@P1,@P2,@P3);
145	\& @ZP=zplane_project(@P1,$d);
146	.Ve
147	.SH "NOTES"
148	.IX Header "NOTES"
149	This is about to get a massive overhaul, but first im adding tests,
150	lots of lovely lovely tests.
151	.PP
152	Currently for zplane_project onto a plane with normal of the z axis and z=0,
153	the function returns the orthographic projections as opposed to a perspective
154	projection. I'm currently looking into how to properly handle z=0 and will
155	update it shortly.
156	.SH "DESCRIPTION"
157	.IX Header "DESCRIPTION"
158	This package implements classic geometry methods. It should be considered alpha
159	software and any feedback at all is greatly appreciated. The following methods
160	are available:
161	.Sh "vector_product."
162	.IX Subsection "vector_product."
163	Also known as the cross product, given two vectors in Geometry space, the
164	vector_product of the two vectors, is a vector which is perpendicular
165	to the plane of \s-1AB\s0 with length equal to the length of A multiplied
166	by the length of B, multiplied by the sin of @, where @ is the angle
167	between the two vectors.
168	.Sh "triangle_normal"
169	.IX Subsection "triangle_normal"
170	Given a triangle \s-1ABC\s0 that defines a plane P. This function will return
171	a vector N, which is a normal to the plane P.
172	.PP
173	.Vb 2
174	\& ($Nx,$Ny,$Nz) =
175	\& triangle_normal(($Ax,$Ay,$Az),($Bx,$By,$Bz),($Cx,$Cy,$Cz));
176	.Ve
177	.Sh "zplane_project"
178	.IX Subsection "zplane_project"
179	Project a point in Geometry space onto a plane with the z\-axis as the normal,
180	at a distance d from z=0.
181	.PP
182	.Vb 1
183	\& ($x2,$y2,$z2) = zplane_project ($x1,$y1,$z1,$d);
184	.Ve
185	.Sh "rotx"
186	.IX Subsection "rotx"
187	Rotate about the x axis r radians.
188	.PP
189	.Vb 1
190	\& ($x2,$y2,$z2) = rotx ($x1,$y1,$z1,$r);
191	.Ve
192	.Sh "roty"
193	.IX Subsection "roty"
194	Rotate about the y axis r radians.
195	.PP
196	.Vb 1
197	\& ($x2,$y2,$z2) = roty ($x1,$y1,$z1,$r);
198	.Ve
199	.Sh "rotz"
200	.IX Subsection "rotz"
201	Rotate about the z axis r radians.
202	.PP
203	.Vb 1
204	\& ($x2,$y2,$z2) = rotz ($x1,$y1,$z1,$r);
205	.Ve
206	.Sh "deg2rad"
207	.IX Subsection "deg2rad"
208	Convert degree's to radians.
209	.Sh "rad2deg"
210	.IX Subsection "rad2deg"
211	Convert radians to degree's.
212	.Sh "pi"
213	.IX Subsection "pi"
214	Returns an approximate value of Pi, the code has been cribed from Pg146, Programming Perl
215	2nd Ed.
216	.SH "EXAMPLE"
217	.IX Header "EXAMPLE"
218	.Vb 1
219	\& use Math::Geometry;
220	.Ve
221	.SH "AUTHOR"
222	.IX Header "AUTHOR"
223	.Vb 1
224	\& Greg McCarroll <greg@mccarroll.demon.co.uk>
225	.Ve