// ******************************************************************************
   //
   // Title:       Force Field X.
   // Description: Force Field X - Software for Molecular Biophysics.
   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
   //
   // This file is part of Force Field X.
   //
   // Force Field X is free software; you can redistribute it and/or modify it
  // under the terms of the GNU General Public License version 3 as published by
  // the Free Software Foundation.
  //
  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  // details.
  //
  // You should have received a copy of the GNU General Public License along with
  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA 02111-1307 USA
  //
  // Linking this library statically or dynamically with other modules is making a
  // combined work based on this library. Thus, the terms and conditions of the
  // GNU General Public License cover the whole combination.
  //
  // As a special exception, the copyright holders of this library give you
  // permission to link this library with independent modules to produce an
  // executable, regardless of the license terms of these independent modules, and
  // to copy and distribute the resulting executable under terms of your choice,
  // provided that you also meet, for each linked independent module, the terms
  // and conditions of the license of that module. An independent module is a
  // module which is not derived from or based on this library. If you modify this
  // library, you may extend this exception to your version of the library, but
  // you are not obligated to do so. If you do not wish to do so, delete this
  // exception statement from your version.
  //
  // ******************************************************************************
  package ffx.ui.behaviors;
  
  import static org.apache.commons.math3.util.FastMath.abs;
  
  import java.awt.AWTEvent;
  import java.awt.event.MouseEvent;
  import java.util.Iterator;
  import org.jogamp.java3d.Behavior;
  import org.jogamp.java3d.Transform3D;
  import org.jogamp.java3d.TransformGroup;
  import org.jogamp.java3d.WakeupCriterion;
  import org.jogamp.java3d.WakeupOnAWTEvent;
  import org.jogamp.vecmath.Vector3d;
  
  /**
   * The MouseTranslate class implements a mouse translate behavior.
   *
   * @author Michael J. Schnieders
   */
  public class MouseTranslate extends MouseBehavior {
  
    private static Vector3d zero3d = new Vector3d(0.0, 0.0, 0.0);
    private double xFactor = 0.05; // .01;
    private double yFactor = 0.05; // .01;
    private Vector3d translation = new Vector3d();
    private MouseBehaviorCallback callback = null;
    private int mouseButton = MouseEvent.BUTTON3_DOWN_MASK;
    private int doneID = 0;
  
    /**
     * Constructor for MouseTranslate.
     *
     * @param flags a int.
     * @param VPTG a {@link org.jogamp.java3d.TransformGroup} object.
     */
    public MouseTranslate(int flags, TransformGroup VPTG) {
      super(flags, VPTG);
    }
  
    /**
     * Constructor for MouseTranslate.
     *
     * @param flags a int.
     * @param VPTG a {@link org.jogamp.java3d.TransformGroup} object.
     * @param behavior a {@link org.jogamp.java3d.Behavior} object.
     * @param postID a int.
     * @param dID a int.
     */
    public MouseTranslate(int flags, TransformGroup VPTG, Behavior behavior, int postID, int dID) {
      super(flags, VPTG, behavior, postID);
      doneID = dID;
    }
  
    /**
     * Return the x-axis movement multipler.
     *
     * <p>getXFactor
     *
     * @return a double.
     */
    public double getXFactor() {
      return xFactor;
   }
 
   /**
    * Return the y-axis movement multipler.
    *
    * <p>getYFactor
    *
    * @return a double.
    */
   public double getYFactor() {
     return yFactor;
   }
 
   /** initialize */
   public void initialize() {
     super.initialize();
     if ((flags & INVERT_INPUT) == INVERT_INPUT) {
       invert = true;
       xFactor *= -1;
       yFactor *= -1;
     }
   }
 
   /** {@inheritDoc} */
   public void processStimulus(Iterator<WakeupCriterion> criteria) {
     while (criteria.hasNext()) {
       WakeupCriterion wakeup = criteria.next();
       if (wakeup instanceof WakeupOnAWTEvent) {
         AWTEvent[] event = ((WakeupOnAWTEvent) wakeup).getAWTEvent();
         for (AWTEvent awtEvent : event) {
           MouseEvent mevent = (MouseEvent) awtEvent;
           processMouseEvent(mevent);
           int id = awtEvent.getID();
           int mod = mevent.getModifiersEx();
           boolean rightButton = ((mod & mouseButton) == mouseButton);
           if (!rightButton) {
             rightButton = ((mod & MouseEvent.SHIFT_DOWN_MASK) == MouseEvent.SHIFT_DOWN_MASK);
           }
           if ((id == MouseEvent.MOUSE_DRAGGED) && rightButton && transformGroup != null) {
             x = ((MouseEvent) awtEvent).getX();
             y = ((MouseEvent) awtEvent).getY();
             int dx = x - xLast;
             int dy = y - yLast;
             if ((!reset) && ((abs(dy) < 50) && (abs(dx) < 50))) {
               transformGroup.getTransform(currXform);
               Transform3D VPTG_T3D = new Transform3D();
               ViewerTG.getTransform(VPTG_T3D);
               VPTG_T3D.setTranslation(zero3d);
               VPTG_T3D.invert();
               currXform.mul(VPTG_T3D, currXform);
               translation.x = dx * xFactor;
               translation.y = -dy * yFactor;
               transformX.set(translation);
               if (invert) {
                 currXform.mul(currXform, transformX);
               } else {
                 currXform.mul(transformX, currXform);
               }
               VPTG_T3D.invert();
               currXform.mul(VPTG_T3D, currXform);
               transformGroup.setTransform(currXform);
               transformChanged(currXform);
               if (callback != null) {
                 callback.transformChanged(MouseBehaviorCallback.TRANSLATE, currXform);
               }
             } else {
               reset = false;
             }
             xLast = x;
             yLast = y;
           }
           if (id == MouseEvent.MOUSE_PRESSED) {
             xLast = ((MouseEvent) awtEvent).getX();
             yLast = ((MouseEvent) awtEvent).getY();
           } else if (id == MouseEvent.MOUSE_RELEASED) {
             setTransformGroup(null);
           }
         }
       }
     }
     if (transformGroup != null) {
       wakeupOn(mouseCriterion);
     } else {
       mouseButton = MouseEvent.BUTTON3_DOWN_MASK;
       postId(doneID);
       wakeupOn(postCriterion);
     }
   }
 
   /**
    * Set the x-axis amd y-axis movement multipler with factor.
    *
    * <p>setFactor
    *
    * @param factor a double.
    */
   public void setFactor(double factor) {
     xFactor = yFactor = factor;
   }
 
   /**
    * Set the x-axis amd y-axis movement multipler with xFactor and yFactor respectively.
    *
    * <p>setFactor
    *
    * @param xFactor a double.
    * @param yFactor a double.
    */
   public void setFactor(double xFactor, double yFactor) {
     this.xFactor = xFactor;
     this.yFactor = yFactor;
   }
 
   /**
    * Setter for the field <code>mouseButton</code>.
    *
    * @param button a int.
    */
   public void setMouseButton(int button) {
     mouseButton = button;
   }
 
   /**
    * The transformChanged method in the callback class will be called every time the transform is
    * updated.
    *
    * <p>setupCallback
    *
    * @param c a {@link ffx.ui.behaviors.MouseBehaviorCallback} object.
    */
   public void setupCallback(MouseBehaviorCallback c) {
     callback = c;
   }
 
   /**
    * transformChanged
    *
    * @param transform a {@link org.jogamp.java3d.Transform3D} object.
    */
   public void transformChanged(Transform3D transform) {}
 }