Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
307 chris 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc (build 1.6.0_26) on Sun Jun 03 02:18:09 CEST 2012 -->
6
<TITLE>
7
Plane (libgdx API)
8
</TITLE>
9
 
10
<META NAME="date" CONTENT="2012-06-03">
11
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
 
14
<SCRIPT type="text/javascript">
15
function windowTitle()
16
{
17
    if (location.href.indexOf('is-external=true') == -1) {
18
        parent.document.title="Plane (libgdx API)";
19
    }
20
}
21
</SCRIPT>
22
<NOSCRIPT>
23
</NOSCRIPT>
24
 
25
</HEAD>
26
 
27
<BODY BGCOLOR="white" onload="windowTitle();">
28
<HR>
29
 
30
 
31
<!-- ========= START OF TOP NAVBAR ======= -->
32
<A NAME="navbar_top"><!-- --></A>
33
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35
<TR>
36
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37
<A NAME="navbar_top_firstrow"><!-- --></A>
38
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39
  <TR ALIGN="center" VALIGN="top">
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Plane.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48
  </TR>
49
</TABLE>
50
</TD>
51
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52
 
53
                                libgdx API
54
                                <style>
55
                                body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
56
                                pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
57
                                h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%;  font-weight:bold }
58
                                .TableHeadingColor { background:#EEEEFF; }
59
                                a { text-decoration:none }
60
                                a:hover { text-decoration:underline }
61
                                a:link, a:visited { color:blue }
62
                                table { border:0px }
63
                                .TableRowColor td:first-child { border-left:1px solid black }
64
                                .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
65
                                hr { border:0px; border-bottom:1px solid #333366; }
66
                                </style>
67
                        </EM>
68
</TD>
69
</TR>
70
 
71
<TR>
72
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
73
&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Matrix4.html" title="class in com.badlogic.gdx.math"><B>PREV CLASS</B></A>&nbsp;
74
&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math"><B>NEXT CLASS</B></A></FONT></TD>
75
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
76
  <A HREF="../../../../index.html?com/badlogic/gdx/math/Plane.html" target="_top"><B>FRAMES</B></A>  &nbsp;
77
&nbsp;<A HREF="Plane.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
78
&nbsp;<SCRIPT type="text/javascript">
79
  <!--
80
  if(window==top) {
81
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
82
  }
83
  //-->
84
</SCRIPT>
85
<NOSCRIPT>
86
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
87
</NOSCRIPT>
88
 
89
 
90
</FONT></TD>
91
</TR>
92
<TR>
93
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
94
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
95
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
96
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
97
</TR>
98
</TABLE>
99
<A NAME="skip-navbar_top"></A>
100
<!-- ========= END OF TOP NAVBAR ========= -->
101
 
102
<HR>
103
<!-- ======== START OF CLASS DATA ======== -->
104
<H2>
105
<FONT SIZE="-1">
106
com.badlogic.gdx.math</FONT>
107
<BR>
108
Class Plane</H2>
109
<PRE>
110
java.lang.Object
111
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.math.Plane</B>
112
</PRE>
113
<DL>
114
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
115
</DL>
116
<HR>
117
<DL>
118
<DT><PRE>public class <B>Plane</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
119
</PRE>
120
 
121
<P>
122
A plane defined via a unit length normal and the distance from the origin, as you learned in your math class.
123
<P>
124
 
125
<P>
126
<DL>
127
<DT><B>Author:</B></DT>
128
  <DD>badlogicgames@gmail.com</DD>
129
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.badlogic.gdx.math.Plane">Serialized Form</A></DL>
130
<HR>
131
 
132
<P>
133
<!-- ======== NESTED CLASS SUMMARY ======== -->
134
 
135
<A NAME="nested_class_summary"><!-- --></A>
136
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139
<B>Nested Class Summary</B></FONT></TH>
140
</TR>
141
<TR BGCOLOR="white" CLASS="TableRowColor">
142
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143
<CODE>static&nbsp;class</CODE></FONT></TD>
144
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math">Plane.PlaneSide</A></B></CODE>
145
 
146
<BR>
147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enum specifying on which side a point lies respective to the plane and it's normal.</TD>
148
</TR>
149
</TABLE>
150
&nbsp;<!-- =========== FIELD SUMMARY =========== -->
151
 
152
<A NAME="field_summary"><!-- --></A>
153
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
156
<B>Field Summary</B></FONT></TH>
157
</TR>
158
<TR BGCOLOR="white" CLASS="TableRowColor">
159
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160
<CODE>&nbsp;float</CODE></FONT></TD>
161
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#d">d</A></B></CODE>
162
 
163
<BR>
164
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
165
</TR>
166
<TR BGCOLOR="white" CLASS="TableRowColor">
167
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168
<CODE>&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A></CODE></FONT></TD>
169
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#normal">normal</A></B></CODE>
170
 
171
<BR>
172
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173
</TR>
174
</TABLE>
175
&nbsp;
176
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
177
 
178
<A NAME="constructor_summary"><!-- --></A>
179
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
182
<B>Constructor Summary</B></FONT></TH>
183
</TR>
184
<TR BGCOLOR="white" CLASS="TableRowColor">
185
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#Plane(com.badlogic.gdx.math.Vector3, float)">Plane</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal,
186
      float&nbsp;d)</CODE>
187
 
188
<BR>
189
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new plane based on the normal and distance to the origin.</TD>
190
</TR>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#Plane(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)">Plane</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal,
193
      <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</CODE>
194
 
195
<BR>
196
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new plane based on the normal and a point on the plane.</TD>
197
</TR>
198
<TR BGCOLOR="white" CLASS="TableRowColor">
199
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#Plane(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)">Plane</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point1,
200
      <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point2,
201
      <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point3)</CODE>
202
 
203
<BR>
204
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new plane out of the three given points that are considered to be on the plane.</TD>
205
</TR>
206
</TABLE>
207
&nbsp;
208
<!-- ========== METHOD SUMMARY =========== -->
209
 
210
<A NAME="method_summary"><!-- --></A>
211
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
214
<B>Method Summary</B></FONT></TH>
215
</TR>
216
<TR BGCOLOR="white" CLASS="TableRowColor">
217
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218
<CODE>&nbsp;float</CODE></FONT></TD>
219
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#distance(com.badlogic.gdx.math.Vector3)">distance</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</CODE>
220
 
221
<BR>
222
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculates the shortest signed distance between the plane and the given point.</TD>
223
</TR>
224
<TR BGCOLOR="white" CLASS="TableRowColor">
225
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226
<CODE>&nbsp;float</CODE></FONT></TD>
227
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#getD()">getD</A></B>()</CODE>
228
 
229
<BR>
230
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
231
</TR>
232
<TR BGCOLOR="white" CLASS="TableRowColor">
233
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234
<CODE>&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A></CODE></FONT></TD>
235
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#getNormal()">getNormal</A></B>()</CODE>
236
 
237
<BR>
238
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
239
</TR>
240
<TR BGCOLOR="white" CLASS="TableRowColor">
241
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242
<CODE>&nbsp;boolean</CODE></FONT></TD>
243
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#isFrontFacing(com.badlogic.gdx.math.Vector3)">isFrontFacing</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;direction)</CODE>
244
 
245
<BR>
246
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether the plane is facing the direction vector.</TD>
247
</TR>
248
<TR BGCOLOR="white" CLASS="TableRowColor">
249
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250
<CODE>&nbsp;void</CODE></FONT></TD>
251
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#set(float, float, float, float)">set</A></B>(float&nbsp;nx,
252
    float&nbsp;ny,
253
    float&nbsp;nz,
254
    float&nbsp;d)</CODE>
255
 
256
<BR>
257
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the plane normal and distance</TD>
258
</TR>
259
<TR BGCOLOR="white" CLASS="TableRowColor">
260
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261
<CODE>&nbsp;void</CODE></FONT></TD>
262
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#set(float, float, float, float, float, float)">set</A></B>(float&nbsp;pointX,
263
    float&nbsp;pointY,
264
    float&nbsp;pointZ,
265
    float&nbsp;norX,
266
    float&nbsp;norY,
267
    float&nbsp;norZ)</CODE>
268
 
269
<BR>
270
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
271
</TR>
272
<TR BGCOLOR="white" CLASS="TableRowColor">
273
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
274
<CODE>&nbsp;void</CODE></FONT></TD>
275
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#set(com.badlogic.gdx.math.Plane)">set</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Plane.html" title="class in com.badlogic.gdx.math">Plane</A>&nbsp;plane)</CODE>
276
 
277
<BR>
278
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets this plane from the given plane</TD>
279
</TR>
280
<TR BGCOLOR="white" CLASS="TableRowColor">
281
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282
<CODE>&nbsp;void</CODE></FONT></TD>
283
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#set(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)">set</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point,
284
    <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal)</CODE>
285
 
286
<BR>
287
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the plane to the given point and normal.</TD>
288
</TR>
289
<TR BGCOLOR="white" CLASS="TableRowColor">
290
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291
<CODE>&nbsp;void</CODE></FONT></TD>
292
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#set(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)">set</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point1,
293
    <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point2,
294
    <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point3)</CODE>
295
 
296
<BR>
297
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the plane normal and distance to the origin based on the three given points which are considered to be on the plane.</TD>
298
</TR>
299
<TR BGCOLOR="white" CLASS="TableRowColor">
300
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301
<CODE>&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math">Plane.PlaneSide</A></CODE></FONT></TD>
302
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#testPoint(float, float, float)">testPoint</A></B>(float&nbsp;x,
303
          float&nbsp;y,
304
          float&nbsp;z)</CODE>
305
 
306
<BR>
307
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns on which side the given point lies relative to the plane and its normal.</TD>
308
</TR>
309
<TR BGCOLOR="white" CLASS="TableRowColor">
310
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311
<CODE>&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math">Plane.PlaneSide</A></CODE></FONT></TD>
312
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#testPoint(com.badlogic.gdx.math.Vector3)">testPoint</A></B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</CODE>
313
 
314
<BR>
315
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns on which side the given point lies relative to the plane and its normal.</TD>
316
</TR>
317
<TR BGCOLOR="white" CLASS="TableRowColor">
318
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
320
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/math/Plane.html#toString()">toString</A></B>()</CODE>
321
 
322
<BR>
323
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
324
</TR>
325
</TABLE>
326
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
327
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
328
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
329
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
330
</TR>
331
<TR BGCOLOR="white" CLASS="TableRowColor">
332
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
333
</TR>
334
</TABLE>
335
&nbsp;
336
<P>
337
 
338
<!-- ============ FIELD DETAIL =========== -->
339
 
340
<A NAME="field_detail"><!-- --></A>
341
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
342
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
343
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
344
<B>Field Detail</B></FONT></TH>
345
</TR>
346
</TABLE>
347
 
348
<A NAME="normal"><!-- --></A><H3>
349
normal</H3>
350
<PRE>
351
public final <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A> <B>normal</B></PRE>
352
<DL>
353
<DL>
354
</DL>
355
</DL>
356
<HR>
357
 
358
<A NAME="d"><!-- --></A><H3>
359
d</H3>
360
<PRE>
361
public float <B>d</B></PRE>
362
<DL>
363
<DL>
364
</DL>
365
</DL>
366
 
367
<!-- ========= CONSTRUCTOR DETAIL ======== -->
368
 
369
<A NAME="constructor_detail"><!-- --></A>
370
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
371
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
372
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
373
<B>Constructor Detail</B></FONT></TH>
374
</TR>
375
</TABLE>
376
 
377
<A NAME="Plane(com.badlogic.gdx.math.Vector3, float)"><!-- --></A><H3>
378
Plane</H3>
379
<PRE>
380
public <B>Plane</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal,
381
             float&nbsp;d)</PRE>
382
<DL>
383
<DD>Constructs a new plane based on the normal and distance to the origin.
384
<P>
385
<DL>
386
<DT><B>Parameters:</B><DD><CODE>normal</CODE> - The plane normal<DD><CODE>d</CODE> - The distance to the origin</DL>
387
</DL>
388
<HR>
389
 
390
<A NAME="Plane(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
391
Plane</H3>
392
<PRE>
393
public <B>Plane</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal,
394
             <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</PRE>
395
<DL>
396
<DD>Constructs a new plane based on the normal and a point on the plane.
397
<P>
398
<DL>
399
<DT><B>Parameters:</B><DD><CODE>normal</CODE> - The normal<DD><CODE>point</CODE> - The point on the plane</DL>
400
</DL>
401
<HR>
402
 
403
<A NAME="Plane(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
404
Plane</H3>
405
<PRE>
406
public <B>Plane</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point1,
407
             <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point2,
408
             <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point3)</PRE>
409
<DL>
410
<DD>Constructs a new plane out of the three given points that are considered to be on the plane. The normal is calculated via a
411
 cross product between (point1-point2)x(point2-point3)
412
<P>
413
<DL>
414
<DT><B>Parameters:</B><DD><CODE>point1</CODE> - The first point<DD><CODE>point2</CODE> - The second point<DD><CODE>point3</CODE> - The third point</DL>
415
</DL>
416
 
417
<!-- ============ METHOD DETAIL ========== -->
418
 
419
<A NAME="method_detail"><!-- --></A>
420
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
421
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
422
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
423
<B>Method Detail</B></FONT></TH>
424
</TR>
425
</TABLE>
426
 
427
<A NAME="set(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
428
set</H3>
429
<PRE>
430
public void <B>set</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point1,
431
                <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point2,
432
                <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point3)</PRE>
433
<DL>
434
<DD>Sets the plane normal and distance to the origin based on the three given points which are considered to be on the plane.
435
 The normal is calculated via a cross product between (point1-point2)x(point2-point3)
436
<P>
437
<DD><DL>
438
</DL>
439
</DD>
440
<DD><DL>
441
<DT><B>Parameters:</B><DD><CODE>point1</CODE> - <DD><CODE>point2</CODE> - <DD><CODE>point3</CODE> - </DL>
442
</DD>
443
</DL>
444
<HR>
445
 
446
<A NAME="set(float, float, float, float)"><!-- --></A><H3>
447
set</H3>
448
<PRE>
449
public void <B>set</B>(float&nbsp;nx,
450
                float&nbsp;ny,
451
                float&nbsp;nz,
452
                float&nbsp;d)</PRE>
453
<DL>
454
<DD>Sets the plane normal and distance
455
<P>
456
<DD><DL>
457
</DL>
458
</DD>
459
<DD><DL>
460
<DT><B>Parameters:</B><DD><CODE>nx</CODE> - normal x-component<DD><CODE>ny</CODE> - normal y-component<DD><CODE>nz</CODE> - normal z-component<DD><CODE>d</CODE> - distance to origin</DL>
461
</DD>
462
</DL>
463
<HR>
464
 
465
<A NAME="distance(com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
466
distance</H3>
467
<PRE>
468
public float <B>distance</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</PRE>
469
<DL>
470
<DD>Calculates the shortest signed distance between the plane and the given point.
471
<P>
472
<DD><DL>
473
</DL>
474
</DD>
475
<DD><DL>
476
<DT><B>Parameters:</B><DD><CODE>point</CODE> - The point
477
<DT><B>Returns:</B><DD>the shortest signed distance between the plane and the point</DL>
478
</DD>
479
</DL>
480
<HR>
481
 
482
<A NAME="testPoint(com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
483
testPoint</H3>
484
<PRE>
485
public <A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math">Plane.PlaneSide</A> <B>testPoint</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point)</PRE>
486
<DL>
487
<DD>Returns on which side the given point lies relative to the plane and its normal. PlaneSide.Front refers to the side the
488
 plane normal points to.
489
<P>
490
<DD><DL>
491
</DL>
492
</DD>
493
<DD><DL>
494
<DT><B>Parameters:</B><DD><CODE>point</CODE> - The point
495
<DT><B>Returns:</B><DD>The side the point lies relative to the plane</DL>
496
</DD>
497
</DL>
498
<HR>
499
 
500
<A NAME="testPoint(float, float, float)"><!-- --></A><H3>
501
testPoint</H3>
502
<PRE>
503
public <A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math">Plane.PlaneSide</A> <B>testPoint</B>(float&nbsp;x,
504
                                 float&nbsp;y,
505
                                 float&nbsp;z)</PRE>
506
<DL>
507
<DD>Returns on which side the given point lies relative to the plane and its normal. PlaneSide.Front refers to the side the
508
 plane normal points to.
509
<P>
510
<DD><DL>
511
</DL>
512
</DD>
513
<DD><DL>
514
<DT><B>Parameters:</B><DD><CODE>x</CODE> - <DD><CODE>y</CODE> - <DD><CODE>z</CODE> -
515
<DT><B>Returns:</B><DD>The side the point lies relative to the plane</DL>
516
</DD>
517
</DL>
518
<HR>
519
 
520
<A NAME="isFrontFacing(com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
521
isFrontFacing</H3>
522
<PRE>
523
public boolean <B>isFrontFacing</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;direction)</PRE>
524
<DL>
525
<DD>Returns whether the plane is facing the direction vector. Think of the direction vector as the direction a camera looks in.
526
 This method will return true if the front side of the plane determined by its normal faces the camera.
527
<P>
528
<DD><DL>
529
</DL>
530
</DD>
531
<DD><DL>
532
<DT><B>Parameters:</B><DD><CODE>direction</CODE> - the direction
533
<DT><B>Returns:</B><DD>whether the plane is front facing</DL>
534
</DD>
535
</DL>
536
<HR>
537
 
538
<A NAME="getNormal()"><!-- --></A><H3>
539
getNormal</H3>
540
<PRE>
541
public <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A> <B>getNormal</B>()</PRE>
542
<DL>
543
<DD><DL>
544
</DL>
545
</DD>
546
<DD><DL>
547
 
548
<DT><B>Returns:</B><DD>The normal</DL>
549
</DD>
550
</DL>
551
<HR>
552
 
553
<A NAME="getD()"><!-- --></A><H3>
554
getD</H3>
555
<PRE>
556
public float <B>getD</B>()</PRE>
557
<DL>
558
<DD><DL>
559
</DL>
560
</DD>
561
<DD><DL>
562
 
563
<DT><B>Returns:</B><DD>The distance to the origin</DL>
564
</DD>
565
</DL>
566
<HR>
567
 
568
<A NAME="set(com.badlogic.gdx.math.Vector3, com.badlogic.gdx.math.Vector3)"><!-- --></A><H3>
569
set</H3>
570
<PRE>
571
public void <B>set</B>(<A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;point,
572
                <A HREF="../../../../com/badlogic/gdx/math/Vector3.html" title="class in com.badlogic.gdx.math">Vector3</A>&nbsp;normal)</PRE>
573
<DL>
574
<DD>Sets the plane to the given point and normal.
575
<P>
576
<DD><DL>
577
</DL>
578
</DD>
579
<DD><DL>
580
<DT><B>Parameters:</B><DD><CODE>point</CODE> - the point on the plane<DD><CODE>normal</CODE> - the normal of the plane</DL>
581
</DD>
582
</DL>
583
<HR>
584
 
585
<A NAME="set(float, float, float, float, float, float)"><!-- --></A><H3>
586
set</H3>
587
<PRE>
588
public void <B>set</B>(float&nbsp;pointX,
589
                float&nbsp;pointY,
590
                float&nbsp;pointZ,
591
                float&nbsp;norX,
592
                float&nbsp;norY,
593
                float&nbsp;norZ)</PRE>
594
<DL>
595
<DD><DL>
596
</DL>
597
</DD>
598
<DD><DL>
599
</DL>
600
</DD>
601
</DL>
602
<HR>
603
 
604
<A NAME="set(com.badlogic.gdx.math.Plane)"><!-- --></A><H3>
605
set</H3>
606
<PRE>
607
public void <B>set</B>(<A HREF="../../../../com/badlogic/gdx/math/Plane.html" title="class in com.badlogic.gdx.math">Plane</A>&nbsp;plane)</PRE>
608
<DL>
609
<DD>Sets this plane from the given plane
610
<P>
611
<DD><DL>
612
</DL>
613
</DD>
614
<DD><DL>
615
<DT><B>Parameters:</B><DD><CODE>plane</CODE> - the plane</DL>
616
</DD>
617
</DL>
618
<HR>
619
 
620
<A NAME="toString()"><!-- --></A><H3>
621
toString</H3>
622
<PRE>
623
public java.lang.String <B>toString</B>()</PRE>
624
<DL>
625
<DD><DL>
626
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
627
</DD>
628
<DD><DL>
629
</DL>
630
</DD>
631
</DL>
632
<!-- ========= END OF CLASS DATA ========= -->
633
<HR>
634
 
635
 
636
<!-- ======= START OF BOTTOM NAVBAR ====== -->
637
<A NAME="navbar_bottom"><!-- --></A>
638
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
639
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
640
<TR>
641
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
642
<A NAME="navbar_bottom_firstrow"><!-- --></A>
643
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
644
  <TR ALIGN="center" VALIGN="top">
645
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
646
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
647
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
648
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Plane.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
649
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
650
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
651
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
652
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
653
  </TR>
654
</TABLE>
655
</TD>
656
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
657
libgdx API</EM>
658
</TD>
659
</TR>
660
 
661
<TR>
662
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
663
&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Matrix4.html" title="class in com.badlogic.gdx.math"><B>PREV CLASS</B></A>&nbsp;
664
&nbsp;<A HREF="../../../../com/badlogic/gdx/math/Plane.PlaneSide.html" title="enum in com.badlogic.gdx.math"><B>NEXT CLASS</B></A></FONT></TD>
665
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
666
  <A HREF="../../../../index.html?com/badlogic/gdx/math/Plane.html" target="_top"><B>FRAMES</B></A>  &nbsp;
667
&nbsp;<A HREF="Plane.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
668
&nbsp;<SCRIPT type="text/javascript">
669
  <!--
670
  if(window==top) {
671
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
672
  }
673
  //-->
674
</SCRIPT>
675
<NOSCRIPT>
676
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
677
</NOSCRIPT>
678
 
679
 
680
</FONT></TD>
681
</TR>
682
<TR>
683
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
684
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
685
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
686
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
687
</TR>
688
</TABLE>
689
<A NAME="skip-navbar_bottom"></A>
690
<!-- ======== END OF BOTTOM NAVBAR ======= -->
691
 
692
<HR>
693
 
694
                                <div style="font-size:9pt"><i>
695
                                Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
696
                                </i></div>
697
 
698
</BODY>
699
</HTML>