vtkBlockItem.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 vtkBlockItem_h
#define vtkBlockItem_h

#include "vtkContextItem.h"
#include "vtkNew.h"                      // For vtkNew
#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkStdString.h"                // For vtkStdString ivars
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkContext2D;
class vtkTextProperty;
class vtkBrush;
class vtkPen;

class VTKRENDERINGCONTEXT2D_EXPORT VTK_MARSHALAUTO vtkBlockItem : public vtkContextItem
{
public:
  vtkTypeMacro(vtkBlockItem, vtkContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkBlockItem* New();

  bool Paint(vtkContext2D* painter) override;

  bool Hit(const vtkContextMouseEvent& mouse) override;

  bool MouseEnterEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseLeaveEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonPressEvent(const vtkContextMouseEvent& mouse) override;

  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& mouse) override;

  virtual void SetLabel(const vtkStdString& label);

  virtual vtkStdString GetLabel();


  vtkSetVector4Macro(Dimensions, float);


  vtkGetVector4Macro(Dimensions, float);


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

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


  vtkSetMacro(HorizontalAlignment, int);
  vtkGetMacro(HorizontalAlignment, int);


  vtkSetMacro(VerticalAlignment, int);
  vtkGetMacro(VerticalAlignment, int);


  vtkSetVector2Macro(Padding, int);
  vtkGetVector2Macro(Padding, int);


  vtkSetVector2Macro(Margins, int);
  vtkGetVector2Macro(Margins, int);


  vtkGetObjectMacro(Pen, vtkPen);


  vtkGetObjectMacro(Brush, vtkBrush);


  vtkGetObjectMacro(MouseOverBrush, vtkBrush);


  void SetLabelProperties(vtkTextProperty*);
  vtkGetObjectMacro(LabelProperties, vtkTextProperty);

  void SetScalarFunctor(double (*scalarFunction)(double, double));

protected:
  vtkBlockItem();
  ~vtkBlockItem() override;

  float Dimensions[4];

  vtkStdString Label;

  bool MouseOver;

  // Some function pointers to optionally do funky things...
  double (*scalarFunction)(double, double);

private:
  vtkBlockItem(const vtkBlockItem&) = delete;
  void operator=(const vtkBlockItem&) = delete;

  vtkTextProperty* LabelProperties;
  vtkNew<vtkTextProperty> CachedTextProp;

  vtkNew<vtkPen> Pen;
  vtkNew<vtkPen> CachedPen;

  vtkNew<vtkBrush> Brush;
  vtkNew<vtkBrush> MouseOverBrush;
  vtkNew<vtkBrush> CachedBrush;

  int HorizontalAlignment;
  int VerticalAlignment;
  bool AutoComputeDimensions;
  int Padding[2];
  int Margins[2];
};

VTK_ABI_NAMESPACE_END
#endif // vtkBlockItem_h