src/jalview/datamodel/SequencePoint.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 /**
  24  * A bean that models a point with (x, y, z) coordinates and a reference to a
  25  * sequence
  26  */
  27 public class SequencePoint
  28 {
  29   /*
  30    * Associated alignment sequence, or dummy sequence object
  31    */
  32   private final SequenceI sequence;
  33
  34   /*
  35    * x, y, z position in 3-D space
  36    */
  37   public Point coord;
  38
  39   /**
  40    * Constructor
  41    *
  42    * @param sequence
  43    * @param coord
  44    */
  45   public SequencePoint(SequenceI sequence, Point pt)
  46   {
  47     this.sequence = sequence;
  48     this.coord = pt;
  49   }
  50
  51   /**
  52    * Constructor given a sequence and an array of x, y, z coordinate positions
  53    *
  54    * @param sequence
  55    * @param coords
  56    * @throws ArrayIndexOutOfBoundsException
  57    *           if array length is less than 3
  58    */
  59   public SequencePoint(SequenceI sequence, float[] coords)
  60   {
  61     this(sequence, new Point(coords[0], coords[1], coords[2]));
  62   }
  63
  64   public SequenceI getSequence()
  65   {
  66     return sequence;
  67   }
  68
  69   /**
  70    * Applies a negative translation of the 'shift' (x, y, z) coordinates
  71    *
  72    * @param centre
  73    */
  74   public void translateBack(Point shift)
  75   {
  76     float x = coord.x - shift.x;
  77     float y = coord.y - shift.y;
  78     float z = coord.z - shift.z;
  79
  80     coord = new Point(x, y, z);
  81   }
  82
  83   /**
  84    * Applies a positive translation of the 'shift' (x, y, z) coordinates
  85    *
  86    * @param centre
  87    */
  88   public void translate(Point shift)
  89   {
  90     float x = coord.x + shift.x;
  91     float y = coord.y + shift.y;
  92     float z = coord.z + shift.z;
  93
  94     coord = new Point(x, y, z);
  95   }
  96 }