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 PickZoomBehavior class implements a scaling behavior on a picked scenegraph object.
50 *
51 * @author Michael J. Schnieders
52 */
53 public class PickZoomBehavior extends PickMouseBehavior implements MouseBehaviorCallback {
54
55 public MouseZoom zoom;
56 private PickingCallback callback = null;
57 private TransformGroup currentTG;
58
59 /**
60 * Constructor for PickZoomBehavior.
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 PickZoomBehavior(
69 BranchGroup root, Canvas3D canvas, Bounds bounds, TransformGroup VPTG, int pickMode) {
70 super(canvas, root, bounds);
71 zoom = new MouseZoom(MouseBehavior.MANUAL_WAKEUP, VPTG);
72 currGrp.addChild(zoom);
73 setSchedulingBounds(bounds);
74 pickCanvas.setMode(pickMode);
75 }
76
77 /**
78 * Return the pickMode component of this PickTranslateBehavior.
79 *
80 * @return a int.
81 */
82 public int getPickMode() {
83 return pickCanvas.getMode();
84 }
85
86 /**
87 * Sets the pickMode component of this PickTranslateBehavior to the value of the passed
88 * pickMode. @param pickMode the pickMode to be copied.
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 zoom.setupCallback(null);
105 } else {
106 zoom.setupCallback(this);
107 }
108 }
109
110 /** {@inheritDoc} */
111 public void transformChanged(int type, Transform3D transform) {
112 callback.transformChanged(PickingCallback.ZOOM, currentTG);
113 }
114
115 /** {@inheritDoc} */
116 public void transformClicked(int type, Transform3D transform) {
117 callback.transformClicked(PickingCallback.ZOOM, currentTG);
118 }
119
120 /** {@inheritDoc} */
121 public void transformDoubleClicked(int type, Transform3D transform) {
122 callback.transformDoubleClicked(PickingCallback.ZOOM, currentTG);
123 }
124
125 /**
126 * Update the scene to manipulate any nodes. This is not meant to be called * by users. Behavior
127 * automatically calls this. You can call this only if * you know what you are doing.
128 *
129 * @param xpos Current mouse X pos.
130 * @param ypos Current mouse Y pos.
131 */
132 public void updateScene(int xpos, int ypos) {
133 if ((mevent.getModifiersEx() & MouseEvent.BUTTON3) == MouseEvent.BUTTON3) {
134 pickCanvas.setShapeLocation(xpos, ypos);
135 PickResult r = pickCanvas.pickClosest();
136 if (r != null) {
137 TransformGroup tg = (TransformGroup) r.getNode(PickResult.TRANSFORM_GROUP);
138 if ((tg != null)
139 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_READ))
140 && (tg.getCapability(TransformGroup.ALLOW_TRANSFORM_WRITE))) {
141 zoom.setTransformGroup(tg);
142 zoom.wakeup();
143 currentTG = tg;
144 if (callback != null) {
145 callback.transformClicked(PickingCallback.ZOOM, currentTG);
146 }
147 } else if (callback != null) {
148 callback.transformChanged(PickingCallback.NO_PICK, null);
149 }
150 }
151 }
152 }
153 }