place a border around a 2D rectangular region More...
#include <vtkBorderWidget.h>
Detailed Description
place a border around a 2D rectangular region
This class is a superclass for 2D widgets that may require a rectangular border. Besides drawing a border, the widget provides methods for resizing and moving the rectangular region (and associated border). The widget provides methods and internal data members so that subclasses can take advantage of this widgets capabilities, requiring only that the subclass defines a "representation", i.e., some combination of props or actors that can be managed in the 2D rectangular region.
The class defines basic positioning functionality, including the ability to size the widget with locked x/y proportions. The area within the border may be made "selectable" as well, meaning that a selection event interior to the widget invokes a virtual SelectRegion() method, which can be used to pick objects or otherwise manipulate data interior to the widget.
- Event Bindings:
- By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
On the boundary of the widget: LeftButtonPressEvent - select boundary LeftButtonReleaseEvent - deselect boundary MouseMoveEvent - move/resize widget depending on which portion of the boundary was selected. On the interior of the widget: LeftButtonPressEvent - invoke SelectButton() callback (if the ivar Selectable is on) Anywhere on the widget: MiddleButtonPressEvent - move the widget
- Event Bindings:
- Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBorderWidget's widget events:
vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Translate -- the widget is to be translated vtkWidgetEvent::Move -- a request for slider motion has been invoked
- Event Bindings:
- In turn, when these widget events are processed, this widget invokes the following VTK events on itself (which observers can listen for):
vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::WidgetActivateEvent
- Tests:
- vtkBorderWidget (Tests)
Definition at line 87 of file vtkBorderWidget.h.
Member Typedef Documentation
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
Definition at line 95 of file vtkBorderWidget.h.
Member Enumeration Documentation
enum vtkBorderWidget::_WidgetState [protected] |
Definition at line 169 of file vtkBorderWidget.h.
Constructor & Destructor Documentation
| vtkBorderWidget::vtkBorderWidget | ( | ) | [protected] |
| vtkBorderWidget::~vtkBorderWidget | ( | ) | [protected] |
Member Function Documentation
| static vtkBorderWidget* vtkBorderWidget::New | ( | ) | [static] |
Method to instantiate class.
Reimplemented from vtkObject.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| static int vtkBorderWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| virtual int vtkBorderWidget::IsA | ( | const char * | type | ) | [virtual] |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| static vtkBorderWidget* vtkBorderWidget::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| virtual vtkObjectBase* vtkBorderWidget::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| vtkBorderWidget* vtkBorderWidget::NewInstance | ( | ) | const |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| void vtkBorderWidget::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Standard methods for class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.
| virtual void vtkBorderWidget::SetSelectable | ( | int | ) | [virtual] |
Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
| virtual int vtkBorderWidget::GetSelectable | ( | ) | [virtual] |
Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
| virtual void vtkBorderWidget::SelectableOn | ( | ) | [virtual] |
Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
| virtual void vtkBorderWidget::SelectableOff | ( | ) | [virtual] |
Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.
| virtual void vtkBorderWidget::SetResizable | ( | int | ) | [virtual] |
Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
| virtual int vtkBorderWidget::GetResizable | ( | ) | [virtual] |
Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
| virtual void vtkBorderWidget::ResizableOn | ( | ) | [virtual] |
Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
| virtual void vtkBorderWidget::ResizableOff | ( | ) | [virtual] |
Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.
| void vtkBorderWidget::SetRepresentation | ( | vtkBorderRepresentation * | 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 124 of file vtkBorderWidget.h.
Return the representation as a vtkBorderRepresentation.
Definition at line 130 of file vtkBorderWidget.h.
| virtual void vtkBorderWidget::CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.
Reimplemented in vtkCaptionWidget, vtkScalarBarWidget, vtkTextWidget, vtkCameraWidget, vtkLogoWidget, and vtkPlaybackWidget.
| virtual void vtkBorderWidget::SelectRegion | ( | double | eventPos[2] | ) | [protected, virtual] |
Subclasses generally implement this method. The SelectRegion() method offers a subclass the chance to do something special if the interior of the widget is selected.
Reimplemented in vtkCameraWidget, and vtkPlaybackWidget.
| static void vtkBorderWidget::SelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkBorderWidget::TranslateAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkBorderWidget::EndSelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkBorderWidget::MoveAction | ( | vtkAbstractWidget * | ) | [static, protected] |
Reimplemented in vtkScalarBarWidget.
| virtual int vtkBorderWidget::SubclassSelectAction | ( | ) | [inline, protected, virtual] |
Definition at line 158 of file vtkBorderWidget.h.
| virtual int vtkBorderWidget::SubclassTranslateAction | ( | ) | [inline, protected, virtual] |
Definition at line 159 of file vtkBorderWidget.h.
| virtual int vtkBorderWidget::SubclassEndSelectAction | ( | ) | [inline, protected, virtual] |
Definition at line 160 of file vtkBorderWidget.h.
| virtual int vtkBorderWidget::SubclassMoveAction | ( | ) | [inline, protected, virtual] |
Definition at line 161 of file vtkBorderWidget.h.
| virtual void vtkBorderWidget::SetCursor | ( | int | State | ) | [protected, virtual] |
Reimplemented in vtkScalarBarWidget.
Member Data Documentation
int vtkBorderWidget::Selectable [protected] |
Definition at line 147 of file vtkBorderWidget.h.
int vtkBorderWidget::Resizable [protected] |
Definition at line 148 of file vtkBorderWidget.h.
int vtkBorderWidget::WidgetState [protected] |
Definition at line 168 of file vtkBorderWidget.h.
The documentation for this class was generated from the following file:
- dox/Interaction/Widgets/vtkBorderWidget.h
