TUIO.TuioListener Maven / Gradle / Ivy
Show all versions of ProcessingTUIO Show documentation
/*
TUIO Java library
Copyright (c) 2005-2014 Martin Kaltenbrunner
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3.0 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library.
*/
package TUIO;
/**
* The TuioListener interface provides a simple callback infrastructure which is used by the {@link TuioClient} class
* to dispatch TUIO events to all registered instances of classes that implement the TuioListener interface defined here.
* Any class that implements the TuioListener interface is required to implement all of the callback methods defined here.
* The {@link TuioClient} makes use of these interface methods in order to dispatch TUIO events to all registered TuioListener implementations.
*
* public class MyTuioListener implements TuioListener
* ...
* MyTuioListener listener = new MyTuioListener();
* TuioClient client = new TuioClient();
* client.addTuioListener(listener);
* client.start();
*
*
* @author Martin Kaltenbrunner
* @version 1.1.0
*/
public interface TuioListener {
/**
* This callback method is invoked by the TuioClient when a new TuioObject is added to the session.
*
* @param tobj the TuioObject reference associated to the addTuioObject event
*/
public void addTuioObject(TuioObject tobj);
/**
* This callback method is invoked by the TuioClient when an existing TuioObject is updated during the session.
*
* @param tobj the TuioObject reference associated to the updateTuioObject event
*/
public void updateTuioObject(TuioObject tobj);
/**
* This callback method is invoked by the TuioClient when an existing TuioObject is removed from the session.
*
* @param tobj the TuioObject reference associated to the removeTuioObject event
*/
public void removeTuioObject(TuioObject tobj);
/**
* This callback method is invoked by the TuioClient when a new TuioCursor is added to the session.
*
* @param tcur the TuioCursor reference associated to the addTuioCursor event
*/
public void addTuioCursor(TuioCursor tcur);
/**
* This callback method is invoked by the TuioClient when an existing TuioCursor is updated during the session.
*
* @param tcur the TuioCursor reference associated to the updateTuioCursor event
*/
public void updateTuioCursor(TuioCursor tcur);
/**
* This callback method is invoked by the TuioClient when an existing TuioCursor is removed from the session.
*
* @param tcur the TuioCursor reference associated to the removeTuioCursor event
*/
public void removeTuioCursor(TuioCursor tcur);
/**
* This callback method is invoked by the TuioClient when a new TuioBlob is added to the session.
*
* @param tblb the TuioBlob reference associated to the addTuioBlob event
*/
public void addTuioBlob(TuioBlob tblb);
/**
* This callback method is invoked by the TuioClient when an existing TuioBlob is updated during the session.
*
* @param tblb the TuioBlob reference associated to the updateTuioBlob event
*/
public void updateTuioBlob(TuioBlob tblb);
/**
* This callback method is invoked by the TuioClient when an existing TuioBlob is removed from the session.
*
* @param tblb the TuioBlob reference associated to the removeTuioBlob event
*/
public void removeTuioBlob(TuioBlob tblb);
/**
* This callback method is invoked by the TuioClient to mark the end of a received TUIO message bundle.
*
* @param ftime the TuioTime associated to the current TUIO message bundle
*/
public void refresh(TuioTime ftime);
}