vtkChartXY.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkChartXY.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.

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

#ifndef vtkChartXY_h
#define vtkChartXY_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkChart.h"
#include "vtkSmartPointer.h" // For SP ivars
#include "vtkVector.h" // For vtkVector2f in struct
#include "vtkContextPolygon.h" // For vtkContextPolygon

class vtkPlot;
class vtkAxis;
class vtkPlotGrid;
class vtkChartLegend;
class vtkTooltipItem;
class vtkChartXYPrivate; // Private class to keep my STL vector in...

class VTKCHARTSCORE_EXPORT vtkChartXY : public vtkChart
{
public:
  vtkTypeMacro(vtkChartXY, vtkChart);
  virtual void PrintSelf(ostream &os, vtkIndent indent);

  static vtkChartXY *New();

  virtual void Update();

  virtual bool Paint(vtkContext2D *painter);

  virtual vtkPlot * AddPlot(int type);

  virtual vtkIdType AddPlot(vtkPlot* plot);

  virtual bool RemovePlot(vtkIdType index);

  virtual void ClearPlots();

  virtual vtkPlot* GetPlot(vtkIdType index);

  virtual vtkIdType GetPlotIndex(vtkPlot*);

  vtkIdType RaisePlot(vtkPlot* plot);

  virtual vtkIdType StackPlotAbove(vtkPlot* plot, vtkPlot* under);

  vtkIdType LowerPlot(vtkPlot* plot);

  virtual vtkIdType StackPlotUnder(vtkPlot* plot, vtkPlot* above);

  virtual vtkIdType GetNumberOfPlots();

  int GetPlotCorner(vtkPlot *plot);

  void SetPlotCorner(vtkPlot *plot, int corner);

  virtual vtkAxis* GetAxis(int axisIndex);

  virtual void SetShowLegend(bool visible);

  virtual vtkChartLegend* GetLegend();

  virtual void SetTooltip(vtkTooltipItem *tooltip);

  virtual vtkTooltipItem* GetTooltip();

  virtual vtkIdType GetNumberOfAxes();

  virtual void RecalculateBounds();

  virtual void SetSelectionMethod(int method);


  vtkSetMacro(DrawAxesAtOrigin, bool);
  vtkGetMacro(DrawAxesAtOrigin, bool);
  vtkBooleanMacro(DrawAxesAtOrigin, bool);


  vtkSetMacro(AutoAxes, bool);
  vtkGetMacro(AutoAxes, bool);
  vtkBooleanMacro(AutoAxes, bool);


  vtkSetMacro(HiddenAxisBorder, int);
  vtkGetMacro(HiddenAxisBorder, int);


  vtkSetMacro(ForceAxesToBounds, bool);
  vtkGetMacro(ForceAxesToBounds, bool);
  vtkBooleanMacro(ForceAxesToBounds, bool);


  vtkSetMacro(BarWidthFraction, float);
  vtkGetMacro(BarWidthFraction, float);


  vtkSetMacro(ZoomWithMouseWheel, bool);
  vtkGetMacro(ZoomWithMouseWheel, bool);
  vtkBooleanMacro(ZoomWithMouseWheel, bool);


  vtkSetMacro(AdjustLowerBoundForLogPlot, bool);
  vtkGetMacro(AdjustLowerBoundForLogPlot, bool);
  vtkBooleanMacro(AdjustLowerBoundForLogPlot, bool);

  virtual void SetTooltipInfo(const vtkContextMouseEvent &,
                              const vtkVector2d &,
                              vtkIdType, vtkPlot*,
                              vtkIdType segmentIndex = -1);

  virtual bool Hit(const vtkContextMouseEvent &mouse);

  virtual bool MouseEnterEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseLeaveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta);

  virtual bool KeyPressEvent(const vtkContextKeyEvent &key);

protected:
  vtkChartXY();
  ~vtkChartXY();

  void RecalculatePlotTransforms();

  void RecalculatePlotBounds();

  virtual bool UpdateLayout(vtkContext2D* painter);

  virtual int GetLegendBorder(vtkContext2D* painter, int axisPosition);

  virtual void SetLegendPosition(const vtkRectf& rect);

  vtkSmartPointer<vtkChartLegend> Legend;

  vtkSmartPointer<vtkTooltipItem> Tooltip;

  bool PlotTransformValid;

  vtkRectf MouseBox;

  bool DrawBox;

  vtkContextPolygon SelectionPolygon;

  bool DrawSelectionPolygon;

  bool DrawNearestPoint;

  bool DrawAxesAtOrigin;

  bool AutoAxes;

  int HiddenAxisBorder;

  float BarWidthFraction;

  bool LayoutChanged;

  bool ForceAxesToBounds;

  bool ZoomWithMouseWheel;

  bool AdjustLowerBoundForLogPlot;

private:
  vtkChartXY(const vtkChartXY &) VTK_DELETE_FUNCTION;
  void operator=(const vtkChartXY &) VTK_DELETE_FUNCTION;

  vtkChartXYPrivate *ChartPrivate; // Private class where I hide my STL containers

  void CalculateBarPlots();

  bool LocatePointInPlots(const vtkContextMouseEvent &mouse,
                          int invokeEvent = -1);

  int LocatePointInPlot(const vtkVector2f &position,
                        const vtkVector2f &tolerance, vtkVector2f &plotPos,
                        vtkPlot *plot, vtkIdType &segmentIndex);

  bool RemovePlotFromCorners(vtkPlot *plot);

  void ZoomInAxes(vtkAxis *x, vtkAxis *y, float *orign, float *max);

  void TransformBoxOrPolygon(bool polygonMode, vtkTransform2D *transform,
                             const vtkVector2f &mousePosition,
                             vtkVector2f &min, vtkVector2f &max,
                             vtkContextPolygon &polygon);

};


struct vtkChartPlotData
{
  vtkStdString SeriesName;
  vtkVector2f Position;
  vtkVector2i ScreenPosition;
  int Index;
};

#endif //vtkChartXY_h