001/* An interface for objects storing a location.
002
003 Copyright (c) 2002-2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.kernel.util;
029
030///////////////////////////////////////////////////////////////////
031//// Locatable
032
033/**
034 An interface for objects storing a location.
035 Implementations of this interface are attributes that are contained
036 by objects that are rendered visually on the screen at locations
037 given by getLocation() method of this interface.
038
039 <p>This interface is generally implemented by attributes of objects
040 in a model and is used by the Vergil user interface to store
041 the location of objects in the visual editor.
042
043 @author Edward A. Lee
044 @version $Id$
045 @since Ptolemy II 2.1
046 @Pt.ProposedRating Green (cxh)
047 @Pt.AcceptedRating Green (cxh)
048 @see Location
049 */
050public interface Locatable extends Settable {
051    ///////////////////////////////////////////////////////////////////
052    ////                         public methods                    ////
053
054    /** Get the location in some cartesian coordinate system.
055     *  @return The location.
056     *  @see #setLocation(double [])
057     */
058    public double[] getLocation();
059
060    /** Set the location in some cartesian coordinate system, and notify
061     *  the container and any value listeners of the new location.
062     *  @param location The location.
063     *  @exception IllegalActionException If the location is rejected.
064     *  @see #getLocation()
065     */
066    public void setLocation(double[] location) throws IllegalActionException;
067}