1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2025.
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.TransformGroup;
41
42 /**
43 * The PickingCallback interface is implemented by classes wishing to recieve notification that a
44 * picked object has moved.
45 *
46 * @author Michael J. Schnieders
47 */
48 public interface PickingCallback {
49
50 /** Constant <code>ROTATE=0</code> */
51 int ROTATE = 0;
52 /** Constant <code>TRANSLATE=1</code> */
53 int TRANSLATE = 1;
54 /** Constant <code>ZOOM=2</code> */
55 int ZOOM = 2;
56 /** Constant <code>SELECTION=4</code> */
57 int SELECTION = 4;
58 /** Constant <code>PROPERTIES=5</code> */
59 int PROPERTIES = 5;
60 /** Constant <code>ORBIT=6</code> */
61 int ORBIT = 6;
62 /**
63 * The user made a selection but nothing was actually picked
64 *
65 * <p>Constant <code>NO_PICK=3</code>
66 */
67 int NO_PICK = 3;
68
69 /**
70 * Called by the Pick Behavior with which this callback is registered each time the Picked object
71 * is moved.
72 *
73 * <p>transformChanged
74 *
75 * @param type a int.
76 * @param tg a {@link org.jogamp.java3d.TransformGroup} object.
77 */
78 void transformChanged(int type, TransformGroup tg);
79
80 /**
81 * transformClicked
82 *
83 * @param type a int.
84 * @param tg a {@link org.jogamp.java3d.TransformGroup} object.
85 */
86 void transformClicked(int type, TransformGroup tg);
87
88 /**
89 * transformDoubleClicked
90 *
91 * @param type a int.
92 * @param tg a {@link org.jogamp.java3d.TransformGroup} object.
93 */
94 void transformDoubleClicked(int type, TransformGroup tg);
95 }