vtkScivisScalarBars.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 vtkScivisScalarBars_h
#define vtkScivisScalarBars_h
 
#include "vtkObject.h"
#include "vtkViewsScivisModule.h" // For export macro
#include "vtkWeakPointer.h"       // For ivar
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkScalarBarActor;
class vtkScalarBarWidget;
class vtkScivisView;
 
class VTKVIEWSSCIVIS_EXPORT VTK_MARSHALAUTO vtkScivisScalarBars : public vtkObject
{
public:
  static vtkScivisScalarBars* New();
  vtkTypeMacro(vtkScivisScalarBars, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkMTimeType GetMTime() override;


  void SetAutoVisibility(bool val);
  bool GetAutoVisibility();
  vtkBooleanMacro(AutoVisibility, bool);


  void SetDraggable(bool val);
  bool GetDraggable();
  vtkBooleanMacro(Draggable, bool);

  int GetNumberOfBars();


  const char* GetArrayName(int index);
  int GetFieldAssociation(int index);


  vtkScalarBarActor* GetActor(int index);
  vtkScalarBarActor* GetActor(const char* arrayName, int fieldAssoc);

  vtkScalarBarWidget* GetWidget(int index);
 
protected:
  vtkScivisScalarBars();
  ~vtkScivisScalarBars() override;
 
private:
  friend class vtkScivisView;
 
  // Held weakly, as the other components hold it: these are reached through the
  // view, but Python can outlive it.
  void SetView(vtkScivisView* view);

  void Update();

  void Position();

  void UpdateWidgets();

  void OnDragged(vtkObject* caller, unsigned long event, void* data);
 
  vtkScivisScalarBars(const vtkScivisScalarBars&) = delete;
  void operator=(const vtkScivisScalarBars&) = delete;
 
  vtkWeakPointer<vtkScivisView> View;
  bool AutoVisibility;
  bool Draggable;
 
  class Internals;
  Internals* Implementation;
};
 
VTK_ABI_NAMESPACE_END
#endif