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 PickTranslateBehavior class implements a translation behavior on a picked scenegraph object.
50 *
51 * @author Michael J. Schnieders
52 */
53 public class PickTranslateBehavior extends PickMouseBehavior implements MouseBehaviorCallback {
54
55 public MouseTranslate translate;
56 private PickingCallback callback = null;
57 private TransformGroup currentTG;
58
59 /**
60 * Constructor for PickTranslateBehavior.
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 PickTranslateBehavior(
69 BranchGroup root, Canvas3D canvas, Bounds bounds, TransformGroup VPTG, int pickMode) {
70 super(canvas, root, bounds);
71 translate = new MouseTranslate(MouseBehavior.MANUAL_WAKEUP, VPTG);
72 translate.setTransformGroup(currGrp);
73 translate.setFactor(0.1);
74 currGrp.addChild(translate);
75 translate.setSchedulingBounds(bounds);
76 setSchedulingBounds(bounds);
77 pickCanvas.setMode(pickMode);
78 }
79
80 /**
81 * Return the pickMode component of this PickTranslateBehavior.
82 *
83 * @return a int.
84 */
85 public int getPickMode() {
86 return pickCanvas.getMode();
87 }
88
89 /**
90 * Sets the pickMode component of this PickTranslateBehavior to the value of the passed
91 * pickMode. @param pickMode the pickMode to be copied.
92 *
93 * @param pickMode a int.
94 */
95 public void setPickMode(int pickMode) {
96 pickCanvas.setMode(pickMode);
97 }
98
99 /**
100 * Register the class @param callback to be called each time the picked object moves
101 *
102 * @param callback a {@link ffx.ui.behaviors.PickingCallback} object.
103 */
104 public void setupCallback(PickingCallback callback) {
105 this.callback = callback;
106 if (callback == null) {
107 translate.setupCallback(null);
108 } else {
109 translate.setupCallback(this);
110 }
111 }
112
113 /** {@inheritDoc} */
114 public void transformChanged(int type, Transform3D transform) {
115 callback.transformChanged(PickingCallback.TRANSLATE, currentTG);
116 }
117
118 /** {@inheritDoc} */
119 public void transformClicked(int type, Transform3D transform) {
120 callback.transformClicked(PickingCallback.TRANSLATE, currentTG);
121 }
122
123 /** {@inheritDoc} */
124 public void transformDoubleClicked(int type, Transform3D transform) {
125 callback.transformDoubleClicked(PickingCallback.TRANSLATE, currentTG);
126 }
127
128 /**
129 * Update the scene to manipulate any nodes. This is not meant to be called by users. Behavior
130 * automatically calls this. You can call this only if you know what you are doing.
131 *
132 * @param xpos Current mouse X pos.
133 * @param ypos Current mouse Y pos.
134 */
135 public void updateScene(int xpos, int ypos) {
136 if ((mevent.getModifiersEx() & MouseEvent.BUTTON3_DOWN_MASK) == MouseEvent.BUTTON3_DOWN_MASK) {
137 pickCanvas.setShapeLocation(xpos, ypos);
138 PickResult r = pickCanvas.pickClosest();
139 if (r != null) {
140 if (callback != null) {
141 callback.transformChanged(PickingCallback.NO_PICK, null);
142 }
143 }
144 }
145 }
146 }