define the API for widget / widget representation More...
#include <vtkAbstractWidget.h>
Public Member Functions | |
| virtual void | SetEnabled (int) |
| Methods for activating this widget. More... | |
| vtkWidgetEventTranslator * | GetEventTranslator () |
| Get the event translator. More... | |
| virtual void | CreateDefaultRepresentation ()=0 |
| Create the default widget representation if one is not set. More... | |
| void | Render () |
| This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More... | |
| void | SetParent (vtkAbstractWidget *parent) |
| Specifying a parent to this widget is used when creating composite widgets. More... | |
| virtual vtkAbstractWidget * | GetParent () |
| virtual void | SetPriority (float) |
| Override the superclass method. More... | |
| virtual void | SetProcessEvents (int) |
| Methods to change whether the widget responds to interaction. More... | |
| virtual int | GetProcessEvents () |
| Methods to change whether the widget responds to interaction. More... | |
| virtual void | ProcessEventsOn () |
| Methods to change whether the widget responds to interaction. More... | |
| virtual void | ProcessEventsOff () |
| Methods to change whether the widget responds to interaction. More... | |
| vtkWidgetRepresentation * | GetRepresentation () |
| Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More... | |
| virtual void | SetManagesCursor (int) |
| Turn on or off the management of the cursor. More... | |
| virtual int | GetManagesCursor () |
| Turn on or off the management of the cursor. More... | |
| virtual void | ManagesCursorOn () |
| Turn on or off the management of the cursor. More... | |
| virtual void | ManagesCursorOff () |
| Turn on or off the management of the cursor. More... | |
 Public Member Functions inherited from vtkInteractorObserver | |
| vtkInteractorObserver * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| int | GetEnabled () |
| void | EnabledOn () |
| void | EnabledOff () |
| void | On () |
| void | Off () |
| virtual void | OnChar () |
| Sets up the keypress-i event. More... | |
| virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor. More... | |
| virtual vtkRenderWindowInteractor * | GetInteractor () |
| This method is used to associate the widget with the render window interactor. More... | |
| virtual float | GetPriority () |
| Set/Get the priority at which events are processed. More... | |
| virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking. More... | |
| virtual void | PickingManagedOff () |
| Enable/Disable the use of a manager to process the picking. More... | |
| virtual void | SetPickingManaged (bool) |
| Enable/Disable the use of a manager to process the picking. More... | |
| virtual bool | GetPickingManaged () |
| Enable/Disable the use of a manager to process the picking. More... | |
| virtual void | SetKeyPressActivation (int) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
| virtual int | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
| virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
| virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
| virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More... | |
| virtual char | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More... | |
| virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer. More... | |
| virtual void | SetDefaultRenderer (vtkRenderer *) |
| Set/Get the default renderer to use when activating the interactor observer. More... | |
| virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer. More... | |
| virtual void | SetCurrentRenderer (vtkRenderer *) |
| Set/Get the current renderer. More... | |
| void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More... | |
| void | ReleaseFocus () |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More... | |
| Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| int | HasObserver (unsigned long event) |
| int | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Protected Member Functions | |
| vtkAbstractWidget () | |
| ~vtkAbstractWidget () | |
| void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
| virtual void | SetCursor (int vtkNotUsed(state)) |
| Protected Member Functions inherited from vtkInteractorObserver | |
| vtkInteractorObserver () | |
| ~vtkInteractorObserver () | |
| virtual void | RegisterPickers () |
| Register internal Pickers in the Picking Manager. More... | |
| void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager. More... | |
| virtual void | PickersModified () |
| Update the pickers registered in the Picking Manager when pickers are modified. More... | |
| vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong. More... | |
| vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
| Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More... | |
| int | RequestCursorShape (int requestedShape) |
| virtual void | StartInteraction () |
| Utility routines used to start and end interaction. More... | |
| virtual void | EndInteraction () |
| Utility routines used to start and end interaction. More... | |
| void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses. More... | |
| void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
| Helper method for subclasses. More... | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Static Protected Member Functions | |
| static void | ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
| Static Protected Member Functions inherited from vtkInteractorObserver | |
| static void | ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
| Handles the char widget activation event. More... | |
Additional Inherited Members | |
| Public Types inherited from vtkInteractorObserver | |
| typedef vtkObject | Superclass |
| Static Public Member Functions inherited from vtkInteractorObserver | |
| static int | IsTypeOf (const char *type) |
| static vtkInteractorObserver * | SafeDownCast (vtkObjectBase *o) |
| static void | ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4]) |
| Convenience methods for outside classes. More... | |
| static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
| Convenience methods for outside classes. More... | |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Detailed Description
define the API for widget / widget representation
The vtkAbstractWidget defines an API and implements methods common to all widgets using the interaction/representation design. In this design, the term interaction means that part of the widget that performs event handling, while the representation corresponds to a vtkProp (or the subclass vtkWidgetRepresentation) used to represent the widget. vtkAbstractWidget also implements some methods common to all subclasses.
Note that vtkAbstractWidget provides access to the vtkWidgetEventTranslator. This class is responsible for translating VTK events (defined in vtkCommand.h) into widget events (defined in vtkWidgetEvent.h). This class can be manipulated so that different VTK events can be mapped into widget events, thereby allowing the modification of event bindings. Each subclass of vtkAbstractWidget defines the events to which it responds.
- Warning
- Note that the pair ( vtkAbstractWidget / vtkWidgetRepresentation ) is an implementation of the second generation VTK Widgets design. In the first generation design, widgets were implemented in a single monolithic class. This design was problematic because in client-server application it was difficult to manage widgets properly. Also, new "representations" or look-and-feel, for a widget required a whole new class, with a lot of redundant code. The separation of the widget event handling and representation enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).
Definition at line 63 of file vtkAbstractWidget.h.
Member Typedef Documentation
Standard macros implementing standard VTK methods.
Definition at line 70 of file vtkAbstractWidget.h.
Constructor & Destructor Documentation
|
protected |
|
protected |
Member Function Documentation
|
static |
Standard macros implementing standard VTK methods.
|
virtual |
Standard macros implementing standard VTK methods.
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBalloonWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkFinitePlaneWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkCaptionWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkProgressBarWidget, vtkPlaybackWidget, vtkScalarBarWidget, vtkPolyLineWidget, and vtkSplineWidget2.
|
static |
Standard macros implementing standard VTK methods.
|
protectedvirtual |
Standard macros implementing standard VTK methods.
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBalloonWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkFinitePlaneWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkCaptionWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkProgressBarWidget, vtkPlaybackWidget, vtkScalarBarWidget, vtkPolyLineWidget, and vtkSplineWidget2.
| vtkAbstractWidget* vtkAbstractWidget::NewInstance | ( | ) | const |
Standard macros implementing standard VTK methods.
|
virtual |
Standard macros implementing standard VTK methods.
Reimplemented from vtkObject.
Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSphereWidget2, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBalloonWidget, vtkRectilinearWipeWidget, vtkAngleWidget, vtkDistanceWidget, vtkBorderWidget, vtkCenteredSliderWidget, vtkSeedWidget, vtkFinitePlaneWidget, vtkSliderWidget, vtkHoverWidget, vtkHandleWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkCaptionWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, vtkCameraWidget, vtkTensorProbeWidget, vtkTextWidget, vtkLogoWidget, vtkProgressBarWidget, vtkPlaybackWidget, vtkScalarBarWidget, vtkPolyLineWidget, and vtkSplineWidget2.
|
virtual |
Methods for activating this widget.
Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.
Reimplemented from vtkInteractorObserver.
Reimplemented in vtkContourWidget, vtkImplicitPlaneWidget2, vtkBiDimensionalWidget, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkAffineWidget, vtkBalloonWidget, vtkHoverWidget, vtkAngleWidget, vtkDistanceWidget, vtkSeedWidget, vtkResliceCursorWidget, vtkCheckerboardWidget, vtkCaptionWidget, and vtkParallelopipedWidget.
|
virtual |
Methods to change whether the widget responds to interaction.
Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
Reimplemented in vtkBiDimensionalWidget, vtkSeedWidget, vtkAngleWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkDistanceWidget, and vtkParallelopipedWidget.
|
virtual |
Methods to change whether the widget responds to interaction.
Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
virtual |
Methods to change whether the widget responds to interaction.
Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
virtual |
Methods to change whether the widget responds to interaction.
Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
inline |
Get the event translator.
Careful manipulation of this class enables the user to override the default event bindings.
Definition at line 99 of file vtkAbstractWidget.h.
|
pure virtual |
Create the default widget representation if one is not set.
The representation defines the geometry of the widget (i.e., how it appears) as well as providing special methods for manipulting the state and appearance of the widget.
Implemented in vtkContourWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkBiDimensionalWidget, vtkBorderWidget, vtkSphereWidget2, vtkSeedWidget, vtkSliderWidget, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBalloonWidget, vtkDistanceWidget, vtkAngleWidget, vtkRectilinearWipeWidget, vtkHoverWidget, vtkCenteredSliderWidget, vtkHandleWidget, vtkFinitePlaneWidget, vtkAffineWidget, vtkParallelopipedWidget, vtkCompassWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkCaptionWidget, vtkScalarBarWidget, vtkResliceCursorWidget, vtkTextWidget, vtkTensorProbeWidget, vtkCameraWidget, vtkLogoWidget, vtkProgressBarWidget, vtkPlaybackWidget, vtkPolyLineWidget, and vtkSplineWidget2.
| void vtkAbstractWidget::Render | ( | ) |
This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.
This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.
|
inline |
Specifying a parent to this widget is used when creating composite widgets.
It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).
Definition at line 124 of file vtkAbstractWidget.h.
|
virtual |
|
inline |
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresenation) so it can be added to the renderer independent of the widget.
Definition at line 134 of file vtkAbstractWidget.h.
|
virtual |
Turn on or off the management of the cursor.
Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual |
Turn on or off the management of the cursor.
Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual |
Turn on or off the management of the cursor.
Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual |
Turn on or off the management of the cursor.
Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual |
Override the superclass method.
This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary
Reimplemented from vtkInteractorObserver.
|
staticprotected |
|
protected |
|
inlineprotectedvirtual |
Definition at line 178 of file vtkAbstractWidget.h.
Member Data Documentation
|
protected |
Definition at line 174 of file vtkAbstractWidget.h.
|
protected |
Definition at line 177 of file vtkAbstractWidget.h.
|
protected |
Definition at line 181 of file vtkAbstractWidget.h.
|
protected |
Definition at line 182 of file vtkAbstractWidget.h.
|
protected |
Definition at line 185 of file vtkAbstractWidget.h.
|
protected |
Definition at line 190 of file vtkAbstractWidget.h.
|
protected |
Definition at line 194 of file vtkAbstractWidget.h.
The documentation for this class was generated from the following file:
- /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Interaction/Widgets/vtkAbstractWidget.h
