vtkCaptionWidget.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 vtkCaptionWidget_h
#define vtkCaptionWidget_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkCaptionRepresentation;
class vtkCaptionActor2D;
class vtkHandleWidget;
class vtkPointHandleRepresentation3D;
class vtkCaptionAnchorCallback;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkCaptionWidget : public vtkBorderWidget
{
public:
  static vtkCaptionWidget* New();


  vtkTypeMacro(vtkCaptionWidget, vtkBorderWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetEnabled(int enabling) override;

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


  void SetCaptionActor2D(vtkCaptionActor2D* capActor);
  vtkCaptionActor2D* GetCaptionActor2D();

  void CreateDefaultRepresentation() override;

protected:
  vtkCaptionWidget();
  ~vtkCaptionWidget() override;

  // Handles callbacks from the anchor point
  vtkCaptionAnchorCallback* AnchorCallback;

  // Widget for the anchor point
  vtkHandleWidget* HandleWidget;

  // Special callbacks for the anchor interaction
  void StartAnchorInteraction();
  void AnchorInteraction();
  void EndAnchorInteraction();

  friend class vtkCaptionAnchorCallback;

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

VTK_ABI_NAMESPACE_END
#endif