|
| 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...
|
| |
| 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...
|
| |
| | 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...
|
| |
| 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...
|
| |
|
| | vtkAbstractWidget () |
| |
| | ~vtkAbstractWidget () |
| |
| void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
| |
| virtual void | SetCursor (int vtkNotUsed(state)) |
| |
| | 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...
|
| |
| | 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...
|
| |
| | vtkObjectBase () |
| |
| virtual | ~vtkObjectBase () |
| |
| virtual void | CollectRevisions (ostream &) |
| |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| |
| | vtkObjectBase (const vtkObjectBase &) |
| |
| void | operator= (const vtkObjectBase &) |
| |
|
| typedef vtkObject | Superclass |
| |
| 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 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 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...
|
| |
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).
- See also
- vtkWidgetRepresentation vtkWidgetEventTranslator vtkWidgetCallbackMapper
Definition at line 63 of file vtkAbstractWidget.h.
Public Member Functions inherited from vtkInteractorObserver