c6eb6dec4a7e7f170d7c59dee4230c28dc329011
[jalview.git] / src / jalview / api / RotatableCanvasI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
3  * Copyright (C) 2014 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.api;
22
23 import jalview.datamodel.SequencePoint;
24
25 import java.util.List;
26
27 /**
28  * interface implemented by RotatatableCanvas GUI elements (such as point clouds
29  * and simple structure views)
30  * 
31  * @author jimp
32  * 
33  */
34 public interface RotatableCanvasI
35 {
36   void setPoints(List<SequencePoint> points, int rows);
37
38   /**
39    * Zoom the view in (or out) by the given factor, which should be >= 0. A
40    * factor greater than 1 zooms in (expands the display), a factor less than 1
41    * zooms out (shrinks the display).
42    * 
43    * @param factor
44    */
45   void zoom(float factor);
46
47   /**
48    * Rotates the view by the specified number of degrees about the x and/or y
49    * axis
50    * 
51    * @param x
52    * @param y
53    */
54   void rotate(float x, float y);
55 }