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: IDirection.java,v 1.1 2005/09/09 22:12:34 mat007 Exp $
29 */
30
31 package jtge.util.grid.direction;
32
33 import jtge.util.grid.Coordinate;
34 import jtge.util.grid.directiongroup.IDirectionGroup;
35
36
37 /***
38 * Defines direction behaviour.
39 *
40 * @author Mathieu Champlon
41 * @version $Revision: 1.1 $ $Date: 2005/09/09 22:12:34 $
42 */
43 public interface IDirection
44 {
45 /***
46 * Follow the direction from a given coordinate.
47 *
48 * @param coordinate the origin
49 * @param directionGroup the direction group strategy
50 * @return the coordinate in the direction
51 */
52 Coordinate transform( Coordinate coordinate, IDirectionGroup directionGroup );
53
54 /***
55 * Retrieve the direction name.
56 *
57 * @return the name
58 */
59 String getName();
60
61 /***
62 * Retrieve the direction short name.
63 *
64 * @return the short name
65 */
66 String getShortName();
67 }