vtkCaptionWidget Class Reference
#include <vtkCaptionWidget.h>
Detailed Description
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.
- See also:
- vtkBorderWidget vtkTextWidget
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Tests:
- vtkCaptionWidget (Tests)
Definition at line 55 of file vtkCaptionWidget.h.
| typedef vtkBorderWidget | Superclass |
| static int | IsTypeOf (const char *type) |
| static vtkCaptionWidget * | SafeDownCast (vtkObject *o) |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Public Member Functions | |
| virtual void | SetEnabled (int enabling) |
| void | CreateDefaultRepresentation () |
| void | SetRepresentation (vtkCaptionRepresentation *r) |
| void | SetCaptionActor2D (vtkCaptionActor2D *capActor) |
| vtkCaptionActor2D * | GetCaptionActor2D () |
Static Public Member Functions | |
| static vtkCaptionWidget * | New () |
Protected Member Functions | |
| vtkCaptionWidget () | |
| ~vtkCaptionWidget () | |
| void | StartAnchorInteraction () |
| void | AnchorInteraction () |
| void | EndAnchorInteraction () |
Protected Attributes | |
| vtkCaptionAnchorCallback * | AnchorCallback |
| vtkHandleWidget * | HandleWidget |
Friends | |
| class | vtkCaptionAnchorCallback |
Member Typedef Documentation
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
Definition at line 63 of file vtkCaptionWidget.h.
Constructor & Destructor Documentation
| vtkCaptionWidget::vtkCaptionWidget | ( | ) | [protected] |
| vtkCaptionWidget::~vtkCaptionWidget | ( | ) | [protected] |
Member Function Documentation
| static vtkCaptionWidget* vtkCaptionWidget::New | ( | ) | [static] |
Instantiate this class.
Reimplemented from vtkBorderWidget.
| virtual const char* vtkCaptionWidget::GetClassName | ( | ) | [virtual] |
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
| static int vtkCaptionWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
| virtual int vtkCaptionWidget::IsA | ( | const char * | type | ) | [virtual] |
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
| static vtkCaptionWidget* vtkCaptionWidget::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
| void vtkCaptionWidget::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard VTK class methods.
Reimplemented from vtkBorderWidget.
| virtual void vtkCaptionWidget::SetEnabled | ( | int | enabling | ) | [virtual] |
Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.
Reimplemented from vtkAbstractWidget.
| void vtkCaptionWidget::SetRepresentation | ( | vtkCaptionRepresentation * | r | ) | [inline] |
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.
Definition at line 75 of file vtkCaptionWidget.h.
| void vtkCaptionWidget::SetCaptionActor2D | ( | vtkCaptionActor2D * | capActor | ) |
Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().
| vtkCaptionActor2D* vtkCaptionWidget::GetCaptionActor2D | ( | ) |
Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().
| void vtkCaptionWidget::CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set.
Reimplemented from vtkBorderWidget.
| void vtkCaptionWidget::StartAnchorInteraction | ( | ) | [protected] |
| void vtkCaptionWidget::AnchorInteraction | ( | ) | [protected] |
| void vtkCaptionWidget::EndAnchorInteraction | ( | ) | [protected] |
Friends And Related Function Documentation
friend class vtkCaptionAnchorCallback [friend] |
Definition at line 107 of file vtkCaptionWidget.h.
Member Data Documentation
vtkCaptionAnchorCallback* vtkCaptionWidget::AnchorCallback [protected] |
Definition at line 96 of file vtkCaptionWidget.h.
vtkHandleWidget* vtkCaptionWidget::HandleWidget [protected] |
Definition at line 99 of file vtkCaptionWidget.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkCaptionWidget.h
