|
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 TuioPoint |
|
8 </TITLE> |
|
9 |
|
10 <META NAME="keywords" CONTENT="TUIO.TuioPoint 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="TuioPoint"; |
|
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/TuioObject.html" title="class in TUIO"><B>PREV CLASS</B></A> |
|
54 <A HREF="../TUIO/TuioTime.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/TuioPoint.html" target="_top"><B>FRAMES</B></A> |
|
57 <A HREF="TuioPoint.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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 TuioPoint</H2> |
|
89 <PRE> |
|
90 java.lang.Object |
|
91 <IMG SRC="../resources/inherit.gif" ALT="extended by "><B>TUIO.TuioPoint</B> |
|
92 </PRE> |
|
93 <DL> |
|
94 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../TUIO/TuioCursor.html" title="class in TUIO">TuioCursor</A>, <A HREF="../TUIO/TuioObject.html" title="class in TUIO">TuioObject</A></DD> |
|
95 </DL> |
|
96 <HR> |
|
97 <DL> |
|
98 <DT><PRE>public class <B>TuioPoint</B><DT>extends java.lang.Object</DL> |
|
99 </PRE> |
|
100 |
|
101 <P> |
|
102 The TuioPoint class on the one hand is a simple container and utility class to handle TUIO positions in general, |
|
103 on the other hand the TuioPoint is the base class for the TuioCursor and TuioObject classes. |
|
104 <P> |
|
105 |
|
106 <P> |
|
107 <HR> |
|
108 |
|
109 <P> |
|
110 <!-- =========== FIELD SUMMARY =========== --> |
|
111 |
|
112 <A NAME="field_summary"><!-- --></A> |
|
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
116 <B>Field Summary</B></FONT></TH> |
|
117 </TR> |
|
118 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
119 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
120 <CODE>protected <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
121 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#currentTime">currentTime</A></B></CODE> |
|
122 |
|
123 <BR> |
|
124 The time stamp of the last update represented as TuioTime (time since session start)</TD> |
|
125 </TR> |
|
126 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
128 <CODE>protected <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
129 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#startTime">startTime</A></B></CODE> |
|
130 |
|
131 <BR> |
|
132 The creation time of this TuioPoint represented as TuioTime (time since session start)</TD> |
|
133 </TR> |
|
134 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
136 <CODE>protected float</CODE></FONT></TD> |
|
137 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#xpos">xpos</A></B></CODE> |
|
138 |
|
139 <BR> |
|
140 X coordinate, representated as a floating point value in a range of 0..1</TD> |
|
141 </TR> |
|
142 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
144 <CODE>protected float</CODE></FONT></TD> |
|
145 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#ypos">ypos</A></B></CODE> |
|
146 |
|
147 <BR> |
|
148 Y coordinate, representated as a floating point value in a range of 0..1</TD> |
|
149 </TR> |
|
150 </TABLE> |
|
151 |
|
152 <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
|
153 |
|
154 <A NAME="constructor_summary"><!-- --></A> |
|
155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
156 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
157 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
158 <B>Constructor Summary</B></FONT></TH> |
|
159 </TR> |
|
160 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
161 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#TuioPoint()">TuioPoint</A></B>()</CODE> |
|
162 |
|
163 <BR> |
|
164 The default constructor takes no arguments and sets |
|
165 its coordinate attributes to zero and its time stamp to the current session time.</TD> |
|
166 </TR> |
|
167 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
168 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#TuioPoint(float, float)">TuioPoint</A></B>(float xp, |
|
169 float yp)</CODE> |
|
170 |
|
171 <BR> |
|
172 This constructor takes two floating point coordinate arguments and sets |
|
173 its coordinate attributes to these values and its time stamp to the current session time.</TD> |
|
174 </TR> |
|
175 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
176 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#TuioPoint(TUIO.TuioPoint)">TuioPoint</A></B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</CODE> |
|
177 |
|
178 <BR> |
|
179 This constructor takes a TuioPoint argument and sets its coordinate attributes |
|
180 to the coordinates of the provided TuioPoint and its time stamp to the current session time.</TD> |
|
181 </TR> |
|
182 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
183 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#TuioPoint(TUIO.TuioTime, float, float)">TuioPoint</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime, |
|
184 float xp, |
|
185 float yp)</CODE> |
|
186 |
|
187 <BR> |
|
188 This constructor takes a TuioTime object and two floating point coordinate arguments and sets |
|
189 its coordinate attributes to these values and its time stamp to the provided TUIO time object.</TD> |
|
190 </TR> |
|
191 </TABLE> |
|
192 |
|
193 <!-- ========== METHOD SUMMARY =========== --> |
|
194 |
|
195 <A NAME="method_summary"><!-- --></A> |
|
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
198 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|
199 <B>Method Summary</B></FONT></TH> |
|
200 </TR> |
|
201 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
203 <CODE> float</CODE></FONT></TD> |
|
204 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getAngle(float, float)">getAngle</A></B>(float xp, |
|
205 float yp)</CODE> |
|
206 |
|
207 <BR> |
|
208 Returns the angle to the provided coordinates</TD> |
|
209 </TR> |
|
210 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
212 <CODE> float</CODE></FONT></TD> |
|
213 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getAngle(TUIO.TuioPoint)">getAngle</A></B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</CODE> |
|
214 |
|
215 <BR> |
|
216 Returns the angle to the provided TuioPoint</TD> |
|
217 </TR> |
|
218 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
220 <CODE> float</CODE></FONT></TD> |
|
221 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getAngleDegrees(float, float)">getAngleDegrees</A></B>(float xp, |
|
222 float yp)</CODE> |
|
223 |
|
224 <BR> |
|
225 Returns the angle in degrees to the provided coordinates</TD> |
|
226 </TR> |
|
227 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
229 <CODE> float</CODE></FONT></TD> |
|
230 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getAngleDegrees(TUIO.TuioPoint)">getAngleDegrees</A></B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</CODE> |
|
231 |
|
232 <BR> |
|
233 Returns the angle in degrees to the provided TuioPoint</TD> |
|
234 </TR> |
|
235 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
237 <CODE> float</CODE></FONT></TD> |
|
238 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getDistance(float, float)">getDistance</A></B>(float xp, |
|
239 float yp)</CODE> |
|
240 |
|
241 <BR> |
|
242 Returns the distance to the provided coordinates</TD> |
|
243 </TR> |
|
244 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
246 <CODE> float</CODE></FONT></TD> |
|
247 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getDistance(TUIO.TuioPoint)">getDistance</A></B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</CODE> |
|
248 |
|
249 <BR> |
|
250 Returns the distance to the provided TuioPoint</TD> |
|
251 </TR> |
|
252 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
254 <CODE> int</CODE></FONT></TD> |
|
255 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getScreenX(int)">getScreenX</A></B>(int width)</CODE> |
|
256 |
|
257 <BR> |
|
258 Returns the X coordinate in pixels relative to the provided screen width.</TD> |
|
259 </TR> |
|
260 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
262 <CODE> int</CODE></FONT></TD> |
|
263 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getScreenY(int)">getScreenY</A></B>(int height)</CODE> |
|
264 |
|
265 <BR> |
|
266 Returns the Y coordinate in pixels relative to the provided screen height.</TD> |
|
267 </TR> |
|
268 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
270 <CODE> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
271 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getStartTime()">getStartTime</A></B>()</CODE> |
|
272 |
|
273 <BR> |
|
274 Returns the start time of this TuioPoint as TuioTime.</TD> |
|
275 </TR> |
|
276 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
277 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
278 <CODE> <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A></CODE></FONT></TD> |
|
279 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getTuioTime()">getTuioTime</A></B>()</CODE> |
|
280 |
|
281 <BR> |
|
282 Returns the time stamp of this TuioPoint as TuioTime.</TD> |
|
283 </TR> |
|
284 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
285 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
286 <CODE> float</CODE></FONT></TD> |
|
287 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getX()">getX</A></B>()</CODE> |
|
288 |
|
289 <BR> |
|
290 Returns the X coordinate of this TuioPoint.</TD> |
|
291 </TR> |
|
292 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
293 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
294 <CODE> float</CODE></FONT></TD> |
|
295 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#getY()">getY</A></B>()</CODE> |
|
296 |
|
297 <BR> |
|
298 Returns the Y coordinate of this TuioPoint.</TD> |
|
299 </TR> |
|
300 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
302 <CODE> void</CODE></FONT></TD> |
|
303 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#update(float, float)">update</A></B>(float xp, |
|
304 float yp)</CODE> |
|
305 |
|
306 <BR> |
|
307 Takes two floating point coordinate arguments and updates its coordinate attributes |
|
308 to the coordinates of the provided TuioPoint and leaves its time stamp unchanged.</TD> |
|
309 </TR> |
|
310 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
311 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
312 <CODE> void</CODE></FONT></TD> |
|
313 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#update(TUIO.TuioPoint)">update</A></B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</CODE> |
|
314 |
|
315 <BR> |
|
316 Takes a TuioPoint argument and updates its coordinate attributes |
|
317 to the coordinates of the provided TuioPoint and leaves its time stamp unchanged.</TD> |
|
318 </TR> |
|
319 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
320 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|
321 <CODE> void</CODE></FONT></TD> |
|
322 <TD><CODE><B><A HREF="../TUIO/TuioPoint.html#update(TUIO.TuioTime, float, float)">update</A></B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime, |
|
323 float xp, |
|
324 float yp)</CODE> |
|
325 |
|
326 <BR> |
|
327 Takes a TuioTime object and two floating point coordinate arguments and updates its coordinate attributes |
|
328 to the coordinates of the provided TuioPoint and its time stamp to the provided TUIO time object.</TD> |
|
329 </TR> |
|
330 </TABLE> |
|
331 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
|
332 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
333 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
|
334 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
|
335 </TR> |
|
336 <TR BGCOLOR="white" CLASS="TableRowColor"> |
|
337 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
|
338 </TR> |
|
339 </TABLE> |
|
340 |
|
341 <P> |
|
342 |
|
343 <!-- ============ FIELD DETAIL =========== --> |
|
344 |
|
345 <A NAME="field_detail"><!-- --></A> |
|
346 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
347 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
348 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
349 <B>Field Detail</B></FONT></TH> |
|
350 </TR> |
|
351 </TABLE> |
|
352 |
|
353 <A NAME="xpos"><!-- --></A><H3> |
|
354 xpos</H3> |
|
355 <PRE> |
|
356 protected float <B>xpos</B></PRE> |
|
357 <DL> |
|
358 <DD>X coordinate, representated as a floating point value in a range of 0..1 |
|
359 <P> |
|
360 <DL> |
|
361 </DL> |
|
362 </DL> |
|
363 <HR> |
|
364 |
|
365 <A NAME="ypos"><!-- --></A><H3> |
|
366 ypos</H3> |
|
367 <PRE> |
|
368 protected float <B>ypos</B></PRE> |
|
369 <DL> |
|
370 <DD>Y coordinate, representated as a floating point value in a range of 0..1 |
|
371 <P> |
|
372 <DL> |
|
373 </DL> |
|
374 </DL> |
|
375 <HR> |
|
376 |
|
377 <A NAME="currentTime"><!-- --></A><H3> |
|
378 currentTime</H3> |
|
379 <PRE> |
|
380 protected <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>currentTime</B></PRE> |
|
381 <DL> |
|
382 <DD>The time stamp of the last update represented as TuioTime (time since session start) |
|
383 <P> |
|
384 <DL> |
|
385 </DL> |
|
386 </DL> |
|
387 <HR> |
|
388 |
|
389 <A NAME="startTime"><!-- --></A><H3> |
|
390 startTime</H3> |
|
391 <PRE> |
|
392 protected <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>startTime</B></PRE> |
|
393 <DL> |
|
394 <DD>The creation time of this TuioPoint represented as TuioTime (time since session start) |
|
395 <P> |
|
396 <DL> |
|
397 </DL> |
|
398 </DL> |
|
399 |
|
400 <!-- ========= CONSTRUCTOR DETAIL ======== --> |
|
401 |
|
402 <A NAME="constructor_detail"><!-- --></A> |
|
403 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
404 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
405 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
406 <B>Constructor Detail</B></FONT></TH> |
|
407 </TR> |
|
408 </TABLE> |
|
409 |
|
410 <A NAME="TuioPoint()"><!-- --></A><H3> |
|
411 TuioPoint</H3> |
|
412 <PRE> |
|
413 public <B>TuioPoint</B>()</PRE> |
|
414 <DL> |
|
415 <DD>The default constructor takes no arguments and sets |
|
416 its coordinate attributes to zero and its time stamp to the current session time. |
|
417 <P> |
|
418 </DL> |
|
419 <HR> |
|
420 |
|
421 <A NAME="TuioPoint(float, float)"><!-- --></A><H3> |
|
422 TuioPoint</H3> |
|
423 <PRE> |
|
424 public <B>TuioPoint</B>(float xp, |
|
425 float yp)</PRE> |
|
426 <DL> |
|
427 <DD>This constructor takes two floating point coordinate arguments and sets |
|
428 its coordinate attributes to these values and its time stamp to the current session time. |
|
429 <P> |
|
430 <DL> |
|
431 <DT><B>Parameters:</B><DD><CODE>xp</CODE> - the X coordinate to assign<DD><CODE>yp</CODE> - the Y coordinate to assign</DL> |
|
432 </DL> |
|
433 <HR> |
|
434 |
|
435 <A NAME="TuioPoint(TUIO.TuioPoint)"><!-- --></A><H3> |
|
436 TuioPoint</H3> |
|
437 <PRE> |
|
438 public <B>TuioPoint</B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</PRE> |
|
439 <DL> |
|
440 <DD>This constructor takes a TuioPoint argument and sets its coordinate attributes |
|
441 to the coordinates of the provided TuioPoint and its time stamp to the current session time. |
|
442 <P> |
|
443 <DL> |
|
444 <DT><B>Parameters:</B><DD><CODE>tpoint</CODE> - the TuioPoint to assign</DL> |
|
445 </DL> |
|
446 <HR> |
|
447 |
|
448 <A NAME="TuioPoint(TUIO.TuioTime, float, float)"><!-- --></A><H3> |
|
449 TuioPoint</H3> |
|
450 <PRE> |
|
451 public <B>TuioPoint</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime, |
|
452 float xp, |
|
453 float yp)</PRE> |
|
454 <DL> |
|
455 <DD>This constructor takes a TuioTime object and two floating point coordinate arguments and sets |
|
456 its coordinate attributes to these values and its time stamp to the provided TUIO time object. |
|
457 <P> |
|
458 <DL> |
|
459 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime to assign<DD><CODE>xp</CODE> - the X coordinate to assign<DD><CODE>yp</CODE> - the Y coordinate to assign</DL> |
|
460 </DL> |
|
461 |
|
462 <!-- ============ METHOD DETAIL ========== --> |
|
463 |
|
464 <A NAME="method_detail"><!-- --></A> |
|
465 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|
466 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|
467 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|
468 <B>Method Detail</B></FONT></TH> |
|
469 </TR> |
|
470 </TABLE> |
|
471 |
|
472 <A NAME="update(TUIO.TuioPoint)"><!-- --></A><H3> |
|
473 update</H3> |
|
474 <PRE> |
|
475 public void <B>update</B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</PRE> |
|
476 <DL> |
|
477 <DD>Takes a TuioPoint argument and updates its coordinate attributes |
|
478 to the coordinates of the provided TuioPoint and leaves its time stamp unchanged. |
|
479 <P> |
|
480 <DD><DL> |
|
481 <DT><B>Parameters:</B><DD><CODE>tpoint</CODE> - the TuioPoint to assign</DL> |
|
482 </DD> |
|
483 </DL> |
|
484 <HR> |
|
485 |
|
486 <A NAME="update(float, float)"><!-- --></A><H3> |
|
487 update</H3> |
|
488 <PRE> |
|
489 public void <B>update</B>(float xp, |
|
490 float yp)</PRE> |
|
491 <DL> |
|
492 <DD>Takes two floating point coordinate arguments and updates its coordinate attributes |
|
493 to the coordinates of the provided TuioPoint and leaves its time stamp unchanged. |
|
494 <P> |
|
495 <DD><DL> |
|
496 <DT><B>Parameters:</B><DD><CODE>xp</CODE> - the X coordinate to assign<DD><CODE>yp</CODE> - the Y coordinate to assign</DL> |
|
497 </DD> |
|
498 </DL> |
|
499 <HR> |
|
500 |
|
501 <A NAME="update(TUIO.TuioTime, float, float)"><!-- --></A><H3> |
|
502 update</H3> |
|
503 <PRE> |
|
504 public void <B>update</B>(<A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> ttime, |
|
505 float xp, |
|
506 float yp)</PRE> |
|
507 <DL> |
|
508 <DD>Takes a TuioTime object and two floating point coordinate arguments and updates its coordinate attributes |
|
509 to the coordinates of the provided TuioPoint and its time stamp to the provided TUIO time object. |
|
510 <P> |
|
511 <DD><DL> |
|
512 <DT><B>Parameters:</B><DD><CODE>ttime</CODE> - the TuioTime to assign<DD><CODE>xp</CODE> - the X coordinate to assign<DD><CODE>yp</CODE> - the Y coordinate to assign</DL> |
|
513 </DD> |
|
514 </DL> |
|
515 <HR> |
|
516 |
|
517 <A NAME="getX()"><!-- --></A><H3> |
|
518 getX</H3> |
|
519 <PRE> |
|
520 public float <B>getX</B>()</PRE> |
|
521 <DL> |
|
522 <DD>Returns the X coordinate of this TuioPoint. |
|
523 <P> |
|
524 <DD><DL> |
|
525 |
|
526 <DT><B>Returns:</B><DD>the X coordinate of this TuioPoint</DL> |
|
527 </DD> |
|
528 </DL> |
|
529 <HR> |
|
530 |
|
531 <A NAME="getY()"><!-- --></A><H3> |
|
532 getY</H3> |
|
533 <PRE> |
|
534 public float <B>getY</B>()</PRE> |
|
535 <DL> |
|
536 <DD>Returns the Y coordinate of this TuioPoint. |
|
537 <P> |
|
538 <DD><DL> |
|
539 |
|
540 <DT><B>Returns:</B><DD>the Y coordinate of this TuioPoint</DL> |
|
541 </DD> |
|
542 </DL> |
|
543 <HR> |
|
544 |
|
545 <A NAME="getDistance(float, float)"><!-- --></A><H3> |
|
546 getDistance</H3> |
|
547 <PRE> |
|
548 public float <B>getDistance</B>(float xp, |
|
549 float yp)</PRE> |
|
550 <DL> |
|
551 <DD>Returns the distance to the provided coordinates |
|
552 <P> |
|
553 <DD><DL> |
|
554 <DT><B>Parameters:</B><DD><CODE>xp</CODE> - the X coordinate of the distant point<DD><CODE>yp</CODE> - the Y coordinate of the distant point |
|
555 <DT><B>Returns:</B><DD>the distance to the provided coordinates</DL> |
|
556 </DD> |
|
557 </DL> |
|
558 <HR> |
|
559 |
|
560 <A NAME="getDistance(TUIO.TuioPoint)"><!-- --></A><H3> |
|
561 getDistance</H3> |
|
562 <PRE> |
|
563 public float <B>getDistance</B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</PRE> |
|
564 <DL> |
|
565 <DD>Returns the distance to the provided TuioPoint |
|
566 <P> |
|
567 <DD><DL> |
|
568 <DT><B>Parameters:</B><DD><CODE>tpoint</CODE> - the distant TuioPoint |
|
569 <DT><B>Returns:</B><DD>the distance to the provided TuioPoint</DL> |
|
570 </DD> |
|
571 </DL> |
|
572 <HR> |
|
573 |
|
574 <A NAME="getAngle(float, float)"><!-- --></A><H3> |
|
575 getAngle</H3> |
|
576 <PRE> |
|
577 public float <B>getAngle</B>(float xp, |
|
578 float yp)</PRE> |
|
579 <DL> |
|
580 <DD>Returns the angle to the provided coordinates |
|
581 <P> |
|
582 <DD><DL> |
|
583 <DT><B>Parameters:</B><DD><CODE>xp</CODE> - the X coordinate of the distant point<DD><CODE>yp</CODE> - the Y coordinate of the distant point |
|
584 <DT><B>Returns:</B><DD>the angle to the provided coordinates</DL> |
|
585 </DD> |
|
586 </DL> |
|
587 <HR> |
|
588 |
|
589 <A NAME="getAngle(TUIO.TuioPoint)"><!-- --></A><H3> |
|
590 getAngle</H3> |
|
591 <PRE> |
|
592 public float <B>getAngle</B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</PRE> |
|
593 <DL> |
|
594 <DD>Returns the angle to the provided TuioPoint |
|
595 <P> |
|
596 <DD><DL> |
|
597 <DT><B>Parameters:</B><DD><CODE>tpoint</CODE> - the distant TuioPoint |
|
598 <DT><B>Returns:</B><DD>the angle to the provided TuioPoint</DL> |
|
599 </DD> |
|
600 </DL> |
|
601 <HR> |
|
602 |
|
603 <A NAME="getAngleDegrees(float, float)"><!-- --></A><H3> |
|
604 getAngleDegrees</H3> |
|
605 <PRE> |
|
606 public float <B>getAngleDegrees</B>(float xp, |
|
607 float yp)</PRE> |
|
608 <DL> |
|
609 <DD>Returns the angle in degrees to the provided coordinates |
|
610 <P> |
|
611 <DD><DL> |
|
612 <DT><B>Parameters:</B><DD><CODE>xp</CODE> - the X coordinate of the distant point<DD><CODE>yp</CODE> - the Y coordinate of the distant point |
|
613 <DT><B>Returns:</B><DD>the angle in degrees to the provided TuioPoint</DL> |
|
614 </DD> |
|
615 </DL> |
|
616 <HR> |
|
617 |
|
618 <A NAME="getAngleDegrees(TUIO.TuioPoint)"><!-- --></A><H3> |
|
619 getAngleDegrees</H3> |
|
620 <PRE> |
|
621 public float <B>getAngleDegrees</B>(<A HREF="../TUIO/TuioPoint.html" title="class in TUIO">TuioPoint</A> tpoint)</PRE> |
|
622 <DL> |
|
623 <DD>Returns the angle in degrees to the provided TuioPoint |
|
624 <P> |
|
625 <DD><DL> |
|
626 <DT><B>Parameters:</B><DD><CODE>tpoint</CODE> - the distant TuioPoint |
|
627 <DT><B>Returns:</B><DD>the angle in degrees to the provided TuioPoint</DL> |
|
628 </DD> |
|
629 </DL> |
|
630 <HR> |
|
631 |
|
632 <A NAME="getScreenX(int)"><!-- --></A><H3> |
|
633 getScreenX</H3> |
|
634 <PRE> |
|
635 public int <B>getScreenX</B>(int width)</PRE> |
|
636 <DL> |
|
637 <DD>Returns the X coordinate in pixels relative to the provided screen width. |
|
638 <P> |
|
639 <DD><DL> |
|
640 <DT><B>Parameters:</B><DD><CODE>width</CODE> - the screen width |
|
641 <DT><B>Returns:</B><DD>the X coordinate of this TuioPoint in pixels relative to the provided screen width</DL> |
|
642 </DD> |
|
643 </DL> |
|
644 <HR> |
|
645 |
|
646 <A NAME="getScreenY(int)"><!-- --></A><H3> |
|
647 getScreenY</H3> |
|
648 <PRE> |
|
649 public int <B>getScreenY</B>(int height)</PRE> |
|
650 <DL> |
|
651 <DD>Returns the Y coordinate in pixels relative to the provided screen height. |
|
652 <P> |
|
653 <DD><DL> |
|
654 <DT><B>Parameters:</B><DD><CODE>height</CODE> - the screen height |
|
655 <DT><B>Returns:</B><DD>the Y coordinate of this TuioPoint in pixels relative to the provided screen height</DL> |
|
656 </DD> |
|
657 </DL> |
|
658 <HR> |
|
659 |
|
660 <A NAME="getTuioTime()"><!-- --></A><H3> |
|
661 getTuioTime</H3> |
|
662 <PRE> |
|
663 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>getTuioTime</B>()</PRE> |
|
664 <DL> |
|
665 <DD>Returns the time stamp of this TuioPoint as TuioTime. |
|
666 <P> |
|
667 <DD><DL> |
|
668 |
|
669 <DT><B>Returns:</B><DD>the time stamp of this TuioPoint as TuioTime</DL> |
|
670 </DD> |
|
671 </DL> |
|
672 <HR> |
|
673 |
|
674 <A NAME="getStartTime()"><!-- --></A><H3> |
|
675 getStartTime</H3> |
|
676 <PRE> |
|
677 public <A HREF="../TUIO/TuioTime.html" title="class in TUIO">TuioTime</A> <B>getStartTime</B>()</PRE> |
|
678 <DL> |
|
679 <DD>Returns the start time of this TuioPoint as TuioTime. |
|
680 <P> |
|
681 <DD><DL> |
|
682 |
|
683 <DT><B>Returns:</B><DD>the start time of this TuioPoint as TuioTime</DL> |
|
684 </DD> |
|
685 </DL> |
|
686 <!-- ========= END OF CLASS DATA ========= --> |
|
687 <HR> |
|
688 |
|
689 |
|
690 <!-- ======= START OF BOTTOM NAVBAR ====== --> |
|
691 <A NAME="navbar_bottom"><!-- --></A> |
|
692 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
|
693 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
|
694 <TR> |
|
695 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
|
696 <A NAME="navbar_bottom_firstrow"><!-- --></A> |
|
697 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
|
698 <TR ALIGN="center" VALIGN="top"> |
|
699 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../TUIO/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
|
700 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
|
701 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
|
702 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
|
703 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
|
704 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
|
705 </TR> |
|
706 </TABLE> |
|
707 </TD> |
|
708 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
|
709 </EM> |
|
710 </TD> |
|
711 </TR> |
|
712 |
|
713 <TR> |
|
714 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
715 <A HREF="../TUIO/TuioObject.html" title="class in TUIO"><B>PREV CLASS</B></A> |
|
716 <A HREF="../TUIO/TuioTime.html" title="class in TUIO"><B>NEXT CLASS</B></A></FONT></TD> |
|
717 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|
718 <A HREF="../index.html?TUIO/TuioPoint.html" target="_top"><B>FRAMES</B></A> |
|
719 <A HREF="TuioPoint.html" target="_top"><B>NO FRAMES</B></A> |
|
720 <SCRIPT type="text/javascript"> |
|
721 <!-- |
|
722 if(window==top) { |
|
723 document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>'); |
|
724 } |
|
725 //--> |
|
726 </SCRIPT> |
|
727 <NOSCRIPT> |
|
728 <A HREF="../allclasses-noframe.html"><B>All Classes</B></A> |
|
729 </NOSCRIPT> |
|
730 |
|
731 |
|
732 </FONT></TD> |
|
733 </TR> |
|
734 <TR> |
|
735 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
736 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
|
737 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|
738 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
|
739 </TR> |
|
740 </TABLE> |
|
741 <A NAME="skip-navbar_bottom"></A> |
|
742 <!-- ======== END OF BOTTOM NAVBAR ======= --> |
|
743 |
|
744 <HR> |
|
745 |
|
746 </BODY> |
|
747 </HTML> |