PlotFrame.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2006 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/PlotFrame.h
 
#ifndef __Pulsar_PlotFrame_h
#define __Pulsar_PlotFrame_h
 
#include "Pulsar/PlotAttributes.h"
#include "Pulsar/PlotScale.h"
#include "Pulsar/PlotAxis.h"
#include "Pulsar/PlotLabel.h"
 
#include <string>
 
namespace Pulsar {
 
  class Archive;

  class PlotFrame : public PlotAttributes {
 
  public:

    PlotFrame ();

    ~PlotFrame ();
 
    // Text interface to the PlotFrame class
    class Interface : public TextInterface::To<PlotFrame> {
    public:
      Interface (PlotFrame* = 0);
    };

    void set_viewport (float x0, float x1, float y0, float y1);

    PlotScale* get_x_scale (bool allow_transpose);
    PlotScale* get_x_scale () { return get_x_scale(false); }
    void set_x_scale (PlotScale* scale);

    PlotAxis* get_x_axis (bool allow_transpose);
    PlotAxis* get_x_axis () { return get_x_axis(false); }

    PlotScale* get_y_scale (bool allow_transpose);
    PlotScale* get_y_scale () { return get_y_scale(false); }
    void set_y_scale (PlotScale* scale);

    PlotAxis* get_y_axis (bool allow_transpose);
    PlotAxis* get_y_axis () { return get_y_axis(false); }

    void no_labels ();

    PlotLabel* get_label_below () { return below; }
    void set_label_below (PlotLabel*);

    void set_transpose (bool flag = true) { transpose = flag; }
    bool get_transpose () const { return transpose; }
 
    virtual void draw_axes (const Archive*);

    virtual void label_axes (const std::string& default_x,
                             const std::string& default_y);

    virtual void decorate (const Archive*);

    virtual void focus (const Archive*);

    virtual void init (const Archive*);

    virtual void include (PlotFrame*);

    virtual void copy (PlotFrame*);
    
    void hide_axes( void ) { draw_box = false; }

    virtual void freeze (bool f = true);
 
  protected:
 
    Reference::To<PlotScale> x_scale;
    Reference::To<PlotScale> y_scale;
 
    Reference::To<PlotAxis> x_axis;
    Reference::To<PlotAxis> y_axis;
 
    Reference::To<PlotLabel> below;
 
    bool transpose;
    
    bool draw_box;
    bool frozen;
  };
 
}
 
#endif