casa6

//# PlotItem.h: Top of hierarchy for objects that can be drawn on a canvas.

//# Copyright (C) 2008

//# Associated Universities, Inc. Washington DC, USA.

//#

//# This library is free software; you can redistribute it and/or modify it

//# under the terms of the GNU Library General Public License as published by

//# the Free Software Foundation; either version 2 of the License, or (at your

//# option) any later version.

//#

//# This library is distributed in the hope that it will be useful, but WITHOUT

//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public

//# License for more details.

//#

//# You should have received a copy of the GNU Library General Public License

//# along with this library; if not, write to the Free Software Foundation,

//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.

//#

//# Correspondence concerning AIPS++ should be addressed as follows:

//#        Internet email: aips2-request@nrao.edu.

//#        Postal address: AIPS++ Project Office

//#                        National Radio Astronomy Observatory

//#                        520 Edgemont Road

//#                        Charlottesville, VA 22903-2475 USA

//#

//# $Id: $

#ifndef PLOTITEM_H_

#define PLOTITEM_H_

​

#include <graphics/GenericPlotter/PlotOptions.h>

​

namespace casa {

​

//# Forward Declarations

class PlotCanvas;

​

// PlotItem is the superclass of any object that is meant to be placed on the

// canvas (plots, annotations, shapes, etc.).  A PlotItem is assumed to have an

// x and y axis for drawing on the canvas.

class PlotItem {

public:

    // Constructor.

    PlotItem();

    // Destructor.

    virtual ~PlotItem();

​

    // Returns the canvas this item is currently attached to, or NULL for none.

    virtual PlotCanvas* canvas() const = 0;

    // Returns a human-readable title for identification.  Doesn't have to

    // be unique. Used for (for example) legends and other user-interactions.

    // Note: PlotItems that have no titles should not be shown on the legend.

    virtual casacore::String title() const = 0;

    // Sets this items's title to the given.

    virtual void setTitle(const casacore::String& newTitle) = 0;

    // Returns true if this item is valid, false otherwise.  Although validity

    // varies between items, canvases should NOT draw items which are invalid.

    virtual bool isValid() const = 0;