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.Bounds;
41 import org.jogamp.java3d.BranchGroup;
42 import org.jogamp.java3d.Canvas3D;
43 import org.jogamp.java3d.Transform3D;
44 import org.jogamp.java3d.TransformGroup;
45 import org.jogamp.java3d.utils.picking.PickResult;
46
47 /**
48 * The PickPropertiesBehavior class.
49 *
50 * @author Michael J. Schnieders
51 */
52 public class PickPropertiesBehavior extends PickMouseBehavior implements MouseBehaviorCallback {
53
54 MouseProperties drag;
55 private PickingCallback callback = null;
56 private TransformGroup currentTG;
57
58 /**
59 * Constructor for PickPropertiesBehavior.
60 *
61 * @param root a {@link org.jogamp.java3d.BranchGroup} object.
62 * @param canvas a {@link org.jogamp.java3d.Canvas3D} object.
63 * @param bounds a {@link org.jogamp.java3d.Bounds} object.
64 * @param VPTG a {@link org.jogamp.java3d.TransformGroup} object.
65 * @param pickMode a int.
66 */
67 public PickPropertiesBehavior(
68 BranchGroup root, Canvas3D canvas, Bounds bounds, TransformGroup VPTG, int pickMode) {
69 super(canvas, root, bounds);
70 drag = new MouseProperties(MouseProperties.MANUAL_WAKEUP, VPTG);
71 drag.setTransformGroup(currGrp);
72 currGrp.addChild(drag);
73 drag.setSchedulingBounds(bounds);
74 setSchedulingBounds(bounds);
75 pickCanvas.setMode(pickMode);
76 }
77
78 /**
79 * getPickMode
80 *
81 * @return a int.
82 */
83 public int getPickMode() {
84 return pickCanvas.getMode();
85 }
86
87 /**
88 * setPickMode
89 *
90 * @param pickMode a int.
91 */
92 public void setPickMode(int pickMode) {
93 pickCanvas.setMode(pickMode);
94 }
95
96 /**
97 * Register the class @param callback to be called each time the picked object moves.
98 *
99 * @param c a {@link ffx.ui.behaviors.PickingCallback} object.
100 */
101 public void setupCallback(PickingCallback c) {
102 callback = c;
103 if (callback == null) {
104 drag.setupCallback(null);
105 } else {
106 drag.setupCallback(this);
107 }
108 }
109
110 /** {@inheritDoc} */
111 public void transformChanged(int type, Transform3D transform) {
112 callback.transformChanged(PickingCallback.PROPERTIES, currentTG);
113 }
114
115 /** {@inheritDoc} */
116 public void transformClicked(int type, Transform3D transform) {
117 callback.transformClicked(PickingCallback.PROPERTIES, currentTG);
118 }
119
120 /** {@inheritDoc} */
121 public void transformDoubleClicked(int type, Transform3D transform) {
122 callback.transformDoubleClicked(PickingCallback.PROPERTIES, currentTG);
123 }
124
125 /**
126 * Update the scene to manipulate any nodes.
127 *
128 * @param xpos Current mouse X pos.
129 * @param ypos Current mouse Y pos.
130 */
131 public void updateScene(int xpos, int ypos) {
132 if (!mevent.isMetaDown() && !mevent.isAltDown()) {
133 pickCanvas.setShapeLocation(xpos, ypos);
134 PickResult r = pickCanvas.pickClosest();
135 if (r != null) {
136 TransformGroup tg = (TransformGroup) r.getNode(PickResult.TRANSFORM_GROUP);
137 if ((tg != null)
138 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_READ))
139 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_WRITE))) {
140 drag.wakeup();
141 currentTG = tg;
142 if (callback != null && mevent.getClickCount() == 2) {
143 callback.transformDoubleClicked(PickingCallback.PROPERTIES, currentTG);
144 }
145 }
146 } else if (callback != null) {
147 callback.transformDoubleClicked(PickingCallback.NO_PICK, null);
148 }
149 }
150 }
151 }