1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.ui.behaviors;
39
40 import org.jogamp.java3d.Transform3D;
41
42 /**
43 * The MouseBehaviorCallback interface is implemented by classes that want to receive callbacks when
44 * transforms are updated.
45 *
46 * <p>Classes implementing this interface that are registered with one of the MouseBehaviors will be
47 * called every time the behavior updates the Transform @param type will be one of ROTATE, TRANSLATE
48 * or ZOOM
49 *
50 * @author Michael J. Schnieders
51 */
52 public interface MouseBehaviorCallback {
53
54 /** Constant <code>ROTATE=0</code> */
55 int ROTATE = 0;
56 /** Constant <code>TRANSLATE=1</code> */
57 int TRANSLATE = 1;
58 /** Constant <code>ZOOM=2</code> */
59 int ZOOM = 2;
60 /** Constant <code>SELECTION=4</code> */
61 int SELECTION = 4;
62 /** Constant <code>PROPERTIES=5</code> */
63 int PROPERTIES = 5;
64 /** Constant <code>ORBIT=6</code> */
65 int ORBIT = 6;
66
67 /**
68 * transformChanged
69 *
70 * @param type a int.
71 * @param transform a {@link org.jogamp.java3d.Transform3D} object.
72 */
73 void transformChanged(int type, Transform3D transform);
74
75 /**
76 * transformClicked
77 *
78 * @param type a int.
79 * @param transform a {@link org.jogamp.java3d.Transform3D} object.
80 */
81 void transformClicked(int type, Transform3D transform);
82
83 /**
84 * transformDoubleClicked
85 *
86 * @param type a int.
87 * @param transform a {@link org.jogamp.java3d.Transform3D} object.
88 */
89 void transformDoubleClicked(int type, Transform3D transform);
90 }