vtkScalarBarWidget.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 vtkScalarBarWidget_h
#define vtkScalarBarWidget_h

#include "vtkBorderWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkScalarBarActor;
class vtkScalarBarRepresentation;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkScalarBarWidget : public vtkBorderWidget
{
public:
  static vtkScalarBarWidget* New();
  vtkTypeMacro(vtkScalarBarWidget, vtkBorderWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetRepresentation(vtkScalarBarRepresentation* rep);

  vtkScalarBarRepresentation* GetScalarBarRepresentation()
  {
    return reinterpret_cast<vtkScalarBarRepresentation*>(this->GetRepresentation());
  }


  virtual void SetScalarBarActor(vtkScalarBarActor* actor);
  virtual vtkScalarBarActor* GetScalarBarActor();


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

  void CreateDefaultRepresentation() override;

  vtkTypeBool GetProcessEvents() override;

protected:
  vtkScalarBarWidget();
  ~vtkScalarBarWidget() override;

  vtkTypeBool Repositionable;

  // Handle the case of Repositionable == 0
  static void MoveAction(vtkAbstractWidget*);

  // set the cursor to the correct shape based on State argument
  void SetCursor(int State) override;

private:
  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
  void operator=(const vtkScalarBarWidget&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif