vtkPlot.h

Go to the documentation of this file.

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

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

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkStdString.h"     // Needed to hold TooltipLabelFormat ivar
#include "vtkSmartPointer.h"  // Needed to hold SP ivars
#include "vtkContextPolygon.h" // For vtkContextPolygon
#include "vtkRect.h"           // For vtkRectd ivar

class vtkVariant;
class vtkTable;
class vtkIdTypeArray;
class vtkContextMapper2D;
class vtkPen;
class vtkBrush;
class vtkAxis;
class vtkStringArray;

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


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

  virtual bool PaintLegend(vtkContext2D *painter, const vtkRectf& rect,
                           int legendIndex);


  virtual void SetTooltipLabelFormat(const vtkStdString &label);
  virtual vtkStdString GetTooltipLabelFormat();


  virtual void SetTooltipNotation(int notation);
  virtual int GetTooltipNotation();


  virtual void SetTooltipPrecision(int precision);
  virtual int GetTooltipPrecision();

  virtual vtkStdString GetTooltipLabel(const vtkVector2d &plotPos,
                                       vtkIdType seriesIndex,
                                       vtkIdType segmentIndex);

  virtual vtkIdType GetNearestPoint(const vtkVector2f& point,
                                    const vtkVector2f& tolerance,
                                    vtkVector2f* location);

  virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);

  virtual bool SelectPointsInPolygon(const vtkContextPolygon &polygon);


  virtual void SetColor(unsigned char r, unsigned char g, unsigned char b,
                        unsigned char a);
  virtual void SetColor(double r,  double g, double b);
  virtual void GetColor(double rgb[3]);
  void GetColor(unsigned char rgb[3]);

  virtual void SetWidth(float width);

  virtual float GetWidth();


  void SetPen(vtkPen *pen);
  vtkPen* GetPen();


  void SetBrush(vtkBrush *brush);
  vtkBrush* GetBrush();


  void SetSelectionPen(vtkPen *pen);
  vtkPen* GetSelectionPen();


  void SetSelectionBrush(vtkBrush *brush);
  vtkBrush* GetSelectionBrush();

  virtual void SetLabel(const vtkStdString &label);

  virtual vtkStdString GetLabel();

  virtual void SetLabels(vtkStringArray *labels);

  virtual vtkStringArray *GetLabels();

  virtual int GetNumberOfLabels();

  vtkStdString GetLabel(vtkIdType index);

  void SetIndexedLabels(vtkStringArray *labels);

  virtual vtkStringArray *GetIndexedLabels();

  vtkContextMapper2D* GetData();


  vtkGetMacro(UseIndexForXSeries, bool);


  vtkSetMacro(UseIndexForXSeries, bool);


  virtual void SetInputData(vtkTable *table);
  virtual void SetInputData(vtkTable *table, const vtkStdString &xColumn,
                            const vtkStdString &yColumn);
  void SetInputData(vtkTable *table, vtkIdType xColumn, vtkIdType yColumn);

  virtual vtkTable* GetInput();

  virtual void SetInputArray(int index, const vtkStdString &name);


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


  virtual void SetSelection(vtkIdTypeArray *id);
  vtkGetObjectMacro(Selection, vtkIdTypeArray);


  vtkGetObjectMacro(XAxis, vtkAxis);
  virtual void SetXAxis(vtkAxis* axis);


  vtkGetObjectMacro(YAxis, vtkAxis);
  virtual void SetYAxis(vtkAxis* axis);


  void SetShiftScale(const vtkRectd &scaling);
  vtkRectd GetShiftScale();

  virtual void GetBounds(double bounds[4])
  { bounds[0] = bounds[1] = bounds[2] = bounds[3] = 0.0; }

  virtual void GetUnscaledInputBounds(double bounds[4])
  {
    // Implemented here by calling GetBounds() to support plot
    // subclasses that do no log-scaling or plot orientation.
    return this->GetBounds(bounds);
  }

  virtual void UpdateCache() {}


  virtual void SetProperty(const vtkStdString &property, const vtkVariant &var);
  virtual vtkVariant GetProperty(const vtkStdString &property);

protected:
  vtkPlot();
  ~vtkPlot();

  vtkStdString GetNumber(double position, vtkAxis *axis);

  vtkSmartPointer<vtkPen> Pen;

  vtkSmartPointer<vtkBrush> Brush;

  vtkSmartPointer<vtkPen> SelectionPen;

  vtkSmartPointer<vtkBrush> SelectionBrush;

  vtkSmartPointer<vtkStringArray> Labels;

  vtkSmartPointer<vtkStringArray> AutoLabels;

  vtkSmartPointer<vtkStringArray> IndexedLabels;

  bool UseIndexForXSeries;

  vtkSmartPointer<vtkContextMapper2D> Data;

  bool Selectable;

  vtkIdTypeArray *Selection;

  vtkAxis* XAxis;

  vtkAxis* YAxis;

  vtkStdString TooltipLabelFormat;

  vtkStdString TooltipDefaultLabelFormat;

  int TooltipNotation;
  int TooltipPrecision;

  vtkRectd ShiftScale;

  bool LegendVisibility;

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

};

#endif //vtkPlot_h