vtkBarChartActor.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 vtkBarChartActor_h
#define vtkBarChartActor_h
 
#include "vtkActor2D.h"
#include "vtkNew.h"                       // For vtkNew
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkWrappingHints.h"             // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAxisActor2D;
class vtkDataObject;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkTextMapper;
class vtkTextProperty;
class vtkLegendBoxActor;
class vtkGlyphSource2D;
class vtkBarLabelArray;
 
class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkBarChartActor : public vtkActor2D
{
public:

  vtkTypeMacro(vtkBarChartActor, vtkActor2D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkBarChartActor* New();

  virtual void SetInput(vtkDataObject*);


  vtkGetObjectMacro(Input, vtkDataObject);


  vtkSetMacro(TitleVisibility, vtkTypeBool);
  vtkGetMacro(TitleVisibility, vtkTypeBool);
  vtkBooleanMacro(TitleVisibility, vtkTypeBool);


  vtkSetStringMacro(Title);
  vtkGetStringMacro(Title);


  virtual void SetTitleTextProperty(vtkTextProperty* p);
  vtkGetObjectMacro(TitleTextProperty, vtkTextProperty);


  vtkSetMacro(LabelVisibility, vtkTypeBool);
  vtkGetMacro(LabelVisibility, vtkTypeBool);
  vtkBooleanMacro(LabelVisibility, vtkTypeBool);


  virtual void SetLabelTextProperty(vtkTextProperty* p);
  vtkGetObjectMacro(LabelTextProperty, vtkTextProperty);


  void SetBarColor(int i, double r, double g, double b);
  void SetBarColor(int i, const double color[3])
  {
    this->SetBarColor(i, color[0], color[1], color[2]);
  }
  double* GetBarColor(int i);


  void SetBarLabel(int i, const char*);
  const char* GetBarLabel(int i);
  int GetNumberOfBarLabels();


  vtkSetStringMacro(YTitle);
  vtkGetStringMacro(YTitle);


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


  vtkGetObjectMacro(LegendActor, vtkLegendBoxActor);


  int RenderOverlay(vtkViewport*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }

  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  void ReleaseGraphicsResources(vtkWindow*) override;
 
protected:
  vtkBarChartActor();
  ~vtkBarChartActor() override;
 
private:
  vtkDataObject* Input; // List of data sets to plot
  vtkIdType ArrayNumber;
  vtkIdType ComponentNumber;
  vtkTypeBool TitleVisibility; // Should I see the title?
  char* Title;                 // The title string
  vtkTextProperty* TitleTextProperty;
  vtkTypeBool LabelVisibility;
  vtkTextProperty* LabelTextProperty;
  vtkBarLabelArray* Labels;
  vtkTypeBool LegendVisibility;
  vtkNew<vtkLegendBoxActor> LegendActor;
  vtkGlyphSource2D* GlyphSource;
 
  // Local variables needed to plot
  vtkIdType N;      // The number of values
  double* Heights;  // The heights of each bar
  double MinHeight; // The maximum and minimum height
  double MaxHeight;
  double LowerLeft[2];
  double UpperRight[2];
 
  vtkTextMapper** BarMappers; // a label for each bar
  vtkActor2D** BarActors;
 
  vtkTextMapper* TitleMapper;
  vtkActor2D* TitleActor;
 
  vtkPolyData* PlotData; // The actual bars plus the x-axis
  vtkPolyDataMapper2D* PlotMapper;
  vtkActor2D* PlotActor;
 
  vtkAxisActor2D* YAxis; // The y-axis
  char* YTitle;
 
  vtkTimeStamp BuildTime;
 
  int LastPosition[2];
  int LastPosition2[2];
  double P1[3];
  double P2[3];
 
  void Initialize();
  int PlaceAxes(vtkViewport* viewport, const int* size);
  int BuildPlot(vtkViewport*);
 
  vtkBarChartActor(const vtkBarChartActor&) = delete;
  void operator=(const vtkBarChartActor&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif