dox/GUISupport/Qt/Chart/vtkQtChartAxis.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkQtChartAxis.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/


#ifndef _vtkQtChartAxis_h
#define _vtkQtChartAxis_h

#include "vtkQtChartExport.h"
#include <QObject>
#include <QGraphicsItem>

#include "vtkQtChartGraphicsItemTypes.h" // needed for enum

class vtkQtChartAxisInternal;
class vtkQtChartAxisModel;
class vtkQtChartAxisOptions;
class vtkQtChartContentsArea;
class vtkQtChartContentsSpace;
class QGraphicsLineItem;
class QVariant;


class VTKQTCHART_EXPORT vtkQtChartAxis : public QObject, public QGraphicsItem
{
  Q_OBJECT

public:
  enum AxisLocation
    {
    Left = 0, 
    Bottom,   
    Right,    
    Top       
    };

  enum AxisDomain
    {
    UnsupportedDomain = -1,
    Number = 0, 
    Date,       
    Time,       
    String      
    };

  enum {Type = vtkQtChart_AxisType};

public:
  vtkQtChartAxis(AxisLocation location, QGraphicsItem *parent=0);
  virtual ~vtkQtChartAxis();

  virtual int type() const {return vtkQtChartAxis::Type;}






  AxisLocation getLocation() const {return this->Location;}

  vtkQtChartAxisModel *getModel() const {return this->Model;}

  void setModel(vtkQtChartAxisModel *model);

  void setNeigbors(const vtkQtChartAxis *atMin, const vtkQtChartAxis *atMax);

  void setParallelAxis(const vtkQtChartAxis *across);

  void setContentsSpace(const vtkQtChartContentsSpace *contents);

  void setDataAvailable(bool available);

  bool isBestFitGenerated() const;

  void setBestFitGenerated(bool on);

  void getBestFitRange(QVariant &min, QVariant &max) const;

  void setBestFitRange(const QVariant &min, const QVariant &max);

  bool isRangePaddingUsed() const;

  void setRangePaddingUsed(bool padRange);

  bool isExpansionToZeroUsed() const;

  void setExpansionToZeroUsed(bool expand);

  bool isExtraSpaceUsed() const;

  void setExtraSpaceUsed(bool addSpace);

  bool isSpaceTooSmall() const;

  void setSpaceTooSmall(bool tooSmall);






  vtkQtChartAxisOptions *getOptions() const {return this->Options;}

  void setOptions(const vtkQtChartAxisOptions &options);








  void layoutAxis(const QRectF &area);

  void adjustAxisLayout();

  float getPreferredSpace() const;

  float getFontHeight() const;

  float getMaxLabelWidth() const;

  float getTickLength() const;

  float getSmallTickLength() const;

  float getTickLabelSpacing() const;

  bool isLogScaleAvailable() const;

  virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
      QWidget *widget=0);


  virtual QRectF boundingRect() const;

  QRectF getBounds() const;

  bool isLabelTickVisible(int index) const;

  float getLabelLocation(int index) const;

  AxisDomain getAxisDomain() const;

  bool isValueInDomain(const QVariant &value) const;

  float getPixel(const QVariant &value) const;

  float getZeroPixel() const;

  static bool isLogScaleValid(const QVariant &min, const QVariant &max);

signals:
  void layoutNeeded();

  void pixelScaleChanged();

public slots:
  void reset();

  void setOffset(float offset);

private slots:
  void handleFontChange();

  void handlePresentationChange();

  void handleColorChange();

  void handleAxisScaleChange();

  void insertLabel(int index);

  void startLabelRemoval(int index);

  void finishLabelRemoval(int index);

private:
  float getLabelWidthGuess(const QVariant &minimum,
      const QVariant &maximum) const;

  void generateLabels(const QRectF &contents);

  void generateLogLabels(const QRectF &contents);

public:
  static const double MinLogValue;  

private:
  vtkQtChartAxisInternal *Internal;    
  vtkQtChartAxisOptions *Options;      
  vtkQtChartAxisModel *Model;          
  const vtkQtChartAxis *AtMin;         
  const vtkQtChartAxis *AtMax;         
  const vtkQtChartAxis *Across;        
  const vtkQtChartContentsSpace *Zoom; 
  AxisLocation Location;               
};

#endif