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