vtkChartLegend.h

Go to the documentation of this file.

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

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

#include "vtkChartsCoreModule.h" // For export macro
#include "vtkContextItem.h"
#include "vtkNew.h"         // For vtkNew
#include "vtkRect.h"        // For vtkRectf return value

class vtkChart;
class vtkPen;
class vtkBrush;
class vtkTextProperty;

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

  static vtkChartLegend *New();


  vtkSetVector2Macro(Point, float);


  vtkGetVector2Macro(Point, float);

  enum {
    LEFT = 0,
    CENTER,
    RIGHT,
    TOP,
    BOTTOM,
    CUSTOM
  };

  void SetPoint(const vtkVector2f &point);

  const vtkVector2f& GetPointVector();


  vtkSetMacro(HorizontalAlignment, int);


  vtkGetMacro(HorizontalAlignment, int);


  vtkSetMacro(VerticalAlignment, int);


  vtkGetMacro(VerticalAlignment, int);


  vtkSetMacro(Padding, int);


  vtkGetMacro(Padding, int);


  vtkSetMacro(SymbolWidth, int);


  vtkGetMacro(SymbolWidth, int);

  virtual void SetLabelSize(int size);

  virtual int GetLabelSize();


  vtkSetMacro(Inline, bool);
  vtkGetMacro(Inline, bool);


  vtkSetMacro(DragEnabled, bool);
  vtkGetMacro(DragEnabled, bool);

  void SetChart(vtkChart* chart);

  vtkChart* GetChart();

  virtual void Update();

  virtual bool Paint(vtkContext2D *painter);

  virtual vtkRectf GetBoundingRect(vtkContext2D* painter);

  vtkPen * GetPen();

  vtkBrush * GetBrush();

  vtkTextProperty * GetLabelProperties();


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

  virtual bool Hit(const vtkContextMouseEvent &mouse);

  virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse);

protected:
  vtkChartLegend();
  ~vtkChartLegend();

  float* Point;  // The point the legend is anchored to.
  int HorizontalAlignment; // Alignment of the legend to the point it is anchored to.
  int VerticalAlignment; // Alignment of the legend to the point it is anchored to.

  vtkNew<vtkPen> Pen;

  vtkNew<vtkBrush> Brush;

  vtkNew<vtkTextProperty> LabelProperties;

  bool DragEnabled;

  bool CacheBounds;

  int Button;

  vtkTimeStamp PlotTime;
  vtkTimeStamp RectTime;

  vtkRectf Rect;

  int Padding;

  int SymbolWidth;

  bool Inline;

  // Private storage class
  class Private;
  Private* Storage;

private:
  vtkChartLegend(const vtkChartLegend &) VTK_DELETE_FUNCTION;
  void operator=(const vtkChartLegend &) VTK_DELETE_FUNCTION;
};

#endif //vtkChartLegend_h