Merge branch 'releases/Release_2_11_4_Branch'
[jalview.git] / jalview / viewmodel / OverviewDimensionsShowHidden.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.viewmodel;
22
23 import jalview.api.AlignmentColsCollectionI;
24 import jalview.api.AlignmentRowsCollectionI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.AllColsCollection;
27 import jalview.datamodel.AllRowsCollection;
28 import jalview.datamodel.HiddenColumns;
29 import jalview.datamodel.HiddenSequences;
30
31 public class OverviewDimensionsShowHidden extends OverviewDimensions
32 {
33   private ViewportRanges ranges;
34
35   /**
36    * Create an OverviewDimensions object
37    * 
38    * @param ranges
39    *          positional properties of the viewport
40    * @param showAnnotationPanel
41    *          true if the annotation panel is to be shown, false otherwise
42    */
43   public OverviewDimensionsShowHidden(ViewportRanges vpranges,
44           boolean showAnnotationPanel)
45   {
46     super(vpranges, showAnnotationPanel);
47     ranges = vpranges;
48     resetAlignmentDims();
49   }
50
51   /**
52    * Check box dimensions and scroll positions and correct if necessary
53    * 
54    * @param mousex
55    *          x position in overview panel
56    * @param mousey
57    *          y position in overview panel
58    * @param hiddenSeqs
59    *          hidden sequences
60    * @param hiddenCols
61    *          hidden columns
62    * @param ranges
63    *          viewport position properties
64    */
65   @Override
66   public void updateViewportFromMouse(int mousex, int mousey,
67           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
68   {
69     int x = mousex;
70     int y = mousey;
71
72     resetAlignmentDims();
73
74     if (x < 0)
75     {
76       x = 0;
77     }
78
79     if (y < 0)
80     {
81       y = 0;
82     }
83
84     if (ranges.isWrappedMode())
85     {
86       y = 0; // sorry, no vertical scroll when wrapped
87     }
88
89     //
90     // Convert x value to residue position
91     //
92
93     // need to determine where scrollCol should be, given x
94     // to do this also need to know width of viewport, and some hidden column
95     // correction
96
97     // convert x to residues - this is an absolute position
98     int xAsRes = Math.round((float) x * alwidth / width);
99
100     // get viewport width in residues
101     int vpwidth = ranges.getViewportWidth();
102
103     // get where x should be when accounting for hidden cols
104     // if x is in a hidden col region, shift to left - but we still need
105     // absolute position
106     // so convert back after getting visible region position
107     int visXAsRes = hiddenCols.findColumnPosition(xAsRes);
108
109     // check in case we went off the edge of the alignment
110     int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1);
111     if (visXAsRes + vpwidth - 1 > visAlignWidth)
112     {
113       // went past the end of the alignment, adjust backwards
114
115       // if last position was before the end of the alignment, need to update
116       if (ranges.getEndRes() < visAlignWidth)
117       {
118         visXAsRes = hiddenCols.findColumnPosition(hiddenCols
119                 .subtractVisibleColumns(vpwidth - 1, alwidth - 1));
120       }
121       else
122       {
123         visXAsRes = ranges.getStartRes();
124       }
125     }
126
127     //
128     // Convert y value to sequence position
129     //
130
131     // convert y to residues
132     int yAsSeq = Math.round((float) y * alheight / sequencesHeight);
133
134     // get viewport height in sequences
135     int vpheight = ranges.getViewportHeight();
136
137     // get where y should be when accounting for hidden rows
138     // if y is in a hidden row region, shift up - but we still need absolute
139     // position,
140     // so convert back after getting visible region position
141     yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs
142             .findIndexWithoutHiddenSeqs(yAsSeq));
143     yAsSeq = Math.max(yAsSeq, 0); // -1 if before first visible sequence
144
145     // check in case we went off the edge of the alignment
146     int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
147     int visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
148     visYAsSeq = Math.max(visYAsSeq, 0); // -1 if before first visible sequence
149     if (visYAsSeq + vpheight - 1 > visAlignHeight)
150     {
151       // went past the end of the alignment, adjust backwards
152       if (ranges.getEndSeq() < visAlignHeight)
153       {
154         visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(hiddenSeqs
155                 .subtractVisibleRows(vpheight - 1, alheight - 1));
156       }
157       else
158       {
159         visYAsSeq = ranges.getStartSeq();
160       }
161     }
162
163     // update viewport
164     ranges.setStartRes(visXAsRes);
165     ranges.setStartSeq(visYAsSeq);
166   }
167
168   /**
169    * Update the overview panel box when the associated alignment panel is
170    * changed
171    * 
172    * @param hiddenSeqs
173    *          hidden sequences
174    * @param hiddenCols
175    *          hidden columns
176    * @param ranges
177    *          viewport position properties
178    */
179   @Override
180   public void setBoxPosition(HiddenSequences hiddenSeqs,
181           HiddenColumns hiddenCols)
182   {
183     // work with absolute values of startRes and endRes
184     int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes());
185     int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes());
186
187     // work with absolute values of startSeq and endSeq
188     int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq());
189     int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq());
190
191     setBoxPosition(startRes, startSeq, endRes - startRes + 1, endSeq
192             - startSeq + 1);
193   }
194
195   @Override
196   public AlignmentColsCollectionI getColumns(AlignmentI al)
197   {
198     return new AllColsCollection(0,
199             ranges.getAbsoluteAlignmentWidth() - 1, al);
200   }
201
202   @Override
203   public AlignmentRowsCollectionI getRows(AlignmentI al)
204   {
205     return new AllRowsCollection(0,
206             ranges.getAbsoluteAlignmentHeight() - 1,
207             al);
208   }
209
210   @Override
211   protected void resetAlignmentDims()
212   {
213     alwidth = ranges.getAbsoluteAlignmentWidth();
214     alheight = ranges.getAbsoluteAlignmentHeight();
215   }
216 }