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 47 /** 48 * The PickRotateBehavior class implements a mouse rotate behavior on a picked object. 49 * 50 * @author Michael J. Schnieders 51 */ 52 public class PickRotateBehavior extends PickMouseBehavior implements MouseBehaviorCallback { 53 54 public MouseRotate drag; 55 private PickingCallback callback = null; 56 private TransformGroup currentTG; 57 58 /** 59 * Constructor for PickRotateBehavior. 60 * 61 * @param bg 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 PickRotateBehavior( 68 BranchGroup bg, Canvas3D canvas, Bounds bounds, TransformGroup VPTG, int pickMode) { 69 super(canvas, bg, bounds); 70 drag = new MouseRotate(MouseRotate.MANUAL_WAKEUP, VPTG); 71 drag.setTransformGroup(currGrp); 72 currGrp.addChild(drag); 73 drag.setFactor(0.025); 74 setSchedulingBounds(bounds); 75 drag.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 /** 113 * Callback method from MouseRotate This is used when the Picking callback is enabled. 114 * {@inheritDoc} 115 */ 116 public void transformChanged(int type, Transform3D transform) { 117 callback.transformChanged(PickingCallback.ROTATE, currentTG); 118 } 119 120 /** {@inheritDoc} */ 121 public void transformClicked(int type, Transform3D transform) { 122 callback.transformClicked(PickingCallback.ROTATE, currentTG); 123 } 124 125 /** {@inheritDoc} */ 126 public void transformDoubleClicked(int type, Transform3D transform) { 127 callback.transformDoubleClicked(PickingCallback.ROTATE, currentTG); 128 } 129 130 /** 131 * Update the scene to manipulate any nodes. This is not meant to be called by users. Behavior 132 * automatically calls this. You can call this only if you know what you are doing. 133 * 134 * @param xpos Current mouse X pos. 135 * @param ypos Current mouse Y pos. 136 */ 137 public void updateScene(int xpos, int ypos) { 138 if ((mevent.getModifiersEx() & MouseEvent.BUTTON1_DOWN_MASK) == MouseEvent.BUTTON1_DOWN_MASK) { 139 pickCanvas.setShapeLocation(xpos, ypos); 140 // PickResult r = pickCanvas.pickClosest(); 141 if (callback != null) { 142 callback.transformChanged(PickingCallback.NO_PICK, null); 143 } 144 } 145 } 146 }