1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: IHexagonBuilder.java,v 1.1 2005/09/09 18:24:28 mat007 Exp $
29 */
30
31 package jtge.util.grid.builder;
32
33 import java.awt.Point;
34 import java.awt.Polygon;
35 import jtge.util.grid.Coordinate;
36 import jtge.util.grid.IGrid;
37
38 /***
39 * @author Jean-Laurent
40 * @version $Id: IHexagonBuilder.java,v 1.1 2005/09/09 18:24:28 mat007 Exp $
41 */
42 public interface IHexagonBuilder
43 {
44 /***
45 * Build a single hexagon.
46 *
47 * @return the polygon
48 */
49 Polygon buildHexagon();
50
51 /***
52 * Build an hexagon within a map.
53 *
54 * @param coordinate position of the hexagon
55 * @return the polygon
56 */
57 Polygon buildHexagon( Coordinate coordinate );
58
59 /***
60 * Compute the width in pixels of a map consisting of given number of tiles width.
61 *
62 * @param width a number of tiles
63 * @return the width in pixels
64 */
65 int computeWidth( int width );
66
67 /***
68 * Compute the height in pixels of a map consisting of given number of tiles height.
69 *
70 * @param height a number of tiles
71 * @return the height in pixels
72 */
73 int computeHeight( int height );
74
75 /***
76 * Picks the coordinate at a given screen coordinate in a grid.
77 *
78 * @param point the screen coordinate in pixels
79 * @param grid the grid to look into
80 * @return the corresponding coordinate or null if outside the grid
81 */
82 Coordinate fromPixel( Point point, IGrid grid );
83 }