You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
120 lines
3.7 KiB
C++
120 lines
3.7 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkCaptionWidget.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkCaptionWidget
|
|
* @brief widget for placing a caption (text plus leader)
|
|
*
|
|
* This class provides support for interactively placing a caption on the 2D
|
|
* overlay plane. A caption is defined by some text with a leader (e.g.,
|
|
* arrow) that points from the text to a point in the scene. The caption is
|
|
* represented by a vtkCaptionRepresentation. It uses the event bindings of
|
|
* its superclass (vtkBorderWidget) to control the placement of the text, and
|
|
* adds the ability to move the attachment point around. In addition, when
|
|
* the caption text is selected, the widget emits a ActivateEvent that
|
|
* observers can watch for. This is useful for opening GUI dialogoues to
|
|
* adjust font characteristics, etc. (Please see the superclass for a
|
|
* description of event bindings.)
|
|
*
|
|
* Note that this widget extends the behavior of its superclass
|
|
* vtkBorderWidget. The end point of the leader can be selected and
|
|
* moved around with an internal vtkHandleWidget.
|
|
*
|
|
* @sa
|
|
* vtkBorderWidget vtkTextWidget
|
|
*/
|
|
|
|
#ifndef vtkCaptionWidget_h
|
|
#define vtkCaptionWidget_h
|
|
|
|
#include "vtkBorderWidget.h"
|
|
#include "vtkInteractionWidgetsModule.h" // For export macro
|
|
|
|
class vtkCaptionRepresentation;
|
|
class vtkCaptionActor2D;
|
|
class vtkHandleWidget;
|
|
class vtkPointHandleRepresentation3D;
|
|
class vtkCaptionAnchorCallback;
|
|
|
|
class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionWidget : public vtkBorderWidget
|
|
{
|
|
public:
|
|
/**
|
|
* Instantiate this class.
|
|
*/
|
|
static vtkCaptionWidget* New();
|
|
|
|
//@{
|
|
/**
|
|
* Standard VTK class methods.
|
|
*/
|
|
vtkTypeMacro(vtkCaptionWidget, vtkBorderWidget);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
//@}
|
|
|
|
/**
|
|
* Override superclasses' SetEnabled() method because the caption leader
|
|
* has its own dedicated widget.
|
|
*/
|
|
void SetEnabled(int enabling) override;
|
|
|
|
/**
|
|
* Specify an instance of vtkWidgetRepresentation used to represent this
|
|
* widget in the scene. Note that the representation is a subclass of vtkProp
|
|
* so it can be added to the renderer independent of the widget.
|
|
*/
|
|
void SetRepresentation(vtkCaptionRepresentation* r)
|
|
{
|
|
this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
|
|
}
|
|
|
|
//@{
|
|
/**
|
|
* Specify a vtkCaptionActor2D to manage. This is convenient, alternative
|
|
* method to SetRepresentation(). It internally create a vtkCaptionRepresentation
|
|
* and then invokes vtkCaptionRepresentation::SetCaptionActor2D().
|
|
*/
|
|
void SetCaptionActor2D(vtkCaptionActor2D* capActor);
|
|
vtkCaptionActor2D* GetCaptionActor2D();
|
|
//@}
|
|
|
|
/**
|
|
* Create the default widget representation if one is not set.
|
|
*/
|
|
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;
|
|
};
|
|
|
|
#endif
|