Add to git.
[c2lib.git] / doc / point_is_inside_plane.3.html
1 <html>
2 <head>
3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>point_distance_to_plane</title>
6 </head>
7 <body>
8
9 <h1 align=center>point_distance_to_plane</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#AUTHOR">AUTHOR</a><br>
14 <a href="#LICENSE">LICENSE</a><br>
15 <a href="#VERSION">VERSION</a><br>
16 <a href="#SEE ALSO">SEE ALSO</a><br>
17
18 <hr>
19 <!-- Creator     : groff version 1.17.2 -->
20 <!-- CreationDate: Fri May  3 14:57:39 2002 -->
21 <a name="NAME"></a>
22 <h2>NAME</h2>
23 <table width="100%" border=0 rules="none" frame="void"
24        cols="2" cellspacing="0" cellpadding="0">
25 <tr valign="top" align="left">
26 <td width="10%"></td><td width="90%">
27 point_distance_to_plane, point_is_inside_plane - distance from point to plane</td></table>
28 <a name="SYNOPSIS"></a>
29 <h2>SYNOPSIS</h2>
30
31 <table width="100%" border=0 rules="none" frame="void"
32        cols="2" cellspacing="0" cellpadding="0">
33 <tr valign="top" align="left">
34 <td width="10%"></td><td width="90%">
35 <pre><b>#include &lt;matvec.h&gt;
36
37 float point_distance_to_plane (const float *plane, const float *point);
38 int point_is_inside_plane (const float *plane, const float *point);
39 </b></pre></td></table>
40 <a name="DESCRIPTION"></a>
41 <h2>DESCRIPTION</h2>
42
43 <table width="100%" border=0 rules="none" frame="void"
44        cols="2" cellspacing="0" cellpadding="0">
45 <tr valign="top" align="left">
46 <td width="10%"></td><td width="90%">
47 <b>point_distance_to_plane</b> calculates the (shortest)
48 distance from the point <b>point</b> to the plane
49 <b>plane</b>. This distance is positive if the point is
50 &quot;inside&quot; the plane -- that is, if the normal
51 vector drawn from the plane points towards the point. It is
52 negative if the point is &quot;outside&quot; the plane. It
53 is zero if the point lies on the plane.</td></table>
54
55 <table width="100%" border=0 rules="none" frame="void"
56        cols="2" cellspacing="0" cellpadding="0">
57 <tr valign="top" align="left">
58 <td width="10%"></td><td width="90%">
59 <b>point_is_inside_plane</b> returns true if the point is
60 strictly inside the plane, and false if the point lies on
61 the plane or is outside. It is much faster to compute this
62 than to use <b>point_distance_to_plane</b> and take the sign
63 of the result.</td></table>
64 <a name="AUTHOR"></a>
65 <h2>AUTHOR</h2>
66
67 <table width="100%" border=0 rules="none" frame="void"
68        cols="2" cellspacing="0" cellpadding="0">
69 <tr valign="top" align="left">
70 <td width="10%"></td><td width="90%">
71 Richard Jones &lt;rich@annexia.org&gt;</td></table>
72 <a name="LICENSE"></a>
73 <h2>LICENSE</h2>
74
75 <table width="100%" border=0 rules="none" frame="void"
76        cols="2" cellspacing="0" cellpadding="0">
77 <tr valign="top" align="left">
78 <td width="10%"></td><td width="90%">
79 GNU LGPL (see http://www.gnu.org/)</td></table>
80 <a name="VERSION"></a>
81 <h2>VERSION</h2>
82
83 <table width="100%" border=0 rules="none" frame="void"
84        cols="2" cellspacing="0" cellpadding="0">
85 <tr valign="top" align="left">
86 <td width="10%"></td><td width="90%">
87 c2lib-1.2.13</td></table>
88 <a name="SEE ALSO"></a>
89 <h2>SEE ALSO</h2>
90
91 <table width="100%" border=0 rules="none" frame="void"
92        cols="2" cellspacing="0" cellpadding="0">
93 <tr valign="top" align="left">
94 <td width="10%"></td><td width="90%">
95 <b>plane_coefficients(3)</b>,
96 <b>point_distance_to_face(3)</b>.</td></table>
97 <hr>
98 </body>
99 </html>