Interface Locatable

  • All Superinterfaces:
    Nameable, Settable
    All Known Implementing Classes:
    Location, LocationParameter, RelativeLocation, Vertex

    public interface Locatable
    extends Settable
    An interface for objects storing a location. Implementations of this interface are attributes that are contained by objects that are rendered visually on the screen at locations given by getLocation() method of this interface.

    This interface is generally implemented by attributes of objects in a model and is used by the Vergil user interface to store the location of objects in the visual editor.

    Since:
    Ptolemy II 2.1
    Version:
    $Id$
    Author:
    Edward A. Lee
    See Also:
    Location
    Pt.AcceptedRating:
    Green (cxh)
    Pt.ProposedRating:
    Green (cxh)
    • Method Detail

      • getLocation

        double[] getLocation()
        Get the location in some cartesian coordinate system.
        Returns:
        The location.
        See Also:
        setLocation(double [])
      • setLocation

        void setLocation​(double[] location)
                  throws IllegalActionException
        Set the location in some cartesian coordinate system, and notify the container and any value listeners of the new location.
        Parameters:
        location - The location.
        Throws:
        IllegalActionException - If the location is rejected.
        See Also:
        getLocation()