01: /*
02: * $RCSfile: SensorButtonListener.java,v $
03: *
04: * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions
08: * are met:
09: *
10: * - Redistribution of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: *
13: * - Redistribution in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in
15: * the documentation and/or other materials provided with the
16: * distribution.
17: *
18: * Neither the name of Sun Microsystems, Inc. or the names of
19: * contributors may be used to endorse or promote products derived
20: * from this software without specific prior written permission.
21: *
22: * This software is provided "AS IS," without a warranty of any
23: * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
24: * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
25: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
26: * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
27: * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
28: * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
29: * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
30: * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
31: * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
32: * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
33: * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
34: * POSSIBILITY OF SUCH DAMAGES.
35: *
36: * You acknowledge that this software is not designed, licensed or
37: * intended for use in the design, construction, operation or
38: * maintenance of any nuclear facility.
39: *
40: * $Revision: 1.4 $
41: * $Date: 2007/02/09 17:20:14 $
42: * $State: Exp $
43: */
44:
45: package com.sun.j3d.utils.behaviors.sensor;
46:
47: /**
48: * This defines the interface for handling a sensor's button events in
49: * conjunction with a <code>SensorEventAgent</code> instance.
50: * <p>
51: * The events passed to this listener's methods are <i>ephemeral</i>; they
52: * are only valid until the listener has returned. If a listener needs to
53: * retain the event it must be copied using the
54: * <code>SensorEvent(SensorEvent)</code> constructor.
55: *
56: * @see SensorEvent
57: * @see SensorEventAgent
58: * @see SensorReadListener
59: * @since Java 3D 1.3
60: */
61: public interface SensorButtonListener {
62: /**
63: * This method is called when a sensor's button is pressed.
64: *
65: * @param e the sensor event
66: */
67: public void pressed(SensorEvent e);
68:
69: /**
70: * This method is called when a sensor's button is released.
71: *
72: * @param e the sensor event
73: */
74: public void released(SensorEvent e);
75:
76: /**
77: * This method is called with each invocation of the
78: * <code>dispatchEvents</code> method of <code>SensorEventAgent</code>
79: * if any button bound to the listener is down and has not changed
80: * state since the last invocation. The sensor value has not
81: * necessarily changed from the last drag event.
82: *
83: * @param e the sensor event
84: */
85: public void dragged(SensorEvent e);
86:
87: /**
88: * This method is currently not used by <code>SensorEventAgent</code>,
89: * but is included here for future possible development. Its
90: * implementations should remain empty for the present.
91: */
92: public void clicked(SensorEvent e);
93: }
|