vtkChartParallelCoordinates.h 4.81 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*=========================================================================

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

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

// .NAME vtkChartParallelCoordinates - Factory class for drawing 2D charts
//
// .SECTION Description
19
// This defines the interface for a parallel coordinates chart.
20

21 22
#ifndef vtkChartParallelCoordinates_h
#define vtkChartParallelCoordinates_h
23

24
#include "vtkChartsCoreModule.h" // For export macro
25 26 27
#include "vtkChart.h"

class vtkIdTypeArray;
28
class vtkStdString;
29
class vtkStringArray;
30
class vtkPlotParallelCoordinates;
31

32
class VTKCHARTSCORE_EXPORT vtkChartParallelCoordinates : public vtkChart
33 34
{
public:
35
  vtkTypeMacro(vtkChartParallelCoordinates, vtkChart);
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
  virtual void PrintSelf(ostream &os, vtkIndent indent);

  // Description:
  // Creates a parallel coordinates chart
  static vtkChartParallelCoordinates* New();

  // Description:
  // Perform any updates to the item that may be necessary before rendering.
  // The scene should take care of calling this on all items before their
  // Paint function is invoked.
  virtual void Update();

  // Description:
  // Paint event for the chart, called whenever the chart needs to be drawn
  virtual bool Paint(vtkContext2D *painter);

52 53
  // Description:
  // Set the visibility of the specified column.
54
  void SetColumnVisibility(const vtkStdString& name, bool visible);
55

56 57 58 59 60
  // Description:
  // Set the visibility of all columns (true will make them all visible, false
  // will remove all visible columns).
  void SetColumnVisibilityAll(bool visible);

61 62
  // Description:
  // Get the visibility of the specified column.
63
  bool GetColumnVisibility(const vtkStdString& name);
64 65 66 67 68

  // Description:
  // Get a list of the columns, and the order in which they are displayed.
  vtkGetObjectMacro(VisibleColumns, vtkStringArray);

69 70 71 72 73 74 75 76 77
  // Description:
  // Get the plot at the specified index, returns null if the index is invalid.
  virtual vtkPlot* GetPlot(vtkIdType index);

  // Description:
  // Get the number of plots the chart contains.
  virtual vtkIdType GetNumberOfPlots();

  // Description:
78
  // Get the axis specified by axisIndex.
79 80 81 82 83 84 85 86 87 88 89
  virtual vtkAxis* GetAxis(int axisIndex);

  // Description:
  // Get the number of axes in the current chart.
  virtual vtkIdType GetNumberOfAxes();

  // Description:
  // Request that the chart recalculates the range of its axes. Especially
  // useful in applications after the parameters of plots have been modified.
  virtual void RecalculateBounds();

90 91 92 93 94
  // Description
  // Set plot to use for the chart. Since this type of chart can
  // only contain one plot, this will replace the previous plot.
  virtual void SetPlot(vtkPlotParallelCoordinates *plot);

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
  // Description:
  // Return true if the supplied x, y coordinate is inside the item.
  virtual bool Hit(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse enter event.
  virtual bool MouseEnterEvent(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse move event.
  virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse leave event.
  virtual bool MouseLeaveEvent(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse button down event
  virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse button release event.
  virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse);

  // Description:
  // Mouse wheel event, positive delta indicates forward movement of the wheel.
  virtual bool MouseWheelEvent(const vtkContextMouseEvent &mouse, int delta);

protected:
  vtkChartParallelCoordinates();
  ~vtkChartParallelCoordinates();

  // Description:
  // Private storage object - where we hide all of our STL objects...
  class Private;
  Private *Storage;

  bool GeometryValid;

  // Description:
  // Selected indices for the table the plot is rendering
  vtkIdTypeArray *Selection;

138 139 140 141
  // Description:
  // A list of the visible columns in the chart.
  vtkStringArray *VisibleColumns;

142 143 144 145
  // Description:
  // The point cache is marked dirty until it has been initialized.
  vtkTimeStamp BuildTime;

146
  void ResetSelection();
147 148
  void UpdateGeometry();
  void CalculatePlotTransform();
149
  void SwapAxes(int a1, int a2);
150 151

private:
152
  vtkChartParallelCoordinates(const vtkChartParallelCoordinates &) VTK_DELETE_FUNCTION;
153
  void operator=(const vtkChartParallelCoordinates &) VTK_DELETE_FUNCTION;
154

155 156
};

157
#endif //vtkChartParallelCoordinates_h