X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fviewmodel%2FOverviewDimensions.java;h=eb4a6e6e5ac79f9021f8320a428b9225335cd7f9;hb=14985603cea28569e295ddabb219da8034f1c7b2;hp=db82aa51340f293c6cad6f86a22ad35eff9b2795;hpb=d1707d4c26db76cfeb640f0dbeb3e3427fd40eb7;p=jalview.git diff --git a/src/jalview/viewmodel/OverviewDimensions.java b/src/jalview/viewmodel/OverviewDimensions.java index db82aa5..eb4a6e6 100644 --- a/src/jalview/viewmodel/OverviewDimensions.java +++ b/src/jalview/viewmodel/OverviewDimensions.java @@ -20,60 +20,35 @@ */ package jalview.viewmodel; +import jalview.api.AlignmentColsCollectionI; +import jalview.api.AlignmentRowsCollectionI; +import jalview.datamodel.AlignmentI; import jalview.datamodel.HiddenColumns; import jalview.datamodel.HiddenSequences; import java.awt.Graphics; -public class OverviewDimensions +public abstract class OverviewDimensions { - // Default width and height values - private static final int DEFAULT_GRAPH_HEIGHT = 20; - - private static final int MAX_WIDTH = 400; - - private static final int MIN_WIDTH = 120; - - private static final int MIN_SEQ_HEIGHT = 40; - - private static final int MAX_SEQ_HEIGHT = 300; - - // width of the overview panel - private int width; - - // height of sequences part of the overview panel - private int sequencesHeight; - - // height of the graphs part of the overview panel - private int graphHeight = DEFAULT_GRAPH_HEIGHT; + protected static final int MAX_WIDTH = 400; + protected static final int MIN_WIDTH = 120; + protected static final int MIN_SEQ_HEIGHT = 40; + protected static final int MAX_SEQ_HEIGHT = 300; - // dimensions of box outlining current extent of view in alignment panel - // location of left side of box - private int boxX = -1; - - // location of bottom of box - private int boxY = -1; - - // width of box - private int boxWidth = -1; - - // height of box - private int boxHeight = -1; - - // scroll position in viewport corresponding to boxX - private int scrollCol = -1; + private static final int DEFAULT_GRAPH_HEIGHT = 20; - // scroll position in viewport corresponding to boxY - private int scrollRow = -1; + protected int width; + protected int sequencesHeight; + protected int graphHeight = DEFAULT_GRAPH_HEIGHT; + protected int boxX = -1; + protected int boxY = -1; + protected int boxWidth = -1; + protected int boxHeight = -1; + protected int scrollCol = -1; + protected int scrollRow = -1; + protected int alwidth; + protected int alheight; - /** - * Create an OverviewDimensions object - * - * @param ranges - * positional properties of the viewport - * @param showAnnotationPanel - * true if the annotation panel is to be shown, false otherwise - */ public OverviewDimensions(ViewportRanges ranges, boolean showAnnotationPanel) { @@ -111,159 +86,6 @@ public class OverviewDimensions } /** - * Check box dimensions and scroll positions and correct if necessary - * - * @param mousex - * x position in overview panel - * @param mousey - * y position in overview panel - * @param hiddenSeqs - * hidden sequences - * @param hiddenCols - * hidden columns - * @param ranges - * viewport position properties - */ - public void updateViewportFromMouse(int mousex, int mousey, - HiddenSequences hiddenSeqs, HiddenColumns hiddenCols, - ViewportRanges ranges) - { - int x = mousex; - int y = mousey; - - int alwidth = ranges.getAbsoluteAlignmentWidth(); - int alheight = ranges.getAbsoluteAlignmentHeight(); - - if (x < 0) - { - x = 0; - } - - if (y < 0) - { - y = 0; - } - - // - // Convert x value to residue position - // - - // need to determine where scrollCol should be, given x - // to do this also need to know width of viewport, and some hidden column - // correction - - // convert x to residues - this is an absolute position - int xAsRes = Math.round((float) x * alwidth / width); - - // get viewport width in residues - int vpwidth = ranges.getEndRes() - ranges.getStartRes() + 1; - - // get where x should be when accounting for hidden cols - // if x is in a hidden col region, shift to left - but we still need - // absolute position - // so convert back after getting visible region position - int visXAsRes = hiddenCols.findColumnPosition(xAsRes); - - // check in case we went off the edge of the alignment - int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1); - if (visXAsRes + vpwidth - 1 > visAlignWidth) - { - // went past the end of the alignment, adjust backwards - - // if last position was before the end of the alignment, need to update - if ((scrollCol + vpwidth - 1) < visAlignWidth) - { - visXAsRes = hiddenCols.findColumnPosition(hiddenCols - .subtractVisibleColumns(vpwidth - 1, alwidth - 1)); - } - else - { - visXAsRes = scrollCol; - } - } - - // - // Convert y value to sequence position - // - - // convert y to residues - int yAsSeq = Math.round((float) y * alheight / sequencesHeight); - - // get viewport height in sequences - // add 1 because height includes both endSeq and startSeq - int vpheight = ranges.getEndSeq() - ranges.getStartSeq() + 1; - - // get where y should be when accounting for hidden rows - // if y is in a hidden row region, shift up - but we still need absolute - // position, - // so convert back after getting visible region position - yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs - .findIndexWithoutHiddenSeqs(yAsSeq)); - - // check in case we went off the edge of the alignment - int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight); - int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq); - if (visYAsRes + vpheight - 1 > visAlignHeight) - { - // went past the end of the alignment, adjust backwards - if ((scrollRow + vpheight - 1) < visAlignHeight) - { - visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(hiddenSeqs - .subtractVisibleRows(vpheight - 1, alheight - 1)); - } - else - { - visYAsRes = scrollRow; - } - } - - // update scroll values - scrollCol = visXAsRes; - scrollRow = visYAsRes; - - } - - /** - * Update the overview panel box when the associated alignment panel is - * changed - * - * @param hiddenSeqs - * hidden sequences - * @param hiddenCols - * hidden columns - * @param ranges - * viewport position properties - */ - public void setBoxPosition(HiddenSequences hiddenSeqs, - HiddenColumns hiddenCols, ViewportRanges ranges) - { - int alwidth = ranges.getAbsoluteAlignmentWidth(); - int alheight = ranges.getAbsoluteAlignmentHeight(); - - // work with absolute values of startRes and endRes - int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes()); - int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes()); - - // work with absolute values of startSeq and endSeq - int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq()); - int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq()); - - // boxX, boxY is the x,y location equivalent to startRes, startSeq - boxX = Math.round((float) startRes * width / alwidth); - boxY = Math.round((float) startSeq * sequencesHeight / alheight); - - // boxWidth is the width in residues translated to pixels - // since the box includes both the start and end residues, add 1 to the - // difference - boxWidth = Math - .round((float) (endRes - startRes + 1) * width / alwidth); - // boxHeight is the height in sequences translated to pixels - boxHeight = Math.round((float) (endSeq - startSeq + 1) - * sequencesHeight - / alheight); - } - - /** * Draw the overview panel's viewport box on a graphics object * * @param g @@ -285,42 +107,26 @@ public class OverviewDimensions return scrollRow; } - // TODO should be removed, when unit test has mock Graphics object available - // to check boxX/boxY public int getBoxX() { return boxX; } - // TODO should be removed, when unit test has mock Graphics object available - // to check boxX/boxY public int getBoxY() { return boxY; } - // TODO should be removed, when unit test has mock Graphics object available public int getBoxWidth() { return boxWidth; } - // TODO should be removed, when unit test has mock Graphics object available public int getBoxHeight() { return boxHeight; } - public void setWidth(int w) - { - width = w; - } - - public void setHeight(int h) - { - sequencesHeight = h - graphHeight; - } - public int getWidth() { return width; @@ -340,4 +146,76 @@ public class OverviewDimensions { return graphHeight; } -} + + public float getPixelsPerCol() + { + resetAlignmentDims(); + return (float) width / alwidth; + } + + public float getPixelsPerSeq() + { + resetAlignmentDims(); + return (float) sequencesHeight / alheight; + } + + public void setWidth(int w) + { + width = w; + } + + public void setHeight(int h) + { + sequencesHeight = h - graphHeight; + } + + /** + * Update the viewport location from a mouse click in the overview panel + * + * @param mousex + * x location of mouse + * @param mousey + * y location of mouse + * @param hiddenSeqs + * the alignment's hidden sequences + * @param hiddenCols + * the alignment's hidden columns + */ + public abstract void updateViewportFromMouse(int mousex, int mousey, + HiddenSequences hiddenSeqs, HiddenColumns hiddenCols); + + /** + * Set the overview panel's box position to match the viewport + * + * @param hiddenSeqs + * the alignment's hidden sequences + * @param hiddenCols + * the alignment's hidden columns + */ + public abstract void setBoxPosition(HiddenSequences hiddenSeqs, + HiddenColumns hiddenCols); + + /** + * Get the collection of columns used by this overview dimensions object + * + * @param hiddenCols + * the alignment's hidden columns + * @return a column collection + */ + public abstract AlignmentColsCollectionI getColumns( + HiddenColumns hiddenCols); + + /** + * Get the collection of rows used by this overview dimensions object + * + * @param al + * the alignment + * @return a row collection + */ + public abstract AlignmentRowsCollectionI getRows(AlignmentI al); + + /** + * Updates overview dimensions to account for current alignment dimensions + */ + protected abstract void resetAlignmentDims(); +} \ No newline at end of file