Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkBiDimensionalWidget Class Reference

measure the bi-dimensional lengths of an object More...

#include <vtkBiDimensionalWidget.h>

Inheritance diagram for vtkBiDimensionalWidget:
Collaboration diagram for vtkBiDimensionalWidget:

Public Types

enum  { EndWidgetSelectEvent = 10050 }
 Events. More...
enum  { Start = 0, Define, Manipulate }
 Enum defining the state of the widget. More...
typedef vtkAbstractWidget Superclass
 Standard methods for a VTK class. More...
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkBiDimensionalWidgetNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
void SetEnabled (int) override
 The method for activating and deactivating this widget. More...
void SetRepresentation (vtkBiDimensionalRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
vtkBiDimensionalRepresentationGetBiDimensionalRepresentation ()
 Return the representation as a vtkBiDimensionalRepresentation. More...
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
int IsMeasureValid ()
 A flag indicates whether the bi-dimensional measure is valid. More...
void SetProcessEvents (vtkTypeBool) override
 Methods to change the whether the widget responds to interaction. More...
virtual void SetWidgetStateToStart ()
 Set the state of the widget. More...
virtual void SetWidgetStateToManipulate ()
virtual int GetWidgetState ()
 Return the current widget state. More...
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
virtual vtkTypeBool GetProcessEvents ()
virtual void ProcessEventsOn ()
virtual void ProcessEventsOff ()
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. 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 vtkAbstractWidgetGetParent ()
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor. More...
virtual vtkTypeBool GetManagesCursor ()
virtual void ManagesCursorOn ()
virtual void ManagesCursorOff ()
void SetPriority (float) override
 Override the superclass method. More...
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 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 SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
virtual vtkRenderWindowInteractorGetInteractor ()
virtual float GetPriority ()
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
virtual void PickingManagedOff ()
virtual void SetPickingManaged (bool managed)
virtual bool GetPickingManaged ()
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual vtkTypeBool GetKeyPressActivation ()
virtual void KeyPressActivationOn ()
virtual void KeyPressActivationOff ()
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 ()
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
virtual void SetCurrentRenderer (vtkRenderer *)
virtual void OnChar ()
 Sets up the keypress-i event. More...
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
void ReleaseFocus ()
- 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...
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)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool HasObserver (const char *event, vtkCommand *)
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)
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)
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)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- 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 PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
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...

Static Public Member Functions

static vtkBiDimensionalWidgetNew ()
 Instantiate this class. More...
static vtkTypeBool IsTypeOf (const char *type)
static vtkBiDimensionalWidgetSafeDownCast (vtkObjectBase *o)
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
static vtkInteractorObserverSafeDownCast (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])
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkBiDimensionalWidget ()
 ~vtkBiDimensionalWidget () override
void StartBiDimensionalInteraction ()
virtual void EndBiDimensionalInteraction ()
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 ~vtkAbstractWidget () override
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
virtual void SetCursor (int vtkNotUsed(state))
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 ~vtkInteractorObserver () override
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
virtual void EndInteraction ()
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])
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
vtkAssemblyPathGetAssemblyPath (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)
- 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
void InternalReleaseFocus ()
- 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 AddPointAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)
- Static Protected Member Functions inherited from vtkAbstractWidget
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...

Protected Attributes

int WidgetState
int CurrentHandle
int HandleLine1Selected
int HandleLine2Selected
int Line1InnerSelected
int Line1OuterSelected
int Line2InnerSelected
int Line2OuterSelected
int CenterSelected
- Protected Attributes inherited from vtkAbstractWidget
vtkTypeBool ManagesCursor
void * CallData
vtkTypeBool ProcessEvents
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
float Priority
bool PickingManaged
vtkTypeBool KeyPressActivation
char KeyPressActivationValue
unsigned long CharObserverTag
unsigned long DeleteObserverTag
- Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers


class vtkBiDimensionalWidgetCallback

Detailed Description

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

Definition at line 104 of file vtkBiDimensionalWidget.h.

Member Typedef Documentation

◆ Superclass

Standard methods for a VTK class.

Definition at line 116 of file vtkBiDimensionalWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum



Definition at line 159 of file vtkBiDimensionalWidget.h.

◆ anonymous enum

anonymous enum

Enum defining the state of the widget.

By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state.


Definition at line 176 of file vtkBiDimensionalWidget.h.

Constructor & Destructor Documentation

◆ vtkBiDimensionalWidget()

vtkBiDimensionalWidget::vtkBiDimensionalWidget ( )

◆ ~vtkBiDimensionalWidget()

vtkBiDimensionalWidget::~vtkBiDimensionalWidget ( )

Member Function Documentation

◆ New()

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::New ( )

Instantiate this class.

◆ IsTypeOf()

static vtkTypeBool vtkBiDimensionalWidget::IsTypeOf ( const char *  type)

◆ IsA()

virtual vtkTypeBool vtkBiDimensionalWidget::IsA ( const char *  name)

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::SafeDownCast ( vtkObjectBase o)

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBiDimensionalWidget::NewInstanceInternal ( ) const

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkBiDimensionalWidget* vtkBiDimensionalWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkBiDimensionalWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

void vtkBiDimensionalWidget::SetEnabled ( int  )

The method for activating and deactivating this widget.

This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

void vtkBiDimensionalWidget::SetRepresentation ( vtkBiDimensionalRepresentation r)

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 132 of file vtkBiDimensionalWidget.h.

◆ GetBiDimensionalRepresentation()

vtkBiDimensionalRepresentation* vtkBiDimensionalWidget::GetBiDimensionalRepresentation ( )

Return the representation as a vtkBiDimensionalRepresentation.

Definition at line 140 of file vtkBiDimensionalWidget.h.

◆ CreateDefaultRepresentation()

void vtkBiDimensionalWidget::CreateDefaultRepresentation ( )

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ IsMeasureValid()

int vtkBiDimensionalWidget::IsMeasureValid ( )

A flag indicates whether the bi-dimensional measure is valid.

The widget becomes valid after two of the four points are placed.

◆ SetProcessEvents()

void vtkBiDimensionalWidget::SetProcessEvents ( vtkTypeBool  )

Methods to change the whether the widget responds to interaction.

Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

◆ SetWidgetStateToStart()

virtual void vtkBiDimensionalWidget::SetWidgetStateToStart ( )

Set the state of the widget.

If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.

◆ SetWidgetStateToManipulate()

virtual void vtkBiDimensionalWidget::SetWidgetStateToManipulate ( )

◆ GetWidgetState()

virtual int vtkBiDimensionalWidget::GetWidgetState ( )

Return the current widget state.

Definition at line 201 of file vtkBiDimensionalWidget.h.

◆ AddPointAction()

static void vtkBiDimensionalWidget::AddPointAction ( vtkAbstractWidget )

◆ MoveAction()

static void vtkBiDimensionalWidget::MoveAction ( vtkAbstractWidget )

◆ EndSelectAction()

static void vtkBiDimensionalWidget::EndSelectAction ( vtkAbstractWidget )

◆ StartBiDimensionalInteraction()

void vtkBiDimensionalWidget::StartBiDimensionalInteraction ( )

◆ EndBiDimensionalInteraction()

virtual void vtkBiDimensionalWidget::EndBiDimensionalInteraction ( )

Friends And Related Function Documentation

◆ vtkBiDimensionalWidgetCallback

friend class vtkBiDimensionalWidgetCallback

Definition at line 239 of file vtkBiDimensionalWidget.h.

Member Data Documentation

◆ WidgetState

int vtkBiDimensionalWidget::WidgetState

Definition at line 208 of file vtkBiDimensionalWidget.h.

◆ CurrentHandle

int vtkBiDimensionalWidget::CurrentHandle

Definition at line 209 of file vtkBiDimensionalWidget.h.

◆ HandleLine1Selected

int vtkBiDimensionalWidget::HandleLine1Selected

Definition at line 210 of file vtkBiDimensionalWidget.h.

◆ HandleLine2Selected

int vtkBiDimensionalWidget::HandleLine2Selected

Definition at line 211 of file vtkBiDimensionalWidget.h.

◆ Line1InnerSelected

int vtkBiDimensionalWidget::Line1InnerSelected

Definition at line 212 of file vtkBiDimensionalWidget.h.

◆ Line1OuterSelected

int vtkBiDimensionalWidget::Line1OuterSelected

Definition at line 213 of file vtkBiDimensionalWidget.h.

◆ Line2InnerSelected

int vtkBiDimensionalWidget::Line2InnerSelected

Definition at line 214 of file vtkBiDimensionalWidget.h.

◆ Line2OuterSelected

int vtkBiDimensionalWidget::Line2OuterSelected

Definition at line 215 of file vtkBiDimensionalWidget.h.

◆ CenterSelected

int vtkBiDimensionalWidget::CenterSelected

Definition at line 216 of file vtkBiDimensionalWidget.h.

◆ Point1Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point1Widget

Definition at line 225 of file vtkBiDimensionalWidget.h.

◆ Point2Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point2Widget

Definition at line 226 of file vtkBiDimensionalWidget.h.

◆ Point3Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point3Widget

Definition at line 227 of file vtkBiDimensionalWidget.h.

◆ Point4Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point4Widget

Definition at line 228 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback1

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback1

Definition at line 229 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback2

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback2

Definition at line 230 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback3

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback3

Definition at line 231 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback4

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback4

Definition at line 232 of file vtkBiDimensionalWidget.h.

The documentation for this class was generated from the following file: