vtkBalloonWidget.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 vtkBalloonWidget_h
#define vtkBalloonWidget_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkBalloonRepresentation;
class vtkProp;
class vtkAbstractPropPicker;
class vtkStdString;
class vtkPropMap;
class vtkImageData;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkBalloonWidget : public vtkHoverWidget
{
public:
  static vtkBalloonWidget* New();


  vtkTypeMacro(vtkBalloonWidget, vtkHoverWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetEnabled(int) override;

  void SetRepresentation(vtkBalloonRepresentation* r)
  {
    this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
  }

  vtkBalloonRepresentation* GetBalloonRepresentation()
  {
    return reinterpret_cast<vtkBalloonRepresentation*>(this->WidgetRep);
  }

  void CreateDefaultRepresentation() override;


  void AddBalloon(vtkProp* prop, vtkStdString* str, vtkImageData* img);
  void AddBalloon(vtkProp* prop, const char* str, vtkImageData* img);
  void AddBalloon(vtkProp* prop, const char* str) // for wrapping
  {
    this->AddBalloon(prop, str, nullptr);
  }
  void RemoveBalloon(vtkProp* prop);


  const char* GetBalloonString(vtkProp* prop);
  vtkImageData* GetBalloonImage(vtkProp* prop);


  void UpdateBalloonString(vtkProp* prop, const char* str);
  void UpdateBalloonImage(vtkProp* prop, vtkImageData* image);

  virtual vtkProp* GetCurrentProp() { return this->CurrentProp; }


  void SetPicker(vtkAbstractPropPicker*);
  vtkGetObjectMacro(Picker, vtkAbstractPropPicker);

  /*
   * Register internal Pickers within PickingManager
   */
  void RegisterPickers() override;

protected:
  vtkBalloonWidget();
  ~vtkBalloonWidget() override;

  // This class implements the method called from its superclass.
  int SubclassEndHoverAction() override;
  int SubclassHoverAction() override;

  // Classes for managing balloons
  vtkPropMap* PropMap; // PIMPL'd map of (vtkProp,vtkStdString)

  // Support for picking
  vtkAbstractPropPicker* Picker;

  // The vtkProp that is being hovered over (which may be nullptr)
  vtkProp* CurrentProp;

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

VTK_ABI_NAMESPACE_END
#endif