vtkChartBox.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkChartBox.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 vtkChartBox_h
#define vtkChartBox_h

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkChart.h"

class vtkIdTypeArray;
class vtkPlotBox;
class vtkStdString;
class vtkStringArray;
class vtkTooltipItem;

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

  static vtkChartBox* New();

  virtual void Update();

  virtual bool Paint(vtkContext2D *painter);


  void SetColumnVisibility(const vtkStdString& name, bool visible);
  void SetColumnVisibility(vtkIdType column, bool visible);

  void SetColumnVisibilityAll(bool visible);


  bool GetColumnVisibility(const vtkStdString& name);
  bool GetColumnVisibility(vtkIdType column);

  vtkIdType GetColumnId(const vtkStdString& name);


  vtkGetObjectMacro(VisibleColumns, vtkStringArray);

  // Index of the selected column in the visible columns list.
  vtkGetMacro(SelectedColumn, int);
  vtkSetMacro(SelectedColumn, int);

  virtual vtkPlot* GetPlot(vtkIdType index);

  virtual vtkIdType GetNumberOfPlots();

  virtual vtkAxis* GetYAxis();

  virtual float GetXPosition(int index);

  virtual vtkIdType GetNumberOfVisibleColumns();

  virtual void SetPlot(vtkPlotBox *plot);

  virtual bool Hit(const vtkContextMouseEvent &mouse);

  virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse);

  virtual void SetTooltip(vtkTooltipItem *tooltip);

  virtual vtkTooltipItem* GetTooltip();

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

protected:
  vtkChartBox();
  ~vtkChartBox();


  class Private;
  Private *Storage;

  bool GeometryValid;

  vtkIdTypeArray *Selection;

  vtkStringArray *VisibleColumns;


  int SelectedColumn;
  float SelectedColumnDelta;

  vtkTimeStamp BuildTime;

  vtkSmartPointer<vtkTooltipItem> Tooltip;

  void ResetSelection();
  void UpdateGeometry(vtkContext2D*);
  void CalculatePlotTransform();
  void SwapAxes(int a1, int a2);

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

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

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

};


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

#endif //vtkChartBox_h