vtkPlotBar.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkPlotBar_h
#define vtkPlotBar_h
 
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkPlot.h"
#include "vtkSmartPointer.h"  // Needed to hold ColorSeries
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkContext2D;
class vtkTable;
class vtkPoints2D;
class vtkStdString;
class vtkColorSeries;
class vtkUnsignedCharArray;
class vtkScalarsToColors;
 
class vtkPlotBarPrivate;
 
class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkPlotBar : public vtkPlot
{
public:
  vtkTypeMacro(vtkPlotBar, vtkPlot);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum
  {
    VERTICAL = 0,
    HORIZONTAL
  };

  static vtkPlotBar* New();

  bool Paint(vtkContext2D* painter) override;

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

  void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a) override;


  void SetColorF(double r, double g, double b, double a) override;
  void SetColorF(double r, double g, double b) override;
 
  VTK_DEPRECATED_IN_9_3_0("Please use unambiguous SetColorF method instead.")
  void SetColor(double r, double g, double b) override { this->SetColorF(r, g, b); }


  void GetColorF(double rgb[3]) override;
 
  VTK_DEPRECATED_IN_9_3_0("Please use unambiguous GetColorF method instead.")
  void GetColor(double rgb[3]) override { this->GetColorF(rgb); }


  void SetWidth(float _arg) override
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): setting Width to " << _arg);
    if (this->Width != _arg)
    {
      this->Width = _arg;
      this->Modified();
    }
  }



  float GetWidth() override
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning Width of "
                  << this->Width);
    return this->Width;
  }



  vtkSetMacro(Offset, float);
  vtkGetMacro(Offset, float);


  virtual void SetOrientation(int orientation);
  vtkGetMacro(Orientation, int);

  virtual void GetBounds(double bounds[4], bool unscaled);

  void GetBounds(double bounds[4]) override;

  void GetUnscaledInputBounds(double bounds[4]) override;

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

  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);


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


  void SelectColorArray(vtkIdType arrayNum);
  void SelectColorArray(const vtkStdString& arrayName);

  vtkStdString GetColorArrayName();

  vtkStringArray* GetLabels() override;

  virtual void SetGroupName(const vtkStdString& name);

  virtual vtkStdString GetGroupName();

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

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

  vtkIdType GetNearestPoint(const vtkVector2f& point, const vtkVector2f&, vtkVector2f* location,
    vtkIdType* segmentIndex) override;
  using vtkPlot::GetNearestPoint;

  int GetBarsCount();

  void GetDataBounds(double bounds[2]);

  bool UpdateCache() override;
 
protected:
  vtkPlotBar();
  ~vtkPlotBar() override;

  bool CacheRequiresUpdate() override;

  vtkPoints2D* Points;
 
  float Width;
  float Offset;
 
  int Orientation;

  vtkSmartPointer<vtkColorSeries> ColorSeries;


  vtkSmartPointer<vtkScalarsToColors> LookupTable;
  vtkSmartPointer<vtkUnsignedCharArray> Colors;
  bool ScalarVisibility;
  bool EnableOpacityMapping;
  vtkStdString ColorArrayName;
 
  bool LogX;
  bool LogY;
 
private:
  vtkPlotBar(const vtkPlotBar&) = delete;
  void operator=(const vtkPlotBar&) = delete;
 
  vtkPlotBarPrivate* Private;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkPlotBar_h