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: VerticalTorus.java,v 1.4 2005/09/09 17:44:01 mat007 Exp $
29 */
30
31 package jtge.util.grid.torus;
32
33 import jtge.util.grid.Coordinate;
34
35 /***
36 * Acts as a torus in the vertical direction.
37 *
38 * @author Jean-Laurent Fabre de Morlhon
39 * @version $Id: VerticalTorus.java,v 1.4 2005/09/09 17:44:01 mat007 Exp $
40 */
41 public class VerticalTorus implements ITorus
42 {
43 /***
44 * The height in tiles.
45 */
46 private final int height;
47
48 /***
49 * Create a vertical torus.
50 *
51 * @param height the height in tiles
52 */
53 public VerticalTorus( final int height )
54 {
55 this.height = height;
56 }
57
58 /***
59 * {@inheritDoc}
60 */
61 public final Coordinate transform( final Coordinate coordinate )
62 {
63 final Coordinate result = (Coordinate)coordinate.clone();
64 result.setY( (result.getY() + this.height) % this.height );
65 return result;
66 }
67 }