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 PickOrbitBehavior class implements a mouse orbit behavior.
49 *
50 * @author Michael J. Schnieders
51 */
52 public class PickOrbitBehavior extends PickMouseBehavior implements MouseBehaviorCallback {
53
54 public MouseOrbit orbit;
55 private PickingCallback callback = null;
56 private TransformGroup currentTG;
57
58 /**
59 * Constructor for PickOrbitBehavior.
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 PickOrbitBehavior(
68 BranchGroup root, Canvas3D canvas, Bounds bounds, TransformGroup VPTG, int pickMode) {
69 super(canvas, root, bounds);
70 orbit = new MouseOrbit(MouseOrbit.MANUAL_WAKEUP, VPTG);
71 orbit.setTransformGroup(currGrp);
72 currGrp.addChild(orbit);
73 orbit.setSchedulingBounds(bounds);
74 setSchedulingBounds(bounds);
75 pickCanvas.setMode(pickMode);
76 }
77
78 /**
79 * Return the pickMode component of this PickTranslateBehavior.
80 *
81 * @return a int.
82 */
83 public int getPickMode() {
84 return pickCanvas.getMode();
85 }
86
87 /**
88 * Sets the pickMode component of this PickTranslateBehavior to the value of the passed
89 * pickMode. @param pickMode the pickMode to be copied.
90 *
91 * @param pickMode a int.
92 */
93 public void setPickMode(int pickMode) {
94 pickCanvas.setMode(pickMode);
95 }
96
97 /**
98 * setTransformGroups
99 *
100 * @param StarTG a {@link org.jogamp.java3d.TransformGroup} object.
101 * @param VPTG a {@link org.jogamp.java3d.TransformGroup} object.
102 */
103 public void setTransformGroups(TransformGroup StarTG, TransformGroup VPTG) {
104 orbit.setTransformGroups(StarTG, VPTG);
105 }
106
107 /**
108 * Register the class @param callback to be called each time the picked object moves.
109 *
110 * @param c a {@link ffx.ui.behaviors.PickingCallback} object.
111 */
112 public void setupCallback(PickingCallback c) {
113 callback = c;
114 if (callback == null) {
115 orbit.setupCallback(null);
116 } else {
117 orbit.setupCallback(this);
118 }
119 }
120
121 /**
122 * Callback method from MouseOrbit This is used when the Picking callback is enabled.
123 *
124 * <p>{@inheritDoc}
125 */
126 public void transformChanged(int type, Transform3D transform) {
127 callback.transformChanged(PickingCallback.ORBIT, currentTG);
128 }
129
130 /** {@inheritDoc} */
131 public void transformClicked(int type, Transform3D transform) {
132 callback.transformClicked(PickingCallback.ORBIT, currentTG);
133 }
134
135 /** {@inheritDoc} */
136 public void transformDoubleClicked(int type, Transform3D transform) {
137 callback.transformDoubleClicked(PickingCallback.ORBIT, currentTG);
138 }
139
140 /**
141 * Update the scene to manipulate any nodes. This is not meant to be called by users. Behavior
142 * automatically calls this. You can call this only if you know what you are doing.
143 *
144 * @param xpos Current mouse X pos.
145 * @param ypos Current mouse Y pos.
146 */
147 public void updateScene(int xpos, int ypos) {
148 if (mevent.isMetaDown() && !mevent.isAltDown()) {
149 pickCanvas.setShapeLocation(xpos, ypos);
150 PickResult r = pickCanvas.pickClosest();
151 if (r != null) {
152 TransformGroup tg = (TransformGroup) r.getNode(PickResult.TRANSFORM_GROUP);
153 if ((tg != null)
154 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_READ))
155 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_WRITE))) {
156 orbit.setTransformGroup(tg);
157 orbit.wakeup();
158 currentTG = tg;
159 if (callback != null) {
160 callback.transformClicked(PickingCallback.ORBIT, currentTG);
161 }
162 }
163 } else if (callback != null) {
164 callback.transformChanged(PickingCallback.NO_PICK, null);
165 }
166 }
167 }
168 }