|
| void | SetEnabled (int) override |
| | The method for activating and deactivating this widget.
|
| |
| void | SetRepresentation (vtkBiDimensionalRepresentation *r) |
| | Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
|
| |
| vtkBiDimensionalRepresentation * | GetBiDimensionalRepresentation () |
| | Return the representation as a vtkBiDimensionalRepresentation.
|
| |
| void | CreateDefaultRepresentation () override |
| | Create the default widget representation if one is not set.
|
| |
| int | IsMeasureValid () |
| | A flag indicates whether the bi-dimensional measure is valid.
|
| |
| void | SetProcessEvents (vtkTypeBool) override |
| | Methods to change the whether the widget responds to interaction.
|
| |
| virtual int | GetWidgetState () |
| | Return the current widget state.
|
| |
|
| virtual void | SetWidgetStateToStart () |
| | Set the state of the widget.
|
| |
| virtual void | SetWidgetStateToManipulate () |
| | Set the state of the widget.
|
| |
| 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 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) |
| |
| vtkTypeBool | InvokeEvent (unsigned long event) |
| |
| vtkTypeBool | InvokeEvent (const char *event) |
| |
| std::string | GetObjectDescription () const override |
| | The object description printed in messages and PrintSelf output.
|
| |
| 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.
|
| |
| vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| virtual void | SetObjectName (const std::string &objectName) |
| | Set/get the name of this object for reporting purposes.
|
| |
| virtual std::string | GetObjectName () const |
| | Set/get the name of this object for reporting purposes.
|
| |
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| |
| virtual std::string | GetObjectDescription () const |
| | The object description printed in messages and PrintSelf output.
|
| |
| 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.
|
| |
| 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.
|
| |
| virtual bool | UsesGarbageCollector () const |
| | Indicate whether the class uses vtkGarbageCollector or not.
|
| |
|
| static vtkBiDimensionalWidget * | New () |
| | Instantiate this 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 (vtkTypeBool 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 vtkTypeBool | 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.
|
| |
measure the bi-dimensional lengths of an object
The vtkBiDimensionalWidget is used to measure the bi-dimensional length of an object. The bi-dimensional measure is defined by two finite, orthogonal lines that intersect within the finite extent of both lines. The lengths of these two lines gives the bi-dimensional measure. Each line is defined by two handle widgets at the end points of each line.
The orthogonal constraint on the two lines limits how the four end points can be positioned. The first two points can be placed arbitrarily to define the first line (similar to vtkDistanceWidget). The placement of the third point is limited by the finite extent of the first line. As the third point is placed, the fourth point is placed on the opposite side of the first line. Once the third point is placed, the second line is defined since the fourth point is defined at the same time, but the fourth point can be moved along the second line (i.e., maintaining the orthogonal relationship between the two lines). Once defined, any of the four points can be moved along their constraint lines. Also, each line can be translated along the other line (in an orthogonal direction), and the whole bi-dimensional widget can be rotated about its center point (see the description of the event bindings). Finally, selecting the point where the two orthogonal axes intersect, the entire widget can be translated in any direction.
Placement of any point results in a special PlacePointEvent invocation so that special operations may be performed to reposition the point. Motion of any point, moving the lines, or rotating the widget cause InteractionEvents to be invoked. Note that the widget has two fundamental modes: a define mode (when initially placing the points) and a manipulate mode (after the points are placed). Line translation and rotation are only possible in manipulate mode.
To use this widget, specify an instance of vtkBiDimensionalWidget and a representation (e.g., vtkBiDimensionalRepresentation2D). The widget is implemented using four instances of vtkHandleWidget which are used to position the end points of the two intersecting lines. The representations for these handle widgets are provided by the vtkBiDimensionalRepresentation class.
- Event Bindings:
- By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
LeftButtonPressEvent - define a point or manipulate a handle, line,
perform rotation or translate the widget.
MouseMoveEvent - position the points, move a line, rotate or translate the widget
LeftButtonReleaseEvent - release the selected handle and end interaction
- Event Bindings:
- Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBiDimensionalWidget's widget events:
vtkWidgetEvent::AddPoint -- (In Define mode:) Add one point; depending on the
state it may the first, second, third or fourth
point added. (In Manipulate mode:) If near a handle,
select the handle. Or if near a line, select the line.
vtkWidgetEvent::Move -- (In Define mode:) Position the second, third or fourth
point. (In Manipulate mode:) Move the handle, line or widget.
vtkWidgetEvent::EndSelect -- the manipulation process has completed.
- Event Bindings:
- This widget invokes the following VTK events on itself (which observers can listen for):
vtkCommand::StartInteractionEvent (beginning to interact)
vtkCommand::EndInteractionEvent (completing interaction)
vtkCommand::InteractionEvent (moving a handle, line or performing rotation)
vtkCommand::PlacePointEvent (after a point is positioned;
call data includes handle id (0,1,2,4))
- See also
- vtkHandleWidget vtkDistanceWidget
- Events:
- vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::PlacePointEvent vtkCommand::StartInteractionEvent
- Online Examples:
- Tests:
- vtkBiDimensionalWidget (Tests)
Definition at line 119 of file vtkBiDimensionalWidget.h.
Public Types inherited from vtkAbstractWidget
1.9.7
