Axis.hpp

Go to the documentation of this file.

#pragma ident "$Id: Axis.hpp 2091 2009-08-21 14:24:47Z afarris $"


//============================================================================
//
//  This file is part of GPSTk, the GPS Toolkit.
//
//  The GPSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 2.1 of the License, or
//  any later version.
//
//  The GPSTk 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GPSTk; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================

#ifndef VPLOT_AXIS_H
#define VPLOT_AXIS_H

#include <cmath>
#include <cstdio>
#include "AxisStyle.hpp"
#include "GraphicsConstants.hpp"
#include "Frame.hpp"

namespace vplot
{
  /*
   * I probably need a class for the following things:
   *   - Direction for axis
   *   - Bounds!
   *     - Bound generation from min/max (with buffer area? round?)
   * - If this is a seperate class it needs a set of COPY commands
   *   that copy to a different orientation.  Or a mirror setting that
   *   does so automagically.
   */

  class Axis
  {
    public:
      static const double RIGHT; // = 0;
      static const double UP   ; // = RIGHT+vdraw::HALF_PI;
      static const double LEFT ; // = UP+vdraw::HALF_PI;
      static const double DOWN ; // = LEFT+vdraw::HALF_PI;
      static const double N    ; // = UP;
      static const double E    ; // = RIGHT;
      static const double S    ; // = DOWN;
      static const double W    ; // = LEFT;
      static const double NORTH; // = N;
      static const double EAST ; // = E;
      static const double SOUTH; // = S;
      static const double WEST ; // = W;

      /*
       * Constructor/Destructor
       */

      Axis(double ix, double iy, double ex, double ey, double length, double imin, double imax, const AxisStyle &style=AxisStyle())
      {
        //Calculate direction
        /*
         * tan(dir) = opposite / adjacent;
         * arctan(opposite/adjacent) = dir;
         * opposite = (ey-iy);
         * adjacent = (ex-ix);
         */
        double direction;
        if(ex==ix) 
        {
          if(ey < iy) direction=vdraw::PI;
          else        direction=0;
        }
        else if(ey==iy)
        {
          if(ex < ix) direction=vdraw::PI+vdraw::HALF_PI;
          else        direction=vdraw::HALF_PI;
        }
        else
        {
          direction=atan((ey-iy)/(ex-ix));
          if(direction < 0) direction=vdraw::TWO_PI+direction;
        }
        init(ix,iy,direction,length,imin,imax,style);
      }

      Axis(double ix, double iy, double direction, double length, double imin, double imax, const AxisStyle &style=AxisStyle())
      {
        init(ix,iy,direction,length,imin,imax,style);
      }

      ~Axis() 
      {
      }

      /*
       * Accessors/Modifiers
       */
      inline void setPosition(double ix, double iy) { x=ix; y=iy; }

      inline void setLength(double length) { line_length=length; }

      inline void setRange(double imin, double imax) { min=imin; max=imax; axesMin=min; axesMax=max; }

      inline void setGap(double igap) { gap=igap; }

      void setAngle(double angle);

      /*
       * Methods
       */

      void drawToFrame(const vdraw::Frame &ff);

      bool pointFromValue(double &x, double &y, double value);

      inline bool labelPointAbove(double &x, double &y, double &rotation, double value)
      {
        return labelPoint(x,y,rotation,value,AxisStyle::ABOVE);
      }

      inline bool labelPointBelow(double &x, double &y, double &rotation, double value)
      {
        return labelPoint(x,y,rotation,value,AxisStyle::BELOW);
      }

      AxisStyle axis_style;

    protected:
      /*
       * Funtions
       */

      void init(double ix, double iy, double direction, double length, double imin, double imax, const AxisStyle &style);

      /*
       * Old idea for a helper to draw ticks.  I like my ascii art too much to
       * delete it for now :)
       *
       * For example:
       *        sr=.5   sv=0     |--1--|=fd
       * |-------50%-------|     |--5--|=rd
       * |-----|-----|-----|-----|-----|-----| <-- Actual Line
       * -3    -2    -1    0     1     2     3 <-- Actual labels
       * Would call as follows:
       * axisHelper(f,0.5,0,5,1)
       *
       * sr Start ratio (% of length to begin point)
       * sv Start value (in plot space)
       * rd Real distance (in page space)
       * fd Fake distance (in plot space)
       */

      inline void fromRatio(double &x, double &y, double ratio)
      {
        x = this->x+cosdir*line_length*ratio;
        y = this->y+sindir*line_length*ratio;
      }

      inline void axisTick(double ratio, double dist)
      {
        axisTickRecursive(
            true,
            axis_style.tick_recursion_depth,
            ratio,
            dist,
            axis_style.major_tick_length);
      }

      void axisTickRecursive(bool draw, int depth, double ratio, double dist, double length);

      void drawTick(double ratio, double length);

      void fromTic(double &x1, double &y1, double &x2, double &y2, 
          double distratio, double length);

      void guessTickInfo(double &startpos, double &startval, double &distpos, double &distval);

      bool label(double value, int direction, const vdraw::TextStyle &style);

      bool label(const char *str, double value, int direction, const vdraw::TextStyle &style);

      bool label(vdraw::Text &t, double value, int direction, const vdraw::TextStyle &style);

      bool labelPoint(double &x, double &y, double &rotation, double value, int direction);

      /*
       * This stuff is specific to the axis in its own right.
       */
      vdraw::Frame f;

      double x;

      double y;

      double line_length;

      double line_direction;
      double sindir;
      double cosdir;
      double sintic;
      double costic;

      /*
       * This stuff is related to the data.
       */
      double max;
      double axesMax;


      double min;
      double axesMin;


      double gap;
  };
}

#endif //VPLOT_AXIS_H

---