Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
356 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 Jan 27 20:37:06 CET 2013 -->
6
<TITLE>
7
Filter (libgdx API)
8
</TITLE>
9
 
10
<META NAME="date" CONTENT="2013-01-27">
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="Filter (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/Filter.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/physics/box2d/EdgeShape.html" title="class in com.badlogic.gdx.physics.box2d"><B>PREV CLASS</B></A>&nbsp;
74
&nbsp;<A HREF="../../../../../com/badlogic/gdx/physics/box2d/Fixture.html" title="class in com.badlogic.gdx.physics.box2d"><B>NEXT CLASS</B></A></FONT></TD>
75
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
76
  <A HREF="../../../../../index.html?com/badlogic/gdx/physics/box2d/Filter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
77
&nbsp;<A HREF="Filter.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;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">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;METHOD</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.physics.box2d</FONT>
107
<BR>
108
Class Filter</H2>
109
<PRE>
110
java.lang.Object
111
  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.physics.box2d.Filter</B>
112
</PRE>
113
<HR>
114
<DL>
115
<DT><PRE>public class <B>Filter</B><DT>extends java.lang.Object</DL>
116
</PRE>
117
 
118
<P>
119
This holds contact filtering data.
120
<P>
121
 
122
<P>
123
<DL>
124
<DT><B>Author:</B></DT>
125
  <DD>mzechner</DD>
126
</DL>
127
<HR>
128
 
129
<P>
130
<!-- =========== FIELD SUMMARY =========== -->
131
 
132
<A NAME="field_summary"><!-- --></A>
133
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136
<B>Field Summary</B></FONT></TH>
137
</TR>
138
<TR BGCOLOR="white" CLASS="TableRowColor">
139
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140
<CODE>&nbsp;short</CODE></FONT></TD>
141
<TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/physics/box2d/Filter.html#categoryBits">categoryBits</A></B></CODE>
142
 
143
<BR>
144
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The collision category bits.</TD>
145
</TR>
146
<TR BGCOLOR="white" CLASS="TableRowColor">
147
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148
<CODE>&nbsp;short</CODE></FONT></TD>
149
<TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/physics/box2d/Filter.html#groupIndex">groupIndex</A></B></CODE>
150
 
151
<BR>
152
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collision groups allow a certain group of objects to never collide (negative) or always collide (positive).</TD>
153
</TR>
154
<TR BGCOLOR="white" CLASS="TableRowColor">
155
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156
<CODE>&nbsp;short</CODE></FONT></TD>
157
<TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/physics/box2d/Filter.html#maskBits">maskBits</A></B></CODE>
158
 
159
<BR>
160
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The collision mask bits.</TD>
161
</TR>
162
</TABLE>
163
&nbsp;
164
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
165
 
166
<A NAME="constructor_summary"><!-- --></A>
167
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
170
<B>Constructor Summary</B></FONT></TH>
171
</TR>
172
<TR BGCOLOR="white" CLASS="TableRowColor">
173
<TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/physics/box2d/Filter.html#Filter()">Filter</A></B>()</CODE>
174
 
175
<BR>
176
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
177
</TR>
178
</TABLE>
179
&nbsp;
180
<!-- ========== METHOD SUMMARY =========== -->
181
 
182
<A NAME="method_summary"><!-- --></A>
183
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
186
<B>Method Summary</B></FONT></TH>
187
</TR>
188
</TABLE>
189
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
190
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
192
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
193
</TR>
194
<TR BGCOLOR="white" CLASS="TableRowColor">
195
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
196
</TR>
197
</TABLE>
198
&nbsp;
199
<P>
200
 
201
<!-- ============ FIELD DETAIL =========== -->
202
 
203
<A NAME="field_detail"><!-- --></A>
204
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
207
<B>Field Detail</B></FONT></TH>
208
</TR>
209
</TABLE>
210
 
211
<A NAME="categoryBits"><!-- --></A><H3>
212
categoryBits</H3>
213
<PRE>
214
public short <B>categoryBits</B></PRE>
215
<DL>
216
<DD>The collision category bits. Normally you would just set one bit.
217
<P>
218
<DL>
219
</DL>
220
</DL>
221
<HR>
222
 
223
<A NAME="maskBits"><!-- --></A><H3>
224
maskBits</H3>
225
<PRE>
226
public short <B>maskBits</B></PRE>
227
<DL>
228
<DD>The collision mask bits. This states the categories that this shape would accept for collision.
229
<P>
230
<DL>
231
</DL>
232
</DL>
233
<HR>
234
 
235
<A NAME="groupIndex"><!-- --></A><H3>
236
groupIndex</H3>
237
<PRE>
238
public short <B>groupIndex</B></PRE>
239
<DL>
240
<DD>Collision groups allow a certain group of objects to never collide (negative) or always collide (positive). Zero means no
241
 collision group. Non-zero group filtering always wins against the mask bits.
242
<P>
243
<DL>
244
</DL>
245
</DL>
246
 
247
<!-- ========= CONSTRUCTOR DETAIL ======== -->
248
 
249
<A NAME="constructor_detail"><!-- --></A>
250
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
251
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
252
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
253
<B>Constructor Detail</B></FONT></TH>
254
</TR>
255
</TABLE>
256
 
257
<A NAME="Filter()"><!-- --></A><H3>
258
Filter</H3>
259
<PRE>
260
public <B>Filter</B>()</PRE>
261
<DL>
262
</DL>
263
<!-- ========= END OF CLASS DATA ========= -->
264
<HR>
265
 
266
 
267
<!-- ======= START OF BOTTOM NAVBAR ====== -->
268
<A NAME="navbar_bottom"><!-- --></A>
269
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
270
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
271
<TR>
272
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
273
<A NAME="navbar_bottom_firstrow"><!-- --></A>
274
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
275
  <TR ALIGN="center" VALIGN="top">
276
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
277
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
278
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
279
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Filter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
280
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
281
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
282
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
283
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
284
  </TR>
285
</TABLE>
286
</TD>
287
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
288
libgdx API</EM>
289
</TD>
290
</TR>
291
 
292
<TR>
293
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
294
&nbsp;<A HREF="../../../../../com/badlogic/gdx/physics/box2d/EdgeShape.html" title="class in com.badlogic.gdx.physics.box2d"><B>PREV CLASS</B></A>&nbsp;
295
&nbsp;<A HREF="../../../../../com/badlogic/gdx/physics/box2d/Fixture.html" title="class in com.badlogic.gdx.physics.box2d"><B>NEXT CLASS</B></A></FONT></TD>
296
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
297
  <A HREF="../../../../../index.html?com/badlogic/gdx/physics/box2d/Filter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
298
&nbsp;<A HREF="Filter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
299
&nbsp;<SCRIPT type="text/javascript">
300
  <!--
301
  if(window==top) {
302
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
303
  }
304
  //-->
305
</SCRIPT>
306
<NOSCRIPT>
307
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
308
</NOSCRIPT>
309
 
310
 
311
</FONT></TD>
312
</TR>
313
<TR>
314
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
315
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
316
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
317
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
318
</TR>
319
</TABLE>
320
<A NAME="skip-navbar_bottom"></A>
321
<!-- ======== END OF BOTTOM NAVBAR ======= -->
322
 
323
<HR>
324
 
325
                                <div style="font-size:9pt"><i>
326
                                Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
327
                                </i></div>
328
 
329
</BODY>
330
</HTML>