View Javadoc

1   package org.ximtec.igesture.io.tuio;
2   
3   import org.ximtec.igesture.io.tuio.interfaces.AbstractTuioCursor;
4   import org.ximtec.igesture.io.tuio.interfaces.AbstractTuioObject;
5   
6   /**
7    * The TuioListener interface provides a simple callback infrastructure which is used by the {@link TuioProcessor} class 
8    * to dispatch TUIO events to all registered instances of classes that implement the TuioListener interface defined here.<P> 
9    * Any class that implements the TuioListener interface is required to implement all of the callback methods defined here.
10   *
11   * @author Martin Kaltenbrunner, Bjorn Puype
12   * @version 1.4
13   */
14  public interface TuioListener{
15  	
16  	/**
17  	 * This callback method is invoked by the TuioClient when a new TuioObject is added to the session.   
18  	 *
19  	 * @param  tobj  the TuioObject reference associated to the addTuioObject event
20  	 */
21  	public void addTuioObject(AbstractTuioObject tobj);
22  
23  	/**
24  	 * This callback method is invoked by the TuioClient when an existing TuioObject is updated during the session.   
25  	 *
26  	 * @param  tobj  the TuioObject reference associated to the updateTuioObject event
27  	 */
28  	public void updateTuioObject(AbstractTuioObject tobj);
29  
30  	/**
31  	 * This callback method is invoked by the TuioClient when an existing TuioObject is removed from the session.   
32  	 *
33  	 * @param  tobj  the TuioObject reference associated to the removeTuioObject event
34  	 */
35  	public void removeTuioObject(AbstractTuioObject tobj);
36  	
37  	/**
38  	 * This callback method is invoked by the TuioClient when a new TuioCursor is added to the session.   
39  	 *
40  	 * @param  tcur  the TuioCursor reference associated to the addTuioCursor event
41  	 */
42  	public void addTuioCursor(AbstractTuioCursor tcur);
43  
44  	/**
45  	 * This callback method is invoked by the TuioClient when an existing TuioCursor is updated during the session.   
46  	 *
47  	 * @param  tcur  the TuioCursor reference associated to the updateTuioCursor event
48  	 */
49  	public void updateTuioCursor(AbstractTuioCursor tcur);
50  
51  	/**
52  	 * This callback method is invoked by the TuioClient when an existing TuioCursor is removed from the session.   
53  	 *
54  	 * @param  tcur  the TuioCursor reference associated to the removeTuioCursor event
55  	 */
56  	public void removeTuioCursor(AbstractTuioCursor tcur);
57  	
58  	/**
59  	 * This callback method is invoked by the TuioClient to mark the end of a received TUIO message bundle.   
60  	 *
61  	 * @param  ftime  the TuioTime associated to the current TUIO message bundle
62  	 */
63  	public void refresh(TuioTime ftime);
64  }