|
void | SetRepresentation (vtkBorderRepresentation *r) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
|
|
vtkBorderRepresentation * | GetBorderRepresentation () |
| Return the representation as a vtkBorderRepresentation.
|
|
void | CreateDefaultRepresentation () override |
| Create the default widget representation if one is not set.
|
|
|
virtual void | SetSelectable (vtkTypeBool) |
| Indicate whether the interior region of the widget can be selected or not.
|
|
virtual vtkTypeBool | GetSelectable () |
| Indicate whether the interior region of the widget can be selected or not.
|
|
virtual void | SelectableOn () |
| Indicate whether the interior region of the widget can be selected or not.
|
|
virtual void | SelectableOff () |
| Indicate whether the interior region of the widget can be selected or not.
|
|
|
virtual void | SetResizable (vtkTypeBool) |
| Indicate whether the boundary of the widget can be resized.
|
|
virtual vtkTypeBool | GetResizable () |
| Indicate whether the boundary of the widget can be resized.
|
|
virtual void | ResizableOn () |
| Indicate whether the boundary of the widget can be resized.
|
|
virtual void | ResizableOff () |
| Indicate whether the boundary of the widget can be resized.
|
|
void | SetEnabled (int) override |
| Methods for activating this widget.
|
|
vtkWidgetEventTranslator * | GetEventTranslator () |
| Get the event translator.
|
|
virtual void | CreateDefaultRepresentation ()=0 |
| Create the default widget representation if one is not set.
|
|
void | Render () |
| This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.
|
|
void | SetParent (vtkAbstractWidget *parent) |
| Specifying a parent to this widget is used when creating composite widgets.
|
|
virtual vtkAbstractWidget * | GetParent () |
|
void | SetPriority (float) override |
| Override the superclass method.
|
|
virtual void | SetProcessEvents (vtkTypeBool) |
| Methods to change whether the widget responds to interaction.
|
|
virtual vtkTypeBool | GetProcessEvents () |
| Methods to change whether the widget responds to interaction.
|
|
virtual void | ProcessEventsOn () |
| Methods to change whether the widget responds to interaction.
|
|
virtual void | ProcessEventsOff () |
| Methods to change whether the widget responds to interaction.
|
|
vtkWidgetRepresentation * | GetRepresentation () |
| Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
|
|
virtual void | SetManagesCursor (vtkTypeBool) |
| Turn on or off the management of the cursor.
|
|
virtual vtkTypeBool | GetManagesCursor () |
| Turn on or off the management of the cursor.
|
|
virtual void | ManagesCursorOn () |
| Turn on or off the management of the cursor.
|
|
virtual void | ManagesCursorOff () |
| Turn on or off the management of the cursor.
|
|
vtkAbstractWidget * | NewInstance () const |
| Standard macros implementing standard VTK methods.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetEnabled (int) |
| Methods for turning the interactor observer on and off, and determining its state.
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | OnChar () |
| Sets up the keypress-i event.
|
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor.
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
| This method is used to associate the widget with the render window interactor.
|
|
virtual float | GetPriority () |
| Set/Get the priority at which events are processed.
|
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | PickingManagedOff () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetPickingManaged (bool managed) |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual bool | GetPickingManaged () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual char | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer.
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
| Set/Get the current renderer.
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
void | ReleaseFocus () |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on.
|
|
virtual void | DebugOff () |
| Turn debugging output off.
|
|
bool | GetDebug () |
| Get the value of the debug flag.
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag.
|
|
virtual void | Modified () |
| Update the modification time for this object.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | 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.
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
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.
|
|
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.
|
|
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.
|
|
int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
virtual void | Delete () |
| Delete a VTK object.
|
|
virtual void | FastDelete () |
| Delete a reference to this object.
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream.
|
|
virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object).
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object).
|
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
|
void | SetReferenceCount (int) |
| Sets the reference count.
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space.
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
|
static vtkBorderWidget * | New () |
| Method to instantiate class.
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
| Standard macros implementing standard VTK methods.
|
|
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
| Standard macros implementing standard VTK methods.
|
|
static vtkTypeBool | 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.
|
|
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
| Convenience methods for outside classes.
|
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes.
|
|
static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class.
|
|
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | SetMemkindDirectory (const char *directoryname) |
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
|
static bool | GetUsingMemkind () |
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
|
|
| vtkBorderWidget () |
|
| ~vtkBorderWidget () override |
|
virtual void | SelectRegion (double eventPos[2]) |
| Subclasses generally implement this method.
|
|
virtual int | SubclassSelectAction () |
|
virtual int | SubclassTranslateAction () |
|
virtual int | SubclassEndSelectAction () |
|
virtual int | SubclassMoveAction () |
|
void | SetCursor (int State) override |
|
| vtkAbstractWidget () |
|
| ~vtkAbstractWidget () override |
|
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
|
virtual void | SetCursor (int vtkNotUsed(state)) |
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkInteractorObserver () |
|
| ~vtkInteractorObserver () override |
|
virtual void | RegisterPickers () |
| Register internal Pickers in the Picking Manager.
|
|
void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager.
|
|
vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong.
|
|
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.
|
|
int | RequestCursorShape (int requestedShape) |
|
virtual void | StartInteraction () |
| Utility routines used to start and end interaction.
|
|
virtual void | EndInteraction () |
| Utility routines used to start and end interaction.
|
|
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses.
|
|
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
| Helper method for subclasses.
|
|
| vtkObject () |
|
| ~vtkObject () override |
|
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events.
|
|
void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events.
|
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
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)
- See also
- vtkInteractorObserver vtkCameraInterpolator
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::WidgetActivateEvent
- Online Examples:
- Tests:
- vtkBorderWidget (Tests)
Definition at line 146 of file vtkBorderWidget.h.