VTK  9.3.20240327
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:
[legend]
Collaboration diagram for vtkBiDimensionalWidget:
[legend]

Public Types

enum  { EndWidgetSelectEvent = 10050 }
 Events. More...
 
enum  { Start = 0 , Define , Manipulate }
 Enum defining the state of the widget. 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

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 int GetWidgetState ()
 Return the current widget state. More...
 
virtual void SetWidgetStateToStart ()
 Set the state of the widget. More...
 
virtual void SetWidgetStateToManipulate ()
 Set the state of the widget. More...
 
- Public Member Functions inherited from vtkAbstractWidget
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 ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
virtual vtkTypeBool 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...
 
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 ()
 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...
 
vtkAbstractWidgetNewInstance () const
 Standard macros implementing standard VTK methods. 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 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 vtkRenderWindowInteractorGetInteractor ()
 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 managed)
 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 (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool 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 vtkRendererGetDefaultRenderer ()
 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 vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. 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 ()
 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 ()
 
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. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkBiDimensionalWidgetNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 Standard macros implementing standard VTK methods. More...
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros implementing standard VTK methods. More...
 
- 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])
 Convenience methods for outside classes. More...
 
- 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 (vtkTypeBool 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 vtkTypeBool 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

 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 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)
 
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=nullptr)
 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 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...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

int WidgetState
 
int CurrentHandle
 
int HandleLine1Selected
 
int HandleLine2Selected
 
int Line1InnerSelected
 
int Line1OuterSelected
 
int Line2InnerSelected
 
int Line2OuterSelected
 
int CenterSelected
 
vtkHandleWidgetPoint1Widget
 
vtkHandleWidgetPoint2Widget
 
vtkHandleWidgetPoint3Widget
 
vtkHandleWidgetPoint4Widget
 
vtkBiDimensionalWidgetCallbackBiDimensionalWidgetCallback1
 
vtkBiDimensionalWidgetCallbackBiDimensionalWidgetCallback2
 
vtkBiDimensionalWidgetCallbackBiDimensionalWidgetCallback3
 
vtkBiDimensionalWidgetCallbackBiDimensionalWidgetCallback4
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
int LastDevice
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkBiDimensionalWidgetCallback
 
typedef vtkAbstractWidget Superclass
 Standard methods for a VTK class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for a VTK class. More...
 
static vtkBiDimensionalWidgetSafeDownCast (vtkObjectBase *o)
 Standard methods for a VTK class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for a VTK class. More...
 
vtkBiDimensionalWidgetNewInstance () const
 Standard methods for a VTK class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for a VTK class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for a VTK class. More...
 

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
Events:
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::PlacePointEvent vtkCommand::StartInteractionEvent
Online Examples:

Tests:
vtkBiDimensionalWidget (Tests)

Definition at line 118 of file vtkBiDimensionalWidget.h.

Member Typedef Documentation

◆ Superclass

Standard methods for a VTK class.

Definition at line 130 of file vtkBiDimensionalWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Events.

Enumerator
EndWidgetSelectEvent 

Definition at line 173 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.

Enumerator
Start 
Define 
Manipulate 

Definition at line 190 of file vtkBiDimensionalWidget.h.

Constructor & Destructor Documentation

◆ vtkBiDimensionalWidget()

vtkBiDimensionalWidget::vtkBiDimensionalWidget ( )
protected

◆ ~vtkBiDimensionalWidget()

vtkBiDimensionalWidget::~vtkBiDimensionalWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

Standard methods for a VTK class.

◆ IsA()

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::SafeDownCast ( vtkObjectBase o)
static

Standard methods for a VTK class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBiDimensionalWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkBiDimensionalWidget* vtkBiDimensionalWidget::NewInstance ( ) const

Standard methods for a VTK class.

◆ PrintSelf()

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

void vtkBiDimensionalWidget::SetEnabled ( int  )
overridevirtual

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)
inline

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

◆ GetBiDimensionalRepresentation()

vtkBiDimensionalRepresentation* vtkBiDimensionalWidget::GetBiDimensionalRepresentation ( )
inline

Return the representation as a vtkBiDimensionalRepresentation.

Definition at line 154 of file vtkBiDimensionalWidget.h.

◆ CreateDefaultRepresentation()

void vtkBiDimensionalWidget::CreateDefaultRepresentation ( )
overridevirtual

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  )
overridevirtual

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 ( )
virtual

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 ( )
virtual

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.

◆ GetWidgetState()

virtual int vtkBiDimensionalWidget::GetWidgetState ( )
inlinevirtual

Return the current widget state.

Definition at line 215 of file vtkBiDimensionalWidget.h.

◆ AddPointAction()

static void vtkBiDimensionalWidget::AddPointAction ( vtkAbstractWidget )
staticprotected

◆ MoveAction()

static void vtkBiDimensionalWidget::MoveAction ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction()

static void vtkBiDimensionalWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected

◆ StartBiDimensionalInteraction()

void vtkBiDimensionalWidget::StartBiDimensionalInteraction ( )
protected

◆ EndBiDimensionalInteraction()

virtual void vtkBiDimensionalWidget::EndBiDimensionalInteraction ( )
protectedvirtual

Friends And Related Function Documentation

◆ vtkBiDimensionalWidgetCallback

friend class vtkBiDimensionalWidgetCallback
friend

Definition at line 253 of file vtkBiDimensionalWidget.h.

Member Data Documentation

◆ WidgetState

int vtkBiDimensionalWidget::WidgetState
protected

Definition at line 222 of file vtkBiDimensionalWidget.h.

◆ CurrentHandle

int vtkBiDimensionalWidget::CurrentHandle
protected

Definition at line 223 of file vtkBiDimensionalWidget.h.

◆ HandleLine1Selected

int vtkBiDimensionalWidget::HandleLine1Selected
protected

Definition at line 224 of file vtkBiDimensionalWidget.h.

◆ HandleLine2Selected

int vtkBiDimensionalWidget::HandleLine2Selected
protected

Definition at line 225 of file vtkBiDimensionalWidget.h.

◆ Line1InnerSelected

int vtkBiDimensionalWidget::Line1InnerSelected
protected

Definition at line 226 of file vtkBiDimensionalWidget.h.

◆ Line1OuterSelected

int vtkBiDimensionalWidget::Line1OuterSelected
protected

Definition at line 227 of file vtkBiDimensionalWidget.h.

◆ Line2InnerSelected

int vtkBiDimensionalWidget::Line2InnerSelected
protected

Definition at line 228 of file vtkBiDimensionalWidget.h.

◆ Line2OuterSelected

int vtkBiDimensionalWidget::Line2OuterSelected
protected

Definition at line 229 of file vtkBiDimensionalWidget.h.

◆ CenterSelected

int vtkBiDimensionalWidget::CenterSelected
protected

Definition at line 230 of file vtkBiDimensionalWidget.h.

◆ Point1Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point1Widget
protected

Definition at line 239 of file vtkBiDimensionalWidget.h.

◆ Point2Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point2Widget
protected

Definition at line 240 of file vtkBiDimensionalWidget.h.

◆ Point3Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point3Widget
protected

Definition at line 241 of file vtkBiDimensionalWidget.h.

◆ Point4Widget

vtkHandleWidget* vtkBiDimensionalWidget::Point4Widget
protected

Definition at line 242 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback1

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback1
protected

Definition at line 243 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback2

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback2
protected

Definition at line 244 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback3

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback3
protected

Definition at line 245 of file vtkBiDimensionalWidget.h.

◆ BiDimensionalWidgetCallback4

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback4
protected

Definition at line 246 of file vtkBiDimensionalWidget.h.


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