vtkPlotBar.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkPlotBar.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 vtkPlotBar_h
#define vtkPlotBar_h
 
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkPlot.h"
#include "vtkSmartPointer.h" // Needed to hold ColorSeries
 
class vtkContext2D;
class vtkTable;
class vtkPoints2D;
class vtkStdString;
class vtkColorSeries;
class vtkUnsignedCharArray;
class vtkScalarsToColors;
 
class vtkPlotBarPrivate;
 
class VTKCHARTSCORE_EXPORT vtkPlotBar : public vtkPlot
{
public:
  vtkTypeMacro(vtkPlotBar, vtkPlot);
  virtual void PrintSelf(ostream &os, vtkIndent indent);
 
 
  enum {
    VERTICAL = 0,
    HORIZONTAL
  };
 
  static vtkPlotBar *New();
 
  virtual void Update();
 
  virtual bool Paint(vtkContext2D *painter);
 
 
  virtual bool PaintLegend(vtkContext2D *painter, const vtkRectf& rect,
                           int legendIndex);
 
 
  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]);
 
 
  vtkSetMacro(Width, float);
 
 
  vtkGetMacro(Width, float);
 
 
  vtkSetMacro(Offset, float);
  vtkGetMacro(Offset, float);
 
 
  virtual void SetOrientation(int orientation);
  vtkGetMacro(Orientation, int);
 
  virtual void GetBounds(double bounds[4], bool unscaled);
 
  virtual void GetBounds(double bounds[4]);
 
  virtual void GetUnscaledInputBounds(double bounds[4]);
 
  virtual void SetInputArray(int index, const vtkStdString &name);
 
  void SetColorSeries(vtkColorSeries *colorSeries);
 
  vtkColorSeries *GetColorSeries();
 
 
  virtual void SetLookupTable(vtkScalarsToColors *lut);
  virtual vtkScalarsToColors *GetLookupTable();
 
  virtual void CreateDefaultLookupTable();
 
 
  vtkSetMacro(ScalarVisibility, bool);
  vtkGetMacro(ScalarVisibility, bool);
  vtkBooleanMacro(ScalarVisibility, bool);
 
 
  void SelectColorArray(vtkIdType arrayNum);
  void SelectColorArray(const vtkStdString& arrayName);
 
  vtkStdString GetColorArrayName();
 
  virtual vtkStringArray *GetLabels();
 
  virtual void SetGroupName(const vtkStdString& name);
 
  virtual vtkStdString GetGroupName();
 
 
  virtual vtkStdString GetTooltipLabel(const vtkVector2d &plotPos,
                                       vtkIdType seriesIndex,
                                       vtkIdType segmentIndex);
 
  virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);
 
//BTX
 
  virtual vtkIdType GetNearestPoint(const vtkVector2f& point,
                                    const vtkVector2f& tolerance,
                                    vtkVector2f* location);
 
 
  virtual vtkIdType GetNearestPoint(const vtkVector2f& point,
                                    const vtkVector2f&,
                                    vtkVector2f* location,
                                    vtkIdType* segmentIndex);
 
  int GetBarsCount();
 
  void GetDataBounds(double bounds[2]);
 
protected:
  vtkPlotBar();
  ~vtkPlotBar();
 
  bool UpdateTableCache(vtkTable *table);
 
  vtkPoints2D *Points;
 
  float Width;
  float Offset;
 
  int Orientation;
 
  vtkTimeStamp BuildTime;
 
  vtkSmartPointer<vtkColorSeries> ColorSeries;
 
 
  vtkSmartPointer<vtkScalarsToColors> LookupTable;
  vtkSmartPointer<vtkUnsignedCharArray> Colors;
  bool ScalarVisibility;
  vtkStdString ColorArrayName;
 
  bool LogX;
  bool LogY;
 
private:
  vtkPlotBar(const vtkPlotBar &); // Not implemented.
  void operator=(const vtkPlotBar &); // Not implemented.
 
  vtkPlotBarPrivate *Private;
 
//ETX
};
 
#endif //vtkPlotBar_h