View Javadoc

1   /*
2    * @(#) LocatableInterface.java Sep 6, 2003
3    * 
4    * Copyright (c) 2003 Delft University of Technology Jaffalaan 5, 2628 BX Delft,
5    * the Netherlands All rights reserved.
6    * 
7    * This software is proprietary information of Delft University of Technology
8    * The code is published under the General Public License
9    */
10  package nl.tudelft.simulation.dsol.animation;
11  
12  import java.rmi.RemoteException;
13  
14  import javax.media.j3d.Bounds;
15  
16  import nl.tudelft.simulation.language.d3.DirectedPoint;
17  
18  /***
19   * The locatable interface
20   * <p>
21   * (c) copyright 2003 <a href="http://www.simulation.tudelft.nl">Delft
22   * University of Technology </a>, the Netherlands. <br>
23   * See for project information <a
24   * href="http://www.simulation.tudelft.nl">www.simulation.tudelft.nl </a> <br>
25   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
26   * License (GPL) </a>, no warranty <br>
27   * 
28   * @version 2.0 21.09.2003 <br>
29   * @author <a href="http://www.tbm.tudelft.nl/webstaf/peterja/index.htm">Peter
30   *         Jacobs </a>
31   */
32  public interface LocatableInterface
33  {
34  	/***
35  	 * returns the location of an object
36  	 * 
37  	 * @return DirectedPoint the location
38  	 * @throws RemoteException on network failure
39  	 */
40  	DirectedPoint getLocation() throws RemoteException;
41  
42  	/***
43  	 * returns the bounds of the locatable object. The bounds is the not rotated
44  	 * bounds around [0;0;0]
45  	 * 
46  	 * @return BoundingBox include this.getLocation() as center of the box..
47  	 * @throws RemoteException on network failure
48  	 */
49  	Bounds getBounds() throws RemoteException;
50  }