|
0
|
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.5.0_16) on Mon May 18 10:30:51 CEST 2009 --> |
|
|
6 |
<TITLE> |
|
|
7 |
TuioClient |
|
|
8 |
</TITLE> |
|
|
9 |
|
|
|
10 |
<META NAME="keywords" CONTENT="TUIO.TuioClient class"> |
|
|
11 |
|
|
|
12 |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> |
|
|
13 |
|
|
|
14 |
<SCRIPT type="text/javascript"> |
|
|
15 |
function windowTitle() |
|
|
16 |
{ |
|
|
17 |
parent.document.title="TuioClient"; |
|
|
18 |
} |
|
|
19 |
</SCRIPT> |
|
|
20 |
<NOSCRIPT> |
|
|
21 |
</NOSCRIPT> |
|
|
22 |
|
|
|
23 |
</HEAD> |
|
|
24 |
|
|
|
25 |
<BODY BGCOLOR="white" onload="windowTitle();"> |
|
|
26 |
|
|
|
27 |
|
|
|
28 |
<!-- ========= START OF TOP NAVBAR ======= --> |
|
|
29 |
<A NAME="navbar_top"><!-- --></A> |
|
|
30 |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
|
|
31 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
|
|
32 |
<TR> |
|
|
33 |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
|
|
34 |
<A NAME="navbar_top_firstrow"><!-- --></A> |
|
|
35 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
|
|
36 |
<TR ALIGN="center" VALIGN="top"> |
|
|
37 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../TUIO/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
|
|
38 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
|
|
39 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
|
|
40 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
|
|
41 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
|
|
42 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
|
|
43 |
</TR> |
|
|
44 |
</TABLE> |
|
|
45 |
</TD> |
|
|
46 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
|
|
47 |
</EM> |
|
|
48 |
</TD> |
|
|
49 |
</TR> |
|
|
50 |
|
|
|
51 |
<TR> |
|
|
52 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
|
53 |
PREV CLASS |
|
|
54 |
<A HREF="../TUIO/TuioCursor.html" title="class in TUIO"><B>NEXT CLASS</B></A></FONT></TD> |
|
|
55 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
|
56 |
<A HREF="../index.html?TUIO/TuioClient.html" target="_top"><B>FRAMES</B></A> |
|
|
57 |
<A HREF="TuioClient.html" target="_top"><B>NO FRAMES</B></A> |
|
|
58 |
<SCRIPT type="text/javascript"> |
|
|
59 |
<!-- |
|
|
60 |
if(window==top) { |
|
|
61 |
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
|
|
62 |
} |
|
|
63 |
//--> |
|
|
64 |
</SCRIPT> |
|
|
65 |
<NOSCRIPT> |
|
|
66 |
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
|
|
67 |
</NOSCRIPT> |
|
|
68 |
|
|
|
69 |
|
|
|
70 |
</FONT></TD> |
|
|
71 |
</TR> |
|
|
72 |
<TR> |
|
|
73 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
|
74 |
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
|
|
75 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
|
76 |
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
|
|
77 |
</TR> |
|
|
78 |
</TABLE> |
|
|
79 |
<A NAME="skip-navbar_top"></A> |
|
|
80 |
<!-- ========= END OF TOP NAVBAR ========= --> |
|
|
81 |
|
|
|
82 |
<HR> |
|
|
83 |
<!-- ======== START OF CLASS DATA ======== --> |
|
|
84 |
<H2> |
|
|
85 |
<FONT SIZE="-1"> |
|
|
86 |
TUIO</FONT> |
|
|
87 |
<BR> |
|
|
88 |
Class TuioClient</H2> |
|
|
89 |
<PRE> |
|
|
90 |
java.lang.Object |
|
|
91 |
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>TUIO.TuioClient</B> |
|
|
92 |
</PRE> |
|
|
93 |
<DL> |
|
|
94 |
<DT><B>All Implemented Interfaces:</B> <DD>com.illposed.osc.OSCListener</DD> |
|
|
95 |
</DL> |
|
|
96 |
<HR> |
|
|
97 |
<DL> |
|
|
98 |
<DT><PRE>public class <B>TuioClient</B><DT>extends java.lang.Object<DT>implements com.illposed.osc.OSCListener</DL> |
|
|
99 |
</PRE> |
|
|
100 |
|
|
|
101 |
<P> |
|
|
102 |
The TuioClient class is the central TUIO protocol decoder component. It provides a simple callback infrastructure using the <A HREF="../TUIO/TuioListener.html" title="interface in TUIO"><CODE>TuioListener</CODE></A> interface. |
|
|
103 |
In order to receive and decode TUIO messages an instance of TuioClient needs to be created. The TuioClient instance then generates TUIO events |
|
|
104 |
which are broadcasted to all registered classes that implement the <A HREF="../TUIO/TuioListener.html" title="interface in TUIO"><CODE>TuioListener</CODE></A> interface.<P> |
|
|
105 |
<code> |
|
|
106 |
TuioClient client = new TuioClient();<br/> |
|
|
107 |
client.addTuioListener(myTuioListener);<br/> |
|
|
108 |
client.connect();<br/> |
|
|
109 |
</code> |
|
|
110 |
<P> |
|
|
111 |
|
|
|
112 |
<P> |
|
|
113 |
<HR> |
|
|
114 |
|
|
|
115 |
<P> |
|
|
116 |
|
|
|
117 |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> |
|
|
118 |
|
|
|
119 |
<A NAME="constructor_summary"><!-- --></A> |
|
|
120 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
|
121 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
|
122 |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
|
123 |
<B>Constructor Summary</B></FONT></TH> |
|
|
124 |
</TR> |
|
|
125 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
126 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#TuioClient()">TuioClient</A></B>()</CODE> |
|
|
127 |
|
|
|
128 |
<BR> |
|
|
129 |
The default constructor creates a client that listens to the default TUIO port 3333</TD> |
|
|
130 |
</TR> |
|
|
131 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
132 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#TuioClient(int)">TuioClient</A></B>(int port)</CODE> |
|
|
133 |
|
|
|
134 |
<BR> |
|
|
135 |
This constructor creates a client that listens to the provided port</TD> |
|
|
136 |
</TR> |
|
|
137 |
</TABLE> |
|
|
138 |
|
|
|
139 |
<!-- ========== METHOD SUMMARY =========== --> |
|
|
140 |
|
|
|
141 |
<A NAME="method_summary"><!-- --></A> |
|
|
142 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
|
143 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
|
144 |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
|
145 |
<B>Method Summary</B></FONT></TH> |
|
|
146 |
</TR> |
|
|
147 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
148 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
149 |
<CODE> void</CODE></FONT></TD> |
|
|
150 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#acceptMessage(java.util.Date, com.illposed.osc.OSCMessage)">acceptMessage</A></B>(java.util.Date date, |
|
|
151 |
com.illposed.osc.OSCMessage message)</CODE> |
|
|
152 |
|
|
|
153 |
<BR> |
|
|
154 |
The OSC callback method where all TUIO messages are received and decoded |
|
|
155 |
and where the TUIO event callbacks are dispatched</TD> |
|
|
156 |
</TR> |
|
|
157 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
158 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
159 |
<CODE> void</CODE></FONT></TD> |
|
|
160 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#addTuioListener(TUIO.TuioListener)">addTuioListener</A></B>(<A HREF="../TUIO/TuioListener.html" title="interface in TUIO">TuioListener</A> listener)</CODE> |
|
|
161 |
|
|
|
162 |
<BR> |
|
|
163 |
Adds the provided TuioListener to the list of registered TUIO event listeners</TD> |
|
|
164 |
</TR> |
|
|
165 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
166 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
167 |
<CODE> void</CODE></FONT></TD> |
|
|
168 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#connect()">connect</A></B>()</CODE> |
|
|
169 |
|
|
|
170 |
<BR> |
|
|
171 |
The TuioClient starts listening to TUIO messages on the configured UDP port |
|
|
172 |
All reveived TUIO messages are decoded and the resulting TUIO events are broadcasted to all registered TuioListeners</TD> |
|
|
173 |
</TR> |
|
|
174 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
175 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
176 |
<CODE> void</CODE></FONT></TD> |
|
|
177 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#disconnect()">disconnect</A></B>()</CODE> |
|
|
178 |
|
|
|
179 |
<BR> |
|
|
180 |
The TuioClient stops listening to TUIO messages on the configured UDP port</TD> |
|
|
181 |
</TR> |
|
|
182 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
183 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
184 |
<CODE> <A HREF="../TUIO/TuioCursor.html" title="class in TUIO">TuioCursor</A></CODE></FONT></TD> |
|
|
185 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#getTuioCursor(long)">getTuioCursor</A></B>(long s_id)</CODE> |
|
|
186 |
|
|
|
187 |
<BR> |
|
|
188 |
Returns the TuioCursor corresponding to the provided Session ID |
|
|
189 |
or NULL if the Session ID does not refer to an active TuioCursor</TD> |
|
|
190 |
</TR> |
|
|
191 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
192 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
193 |
<CODE> java.util.Vector<<A HREF="../TUIO/TuioCursor.html" title="class in TUIO">TuioCursor</A>></CODE></FONT></TD> |
|
|
194 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#getTuioCursors()">getTuioCursors</A></B>()</CODE> |
|
|
195 |
|
|
|
196 |
<BR> |
|
|
197 |
Returns a Vector of all currently active TuioCursors</TD> |
|
|
198 |
</TR> |
|
|
199 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
200 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
201 |
<CODE> <A HREF="../TUIO/TuioObject.html" title="class in TUIO">TuioObject</A></CODE></FONT></TD> |
|
|
202 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#getTuioObject(long)">getTuioObject</A></B>(long s_id)</CODE> |
|
|
203 |
|
|
|
204 |
<BR> |
|
|
205 |
Returns the TuioObject corresponding to the provided Session ID |
|
|
206 |
or NULL if the Session ID does not refer to an active TuioObject</TD> |
|
|
207 |
</TR> |
|
|
208 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
209 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
210 |
<CODE> java.util.Vector<<A HREF="../TUIO/TuioObject.html" title="class in TUIO">TuioObject</A>></CODE></FONT></TD> |
|
|
211 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#getTuioObjects()">getTuioObjects</A></B>()</CODE> |
|
|
212 |
|
|
|
213 |
<BR> |
|
|
214 |
Returns a Vector of all currently active TuioObjects</TD> |
|
|
215 |
</TR> |
|
|
216 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
217 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
218 |
<CODE> boolean</CODE></FONT></TD> |
|
|
219 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#isConnected()">isConnected</A></B>()</CODE> |
|
|
220 |
|
|
|
221 |
<BR> |
|
|
222 |
Returns true if this TuioClient is currently connected.</TD> |
|
|
223 |
</TR> |
|
|
224 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
225 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
226 |
<CODE> void</CODE></FONT></TD> |
|
|
227 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#removeAllTuioListeners()">removeAllTuioListeners</A></B>()</CODE> |
|
|
228 |
|
|
|
229 |
<BR> |
|
|
230 |
Removes all TuioListener from the list of registered TUIO event listeners</TD> |
|
|
231 |
</TR> |
|
|
232 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
233 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
|
234 |
<CODE> void</CODE></FONT></TD> |
|
|
235 |
<TD><CODE><B><A HREF="../TUIO/TuioClient.html#removeTuioListener(TUIO.TuioListener)">removeTuioListener</A></B>(<A HREF="../TUIO/TuioListener.html" title="interface in TUIO">TuioListener</A> listener)</CODE> |
|
|
236 |
|
|
|
237 |
<BR> |
|
|
238 |
Removes the provided TuioListener from the list of registered TUIO event listeners</TD> |
|
|
239 |
</TR> |
|
|
240 |
</TABLE> |
|
|
241 |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
|
|
242 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
|
243 |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
|
|
244 |
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
|
|
245 |
</TR> |
|
|
246 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
|
247 |
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
|
|
248 |
</TR> |
|
|
249 |
</TABLE> |
|
|
250 |
|
|
|
251 |
<P> |
|
|
252 |
|
|
|
253 |
<!-- ========= CONSTRUCTOR DETAIL ======== --> |
|
|
254 |
|
|
|
255 |
<A NAME="constructor_detail"><!-- --></A> |
|
|
256 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
|
257 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
|
258 |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
|
259 |
<B>Constructor Detail</B></FONT></TH> |
|
|
260 |
</TR> |
|
|
261 |
</TABLE> |
|
|
262 |
|
|
|
263 |
<A NAME="TuioClient()"><!-- --></A><H3> |
|
|
264 |
TuioClient</H3> |
|
|
265 |
<PRE> |
|
|
266 |
public <B>TuioClient</B>()</PRE> |
|
|
267 |
<DL> |
|
|
268 |
<DD>The default constructor creates a client that listens to the default TUIO port 3333 |
|
|
269 |
<P> |
|
|
270 |
</DL> |
|
|
271 |
<HR> |
|
|
272 |
|
|
|
273 |
<A NAME="TuioClient(int)"><!-- --></A><H3> |
|
|
274 |
TuioClient</H3> |
|
|
275 |
<PRE> |
|
|
276 |
public <B>TuioClient</B>(int port)</PRE> |
|
|
277 |
<DL> |
|
|
278 |
<DD>This constructor creates a client that listens to the provided port |
|
|
279 |
<P> |
|
|
280 |
<DL> |
|
|
281 |
<DT><B>Parameters:</B><DD><CODE>port</CODE> - the listening port number</DL> |
|
|
282 |
</DL> |
|
|
283 |
|
|
|
284 |
<!-- ============ METHOD DETAIL ========== --> |
|
|
285 |
|
|
|
286 |
<A NAME="method_detail"><!-- --></A> |
|
|
287 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
|
288 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
|
289 |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
|
290 |
<B>Method Detail</B></FONT></TH> |
|
|
291 |
</TR> |
|
|
292 |
</TABLE> |
|
|
293 |
|
|
|
294 |
<A NAME="connect()"><!-- --></A><H3> |
|
|
295 |
connect</H3> |
|
|
296 |
<PRE> |
|
|
297 |
public void <B>connect</B>()</PRE> |
|
|
298 |
<DL> |
|
|
299 |
<DD>The TuioClient starts listening to TUIO messages on the configured UDP port |
|
|
300 |
All reveived TUIO messages are decoded and the resulting TUIO events are broadcasted to all registered TuioListeners |
|
|
301 |
<P> |
|
|
302 |
<DD><DL> |
|
|
303 |
</DL> |
|
|
304 |
</DD> |
|
|
305 |
<DD><DL> |
|
|
306 |
</DL> |
|
|
307 |
</DD> |
|
|
308 |
</DL> |
|
|
309 |
<HR> |
|
|
310 |
|
|
|
311 |
<A NAME="disconnect()"><!-- --></A><H3> |
|
|
312 |
disconnect</H3> |
|
|
313 |
<PRE> |
|
|
314 |
public void <B>disconnect</B>()</PRE> |
|
|
315 |
<DL> |
|
|
316 |
<DD>The TuioClient stops listening to TUIO messages on the configured UDP port |
|
|
317 |
<P> |
|
|
318 |
<DD><DL> |
|
|
319 |
</DL> |
|
|
320 |
</DD> |
|
|
321 |
<DD><DL> |
|
|
322 |
</DL> |
|
|
323 |
</DD> |
|
|
324 |
</DL> |
|
|
325 |
<HR> |
|
|
326 |
|
|
|
327 |
<A NAME="isConnected()"><!-- --></A><H3> |
|
|
328 |
isConnected</H3> |
|
|
329 |
<PRE> |
|
|
330 |
public boolean <B>isConnected</B>()</PRE> |
|
|
331 |
<DL> |
|
|
332 |
<DD>Returns true if this TuioClient is currently connected. |
|
|
333 |
<P> |
|
|
334 |
<DD><DL> |
|
|
335 |
</DL> |
|
|
336 |
</DD> |
|
|
337 |
<DD><DL> |
|
|
338 |
|
|
|
339 |
<DT><B>Returns:</B><DD>true if this TuioClient is currently connected</DL> |
|
|
340 |
</DD> |
|
|
341 |
</DL> |
|
|
342 |
<HR> |
|
|
343 |
|
|
|
344 |
<A NAME="addTuioListener(TUIO.TuioListener)"><!-- --></A><H3> |
|
|
345 |
addTuioListener</H3> |
|
|
346 |
<PRE> |
|
|
347 |
public void <B>addTuioListener</B>(<A HREF="../TUIO/TuioListener.html" title="interface in TUIO">TuioListener</A> listener)</PRE> |
|
|
348 |
<DL> |
|
|
349 |
<DD>Adds the provided TuioListener to the list of registered TUIO event listeners |
|
|
350 |
<P> |
|
|
351 |
<DD><DL> |
|
|
352 |
</DL> |
|
|
353 |
</DD> |
|
|
354 |
<DD><DL> |
|
|
355 |
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the TuioListener to add</DL> |
|
|
356 |
</DD> |
|
|
357 |
</DL> |
|
|
358 |
<HR> |
|
|
359 |
|
|
|
360 |
<A NAME="removeTuioListener(TUIO.TuioListener)"><!-- --></A><H3> |
|
|
361 |
removeTuioListener</H3> |
|
|
362 |
<PRE> |
|
|
363 |
public void <B>removeTuioListener</B>(<A HREF="../TUIO/TuioListener.html" title="interface in TUIO">TuioListener</A> listener)</PRE> |
|
|
364 |
<DL> |
|
|
365 |
<DD>Removes the provided TuioListener from the list of registered TUIO event listeners |
|
|
366 |
<P> |
|
|
367 |
<DD><DL> |
|
|
368 |
</DL> |
|
|
369 |
</DD> |
|
|
370 |
<DD><DL> |
|
|
371 |
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the TuioListener to remove</DL> |
|
|
372 |
</DD> |
|
|
373 |
</DL> |
|
|
374 |
<HR> |
|
|
375 |
|
|
|
376 |
<A NAME="removeAllTuioListeners()"><!-- --></A><H3> |
|
|
377 |
removeAllTuioListeners</H3> |
|
|
378 |
<PRE> |
|
|
379 |
public void <B>removeAllTuioListeners</B>()</PRE> |
|
|
380 |
<DL> |
|
|
381 |
<DD>Removes all TuioListener from the list of registered TUIO event listeners |
|
|
382 |
<P> |
|
|
383 |
<DD><DL> |
|
|
384 |
</DL> |
|
|
385 |
</DD> |
|
|
386 |
<DD><DL> |
|
|
387 |
</DL> |
|
|
388 |
</DD> |
|
|
389 |
</DL> |
|
|
390 |
<HR> |
|
|
391 |
|
|
|
392 |
<A NAME="getTuioObjects()"><!-- --></A><H3> |
|
|
393 |
getTuioObjects</H3> |
|
|
394 |
<PRE> |
|
|
395 |
public java.util.Vector<<A HREF="../TUIO/TuioObject.html" title="class in TUIO">TuioObject</A>> <B>getTuioObjects</B>()</PRE> |
|
|
396 |
<DL> |
|
|
397 |
<DD>Returns a Vector of all currently active TuioObjects |
|
|
398 |
<P> |
|
|
399 |
<DD><DL> |
|
|
400 |
</DL> |
|
|
401 |
</DD> |
|
|
402 |
<DD><DL> |
|
|
403 |
|
|
|
404 |
<DT><B>Returns:</B><DD>a Vector of all currently active TuioObjects</DL> |
|
|
405 |
</DD> |
|
|
406 |
</DL> |
|
|
407 |
<HR> |
|
|
408 |
|
|
|
409 |
<A NAME="getTuioCursors()"><!-- --></A><H3> |
|
|
410 |
getTuioCursors</H3> |
|
|
411 |
<PRE> |
|
|
412 |
public java.util.Vector<<A HREF="../TUIO/TuioCursor.html" title="class in TUIO">TuioCursor</A>> <B>getTuioCursors</B>()</PRE> |
|
|
413 |
<DL> |
|
|
414 |
<DD>Returns a Vector of all currently active TuioCursors |
|
|
415 |
<P> |
|
|
416 |
<DD><DL> |
|
|
417 |
</DL> |
|
|
418 |
</DD> |
|
|
419 |
<DD><DL> |
|
|
420 |
|
|
|
421 |
<DT><B>Returns:</B><DD>a Vector of all currently active TuioCursors</DL> |
|
|
422 |
</DD> |
|
|
423 |
</DL> |
|
|
424 |
<HR> |
|
|
425 |
|
|
|
426 |
<A NAME="getTuioObject(long)"><!-- --></A><H3> |
|
|
427 |
getTuioObject</H3> |
|
|
428 |
<PRE> |
|
|
429 |
public <A HREF="../TUIO/TuioObject.html" title="class in TUIO">TuioObject</A> <B>getTuioObject</B>(long s_id)</PRE> |
|
|
430 |
<DL> |
|
|
431 |
<DD>Returns the TuioObject corresponding to the provided Session ID |
|
|
432 |
or NULL if the Session ID does not refer to an active TuioObject |
|
|
433 |
<P> |
|
|
434 |
<DD><DL> |
|
|
435 |
</DL> |
|
|
436 |
</DD> |
|
|
437 |
<DD><DL> |
|
|
438 |
|
|
|
439 |
<DT><B>Returns:</B><DD>an active TuioObject corresponding to the provided Session ID or NULL</DL> |
|
|
440 |
</DD> |
|
|
441 |
</DL> |
|
|
442 |
<HR> |
|
|
443 |
|
|
|
444 |
<A NAME="getTuioCursor(long)"><!-- --></A><H3> |
|
|
445 |
getTuioCursor</H3> |
|
|
446 |
<PRE> |
|
|
447 |
public <A HREF="../TUIO/TuioCursor.html" title="class in TUIO">TuioCursor</A> <B>getTuioCursor</B>(long s_id)</PRE> |
|
|
448 |
<DL> |
|
|
449 |
<DD>Returns the TuioCursor corresponding to the provided Session ID |
|
|
450 |
or NULL if the Session ID does not refer to an active TuioCursor |
|
|
451 |
<P> |
|
|
452 |
<DD><DL> |
|
|
453 |
</DL> |
|
|
454 |
</DD> |
|
|
455 |
<DD><DL> |
|
|
456 |
|
|
|
457 |
<DT><B>Returns:</B><DD>an active TuioCursor corresponding to the provided Session ID or NULL</DL> |
|
|
458 |
</DD> |
|
|
459 |
</DL> |
|
|
460 |
<HR> |
|
|
461 |
|
|
|
462 |
<A NAME="acceptMessage(java.util.Date, com.illposed.osc.OSCMessage)"><!-- --></A><H3> |
|
|
463 |
acceptMessage</H3> |
|
|
464 |
<PRE> |
|
|
465 |
public void <B>acceptMessage</B>(java.util.Date date, |
|
|
466 |
com.illposed.osc.OSCMessage message)</PRE> |
|
|
467 |
<DL> |
|
|
468 |
<DD>The OSC callback method where all TUIO messages are received and decoded |
|
|
469 |
and where the TUIO event callbacks are dispatched |
|
|
470 |
<P> |
|
|
471 |
<DD><DL> |
|
|
472 |
<DT><B>Specified by:</B><DD><CODE>acceptMessage</CODE> in interface <CODE>com.illposed.osc.OSCListener</CODE></DL> |
|
|
473 |
</DD> |
|
|
474 |
<DD><DL> |
|
|
475 |
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the time stamp of the OSC bundle<DD><CODE>message</CODE> - the received OSC message</DL> |
|
|
476 |
</DD> |
|
|
477 |
</DL> |
|
|
478 |
<!-- ========= END OF CLASS DATA ========= --> |
|
|
479 |
<HR> |
|
|
480 |
|
|
|
481 |
|
|
|
482 |
<!-- ======= START OF BOTTOM NAVBAR ====== --> |
|
|
483 |
<A NAME="navbar_bottom"><!-- --></A> |
|
|
484 |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
|
|
485 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
|
|
486 |
<TR> |
|
|
487 |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
|
|
488 |
<A NAME="navbar_bottom_firstrow"><!-- --></A> |
|
|
489 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
|
|
490 |
<TR ALIGN="center" VALIGN="top"> |
|
|
491 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../TUIO/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
|
|
492 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
|
|
493 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
|
|
494 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
|
|
495 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
|
|
496 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
|
|
497 |
</TR> |
|
|
498 |
</TABLE> |
|
|
499 |
</TD> |
|
|
500 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
|
|
501 |
</EM> |
|
|
502 |
</TD> |
|
|
503 |
</TR> |
|
|
504 |
|
|
|
505 |
<TR> |
|
|
506 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
|
507 |
PREV CLASS |
|
|
508 |
<A HREF="../TUIO/TuioCursor.html" title="class in TUIO"><B>NEXT CLASS</B></A></FONT></TD> |
|
|
509 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
|
510 |
<A HREF="../index.html?TUIO/TuioClient.html" target="_top"><B>FRAMES</B></A> |
|
|
511 |
<A HREF="TuioClient.html" target="_top"><B>NO FRAMES</B></A> |
|
|
512 |
<SCRIPT type="text/javascript"> |
|
|
513 |
<!-- |
|
|
514 |
if(window==top) { |
|
|
515 |
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
|
|
516 |
} |
|
|
517 |
//--> |
|
|
518 |
</SCRIPT> |
|
|
519 |
<NOSCRIPT> |
|
|
520 |
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
|
|
521 |
</NOSCRIPT> |
|
|
522 |
|
|
|
523 |
|
|
|
524 |
</FONT></TD> |
|
|
525 |
</TR> |
|
|
526 |
<TR> |
|
|
527 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
|
528 |
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
|
|
529 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
|
530 |
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
|
|
531 |
</TR> |
|
|
532 |
</TABLE> |
|
|
533 |
<A NAME="skip-navbar_bottom"></A> |
|
|
534 |
<!-- ======== END OF BOTTOM NAVBAR ======= --> |
|
|
535 |
|
|
|
536 |
<HR> |
|
|
537 |
|
|
|
538 |
</BODY> |
|
|
539 |
</HTML> |