|
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 TuioTime |
|
8 </TITLE> |
|
9 |
|
10 <META NAME="keywords" CONTENT="TUIO.TuioTime 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="TuioTime"; |
|
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 <A HREF="../TUIO/TuioPoint.html" title="class in TUIO"><B>PREV CLASS</B></A> |
|
54 NEXT CLASS</FONT></TD> |
|
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
56 <A HREF="../index.html?TUIO/TuioTime.html" target="_top"><B>FRAMES</B></A> |
|
57 <A HREF="TuioTime.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 TuioTime</H2> |
|
89 <PRE> |
|
90 java.lang.Object |
|
91 <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>TUIO.TuioTime</B> |
|
92 </PRE> |
|
93 <HR> |
|
94 <DL> |
|
95 <DT><PRE>public class <B>TuioTime</B><DT>extends java.lang.Object</DL> |
|
96 </PRE> |
|
97 |
|
98 <P> |
|
99 The TuioTime class is a simple structure that is used to reprent the time that has elapsed since the session start. |
|
100 The time is internally represented as seconds and fractions of microseconds which should be more than sufficient for gesture related timing requirements. |
|
101 Therefore at the beginning of a typical TUIO session the static method initSession() will set the reference time for the session. |
|
102 Another important static method getSessionTime will return a TuioTime object representing the time elapsed since the session start. |
|
103 The class also provides various addtional convience method, which allow some simple time arithmetics. |
|
104 <P> |
|
105 |
|
106 <P> |
|
107 <HR> |
|
108 |
|
109 <P> |
|
110 |
|
111 <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
|
112 |
|
113 <A NAME="constructor_summary"><!-- --></A> |
|
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
117 <B>Constructor Summary</B></FONT></TH> |
|
118 </TR> |
|
119 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
120 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#TuioTime()">TuioTime</A></B>()</CODE> |
|
121 |
|
122 <BR> |
|
123 The default constructor takes no arguments and sets |
|
124 the Seconds and Microseconds attributes of the newly created TuioTime both to zero.</TD> |
|
125 </TR> |
|
126 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
127 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#TuioTime(long)">TuioTime</A></B>(long msec)</CODE> |
|
128 |
|
129 <BR> |
|
130 This constructor takes the provided time represented in total Milliseconds |
|
131 and assigs this value to the newly created TuioTime.</TD> |
|
132 </TR> |
|
133 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
134 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#TuioTime(long, long)">TuioTime</A></B>(long sec, |
|
135 long usec)</CODE> |
|
136 |
|
137 <BR> |
|
138 This constructor takes the provided time represented in Seconds and Microseconds |
|
139 and assigs these value to the newly created TuioTime.</TD> |
|
140 </TR> |
|
141 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
142 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#TuioTime(TUIO.TuioTime)">TuioTime</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</CODE> |
|
143 |
|
144 <BR> |
|
145 This constructor takes the provided TuioTime |
|
146 and assigs its Seconds and Microseconds values to the newly created TuioTime.</TD> |
|
147 </TR> |
|
148 </TABLE> |
|
149 |
|
150 <!-- ========== METHOD SUMMARY =========== --> |
|
151 |
|
152 <A NAME="method_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>Method 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> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
161 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#add(long)">add</A></B>(long us)</CODE> |
|
162 |
|
163 <BR> |
|
164 Sums the provided time value represented in total Microseconds to this TuioTime.</TD> |
|
165 </TR> |
|
166 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
168 <CODE> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
169 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#add(TUIO.TuioTime)">add</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</CODE> |
|
170 |
|
171 <BR> |
|
172 Sums the provided TuioTime to the private Seconds and Microseconds attributes.</TD> |
|
173 </TR> |
|
174 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
176 <CODE> boolean</CODE></FONT></TD> |
|
177 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#equals(TUIO.TuioTime)">equals</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</CODE> |
|
178 |
|
179 <BR> |
|
180 Takes a TuioTime argument and compares the provided TuioTime to the private Seconds and Microseconds attributes.</TD> |
|
181 </TR> |
|
182 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
184 <CODE> long</CODE></FONT></TD> |
|
185 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getMicroseconds()">getMicroseconds</A></B>()</CODE> |
|
186 |
|
187 <BR> |
|
188 Returns the TuioTime Microseconds component.</TD> |
|
189 </TR> |
|
190 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
192 <CODE> long</CODE></FONT></TD> |
|
193 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getSeconds()">getSeconds</A></B>()</CODE> |
|
194 |
|
195 <BR> |
|
196 Returns the TuioTime Seconds component.</TD> |
|
197 </TR> |
|
198 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
200 <CODE>static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
201 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getSessionTime()">getSessionTime</A></B>()</CODE> |
|
202 |
|
203 <BR> |
|
204 Returns the present TuioTime representing the time since session start.</TD> |
|
205 </TR> |
|
206 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
208 <CODE>static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
209 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getStartTime()">getStartTime</A></B>()</CODE> |
|
210 |
|
211 <BR> |
|
212 Returns the absolut TuioTime representing the session start.</TD> |
|
213 </TR> |
|
214 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
216 <CODE>static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
217 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getSystemTime()">getSystemTime</A></B>()</CODE> |
|
218 |
|
219 <BR> |
|
220 Returns the absolut TuioTime representing the current system time.</TD> |
|
221 </TR> |
|
222 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
224 <CODE> long</CODE></FONT></TD> |
|
225 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#getTotalMilliseconds()">getTotalMilliseconds</A></B>()</CODE> |
|
226 |
|
227 <BR> |
|
228 Returns the total TuioTime in Milliseconds.</TD> |
|
229 </TR> |
|
230 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
232 <CODE>static void</CODE></FONT></TD> |
|
233 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#initSession()">initSession</A></B>()</CODE> |
|
234 |
|
235 <BR> |
|
236 This static method globally resets the TUIO session time.</TD> |
|
237 </TR> |
|
238 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
240 <CODE> void</CODE></FONT></TD> |
|
241 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#reset()">reset</A></B>()</CODE> |
|
242 |
|
243 <BR> |
|
244 Resets the seconds and micro_seconds attributes to zero.</TD> |
|
245 </TR> |
|
246 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
248 <CODE> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
249 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#subtract(long)">subtract</A></B>(long us)</CODE> |
|
250 |
|
251 <BR> |
|
252 Subtracts the provided time represented in Microseconds from the private Seconds and Microseconds attributes.</TD> |
|
253 </TR> |
|
254 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
256 <CODE> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
257 <TD><CODE><B><A HREF="../TUIO/TuioTime.html#subtract(TUIO.TuioTime)">subtract</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</CODE> |
|
258 |
|
259 <BR> |
|
260 Subtracts the provided TuioTime from the private Seconds and Microseconds attributes.</TD> |
|
261 </TR> |
|
262 </TABLE> |
|
263 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
|
264 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
265 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
|
266 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
|
267 </TR> |
|
268 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
269 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
|
270 </TR> |
|
271 </TABLE> |
|
272 |
|
273 <P> |
|
274 |
|
275 <!-- ========= CONSTRUCTOR DETAIL ======== --> |
|
276 |
|
277 <A NAME="constructor_detail"><!-- --></A> |
|
278 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
279 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
280 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
281 <B>Constructor Detail</B></FONT></TH> |
|
282 </TR> |
|
283 </TABLE> |
|
284 |
|
285 <A NAME="TuioTime()"><!-- --></A><H3> |
|
286 TuioTime</H3> |
|
287 <PRE> |
|
288 public <B>TuioTime</B>()</PRE> |
|
289 <DL> |
|
290 <DD>The default constructor takes no arguments and sets |
|
291 the Seconds and Microseconds attributes of the newly created TuioTime both to zero. |
|
292 <P> |
|
293 </DL> |
|
294 <HR> |
|
295 |
|
296 <A NAME="TuioTime(long)"><!-- --></A><H3> |
|
297 TuioTime</H3> |
|
298 <PRE> |
|
299 public <B>TuioTime</B>(long msec)</PRE> |
|
300 <DL> |
|
301 <DD>This constructor takes the provided time represented in total Milliseconds |
|
302 and assigs this value to the newly created TuioTime. |
|
303 <P> |
|
304 <DL> |
|
305 <DT><B>Parameters:</B><DD><CODE>msec</CODE> - the total time in Millseconds</DL> |
|
306 </DL> |
|
307 <HR> |
|
308 |
|
309 <A NAME="TuioTime(long, long)"><!-- --></A><H3> |
|
310 TuioTime</H3> |
|
311 <PRE> |
|
312 public <B>TuioTime</B>(long sec, |
|
313 long usec)</PRE> |
|
314 <DL> |
|
315 <DD>This constructor takes the provided time represented in Seconds and Microseconds |
|
316 and assigs these value to the newly created TuioTime. |
|
317 <P> |
|
318 <DL> |
|
319 <DT><B>Parameters:</B><DD><CODE>sec</CODE> - the total time in seconds<DD><CODE>usec</CODE> - the microseconds time component</DL> |
|
320 </DL> |
|
321 <HR> |
|
322 |
|
323 <A NAME="TuioTime(TUIO.TuioTime)"><!-- --></A><H3> |
|
324 TuioTime</H3> |
|
325 <PRE> |
|
326 public <B>TuioTime</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</PRE> |
|
327 <DL> |
|
328 <DD>This constructor takes the provided TuioTime |
|
329 and assigs its Seconds and Microseconds values to the newly created TuioTime. |
|
330 <P> |
|
331 <DL> |
|
332 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime used to copy</DL> |
|
333 </DL> |
|
334 |
|
335 <!-- ============ METHOD DETAIL ========== --> |
|
336 |
|
337 <A NAME="method_detail"><!-- --></A> |
|
338 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
339 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
340 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
341 <B>Method Detail</B></FONT></TH> |
|
342 </TR> |
|
343 </TABLE> |
|
344 |
|
345 <A NAME="add(long)"><!-- --></A><H3> |
|
346 add</H3> |
|
347 <PRE> |
|
348 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>add</B>(long us)</PRE> |
|
349 <DL> |
|
350 <DD>Sums the provided time value represented in total Microseconds to this TuioTime. |
|
351 <P> |
|
352 <DD><DL> |
|
353 <DT><B>Parameters:</B><DD><CODE>us</CODE> - the total time to add in Microseconds |
|
354 <DT><B>Returns:</B><DD>the sum of this TuioTime with the provided argument in microseconds</DL> |
|
355 </DD> |
|
356 </DL> |
|
357 <HR> |
|
358 |
|
359 <A NAME="add(TUIO.TuioTime)"><!-- --></A><H3> |
|
360 add</H3> |
|
361 <PRE> |
|
362 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>add</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</PRE> |
|
363 <DL> |
|
364 <DD>Sums the provided TuioTime to the private Seconds and Microseconds attributes. |
|
365 <P> |
|
366 <DD><DL> |
|
367 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime to add |
|
368 <DT><B>Returns:</B><DD>the sum of this TuioTime with the provided TuioTime argument</DL> |
|
369 </DD> |
|
370 </DL> |
|
371 <HR> |
|
372 |
|
373 <A NAME="subtract(long)"><!-- --></A><H3> |
|
374 subtract</H3> |
|
375 <PRE> |
|
376 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>subtract</B>(long us)</PRE> |
|
377 <DL> |
|
378 <DD>Subtracts the provided time represented in Microseconds from the private Seconds and Microseconds attributes. |
|
379 <P> |
|
380 <DD><DL> |
|
381 <DT><B>Parameters:</B><DD><CODE>us</CODE> - the total time to subtract in Microseconds |
|
382 <DT><B>Returns:</B><DD>the subtraction result of this TuioTime minus the provided time in Microseconds</DL> |
|
383 </DD> |
|
384 </DL> |
|
385 <HR> |
|
386 |
|
387 <A NAME="subtract(TUIO.TuioTime)"><!-- --></A><H3> |
|
388 subtract</H3> |
|
389 <PRE> |
|
390 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>subtract</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</PRE> |
|
391 <DL> |
|
392 <DD>Subtracts the provided TuioTime from the private Seconds and Microseconds attributes. |
|
393 <P> |
|
394 <DD><DL> |
|
395 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime to subtract |
|
396 <DT><B>Returns:</B><DD>the subtraction result of this TuioTime minus the provided TuioTime</DL> |
|
397 </DD> |
|
398 </DL> |
|
399 <HR> |
|
400 |
|
401 <A NAME="equals(TUIO.TuioTime)"><!-- --></A><H3> |
|
402 equals</H3> |
|
403 <PRE> |
|
404 public boolean <B>equals</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime)</PRE> |
|
405 <DL> |
|
406 <DD>Takes a TuioTime argument and compares the provided TuioTime to the private Seconds and Microseconds attributes. |
|
407 <P> |
|
408 <DD><DL> |
|
409 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime to compare |
|
410 <DT><B>Returns:</B><DD>true if the two TuioTime have equal Seconds and Microseconds attributes</DL> |
|
411 </DD> |
|
412 </DL> |
|
413 <HR> |
|
414 |
|
415 <A NAME="reset()"><!-- --></A><H3> |
|
416 reset</H3> |
|
417 <PRE> |
|
418 public void <B>reset</B>()</PRE> |
|
419 <DL> |
|
420 <DD>Resets the seconds and micro_seconds attributes to zero. |
|
421 <P> |
|
422 <DD><DL> |
|
423 </DL> |
|
424 </DD> |
|
425 </DL> |
|
426 <HR> |
|
427 |
|
428 <A NAME="getSeconds()"><!-- --></A><H3> |
|
429 getSeconds</H3> |
|
430 <PRE> |
|
431 public long <B>getSeconds</B>()</PRE> |
|
432 <DL> |
|
433 <DD>Returns the TuioTime Seconds component. |
|
434 <P> |
|
435 <DD><DL> |
|
436 |
|
437 <DT><B>Returns:</B><DD>the TuioTime Seconds component</DL> |
|
438 </DD> |
|
439 </DL> |
|
440 <HR> |
|
441 |
|
442 <A NAME="getMicroseconds()"><!-- --></A><H3> |
|
443 getMicroseconds</H3> |
|
444 <PRE> |
|
445 public long <B>getMicroseconds</B>()</PRE> |
|
446 <DL> |
|
447 <DD>Returns the TuioTime Microseconds component. |
|
448 <P> |
|
449 <DD><DL> |
|
450 |
|
451 <DT><B>Returns:</B><DD>the TuioTime Microseconds component</DL> |
|
452 </DD> |
|
453 </DL> |
|
454 <HR> |
|
455 |
|
456 <A NAME="getTotalMilliseconds()"><!-- --></A><H3> |
|
457 getTotalMilliseconds</H3> |
|
458 <PRE> |
|
459 public long <B>getTotalMilliseconds</B>()</PRE> |
|
460 <DL> |
|
461 <DD>Returns the total TuioTime in Milliseconds. |
|
462 <P> |
|
463 <DD><DL> |
|
464 |
|
465 <DT><B>Returns:</B><DD>the total TuioTime in Milliseconds</DL> |
|
466 </DD> |
|
467 </DL> |
|
468 <HR> |
|
469 |
|
470 <A NAME="initSession()"><!-- --></A><H3> |
|
471 initSession</H3> |
|
472 <PRE> |
|
473 public static void <B>initSession</B>()</PRE> |
|
474 <DL> |
|
475 <DD>This static method globally resets the TUIO session time. |
|
476 <P> |
|
477 <DD><DL> |
|
478 </DL> |
|
479 </DD> |
|
480 </DL> |
|
481 <HR> |
|
482 |
|
483 <A NAME="getSessionTime()"><!-- --></A><H3> |
|
484 getSessionTime</H3> |
|
485 <PRE> |
|
486 public static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>getSessionTime</B>()</PRE> |
|
487 <DL> |
|
488 <DD>Returns the present TuioTime representing the time since session start. |
|
489 <P> |
|
490 <DD><DL> |
|
491 |
|
492 <DT><B>Returns:</B><DD>the present TuioTime representing the time since session start</DL> |
|
493 </DD> |
|
494 </DL> |
|
495 <HR> |
|
496 |
|
497 <A NAME="getStartTime()"><!-- --></A><H3> |
|
498 getStartTime</H3> |
|
499 <PRE> |
|
500 public static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>getStartTime</B>()</PRE> |
|
501 <DL> |
|
502 <DD>Returns the absolut TuioTime representing the session start. |
|
503 <P> |
|
504 <DD><DL> |
|
505 |
|
506 <DT><B>Returns:</B><DD>the absolut TuioTime representing the session start</DL> |
|
507 </DD> |
|
508 </DL> |
|
509 <HR> |
|
510 |
|
511 <A NAME="getSystemTime()"><!-- --></A><H3> |
|
512 getSystemTime</H3> |
|
513 <PRE> |
|
514 public static <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>getSystemTime</B>()</PRE> |
|
515 <DL> |
|
516 <DD>Returns the absolut TuioTime representing the current system time. |
|
517 <P> |
|
518 <DD><DL> |
|
519 |
|
520 <DT><B>Returns:</B><DD>the absolut TuioTime representing the current system time</DL> |
|
521 </DD> |
|
522 </DL> |
|
523 <!-- ========= END OF CLASS DATA ========= --> |
|
524 <HR> |
|
525 |
|
526 |
|
527 <!-- ======= START OF BOTTOM NAVBAR ====== --> |
|
528 <A NAME="navbar_bottom"><!-- --></A> |
|
529 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
|
530 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
|
531 <TR> |
|
532 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
|
533 <A NAME="navbar_bottom_firstrow"><!-- --></A> |
|
534 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
|
535 <TR ALIGN="center" VALIGN="top"> |
|
536 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../TUIO/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
|
537 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
|
538 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
|
539 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
|
540 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
|
541 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
|
542 </TR> |
|
543 </TABLE> |
|
544 </TD> |
|
545 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
|
546 </EM> |
|
547 </TD> |
|
548 </TR> |
|
549 |
|
550 <TR> |
|
551 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
552 <A HREF="../TUIO/TuioPoint.html" title="class in TUIO"><B>PREV CLASS</B></A> |
|
553 NEXT CLASS</FONT></TD> |
|
554 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
555 <A HREF="../index.html?TUIO/TuioTime.html" target="_top"><B>FRAMES</B></A> |
|
556 <A HREF="TuioTime.html" target="_top"><B>NO FRAMES</B></A> |
|
557 <SCRIPT type="text/javascript"> |
|
558 <!-- |
|
559 if(window==top) { |
|
560 document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
|
561 } |
|
562 //--> |
|
563 </SCRIPT> |
|
564 <NOSCRIPT> |
|
565 <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
|
566 </NOSCRIPT> |
|
567 |
|
568 |
|
569 </FONT></TD> |
|
570 </TR> |
|
571 <TR> |
|
572 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
573 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
|
574 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
575 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
|
576 </TR> |
|
577 </TABLE> |
|
578 <A NAME="skip-navbar_bottom"></A> |
|
579 <!-- ======== END OF BOTTOM NAVBAR ======= --> |
|
580 |
|
581 <HR> |
|
582 |
|
583 </BODY> |
|
584 </HTML> |