VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkContourWidget Class Reference

create a contour with a set of points More...

#include <vtkContourWidget.h>

Inheritance diagram for vtkContourWidget:
[legend]
Collaboration diagram for vtkContourWidget:
[legend]

Public Types

enum  { Start, Define, Manipulate }
 
- 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 (vtkContourRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
vtkContourRepresentationGetContourRepresentation ()
 Return the representation as a vtkContourRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
void CloseLoop ()
 Convenient method to close the contour loop. More...
 
virtual void Initialize (vtkPolyData *poly, int state=1, vtkIdList *idList=nullptr)
 Initialize the contour widget from a user supplied set of points. More...
 
virtual void Initialize ()
 
virtual void SetWidgetState (int)
 Convenient method to change what state the widget is in. More...
 
virtual int GetWidgetState ()
 Convenient method to determine the state of the method. More...
 
void SetAllowNodePicking (vtkTypeBool)
 Set / Get the AllowNodePicking value. More...
 
virtual vtkTypeBool GetAllowNodePicking ()
 Set / Get the AllowNodePicking value. More...
 
virtual void AllowNodePickingOn ()
 Set / Get the AllowNodePicking value. More...
 
virtual void AllowNodePickingOff ()
 Set / Get the AllowNodePicking value. More...
 
virtual void SetFollowCursor (vtkTypeBool)
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped. More...
 
virtual vtkTypeBool GetFollowCursor ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped. More...
 
virtual void FollowCursorOn ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped. More...
 
virtual void FollowCursorOff ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped. More...
 
virtual void SetContinuousDraw (vtkTypeBool)
 Define a contour by continuously drawing with the mouse cursor. More...
 
virtual vtkTypeBool GetContinuousDraw ()
 Define a contour by continuously drawing with the mouse cursor. More...
 
virtual void ContinuousDrawOn ()
 Define a contour by continuously drawing with the mouse cursor. More...
 
virtual void ContinuousDrawOff ()
 Define a contour by continuously drawing with the mouse cursor. 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 void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction. 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkContourWidgetNew ()
 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static 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

 vtkContourWidget ()
 
 ~vtkContourWidget () override
 
void SelectNode ()
 
void AddNode ()
 
- 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void AddFinalPointAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void DeleteAction (vtkAbstractWidget *)
 
static void TranslateContourAction (vtkAbstractWidget *)
 
static void ScaleContourAction (vtkAbstractWidget *)
 
static void ResetAction (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
 
vtkTypeBool AllowNodePicking
 
vtkTypeBool FollowCursor
 
vtkTypeBool ContinuousDraw
 
int ContinuousActive
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
- 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
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractWidget Superclass
 Standard methods for a VTK class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for a VTK class. More...
 
static vtkContourWidgetSafeDownCast (vtkObjectBase *o)
 Standard methods for a VTK class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for a VTK class. More...
 
vtkContourWidgetNewInstance () 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

create a contour with a set of points

The vtkContourWidget is used to select a set of points, and draw lines between these points. The contour may be opened or closed, depending on how the last point is added. The widget handles all processing of widget events (that are triggered by VTK events). The vtkContourRepresentation is responsible for all placement of the points, calculation of the lines, and contour manipulation. This is done through two main helper classes: vtkPointPlacer and vtkContourLineInterpolator. The representation is also responsible for drawing the points and lines.

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
  LeftButtonPressEvent - triggers a Select event
  RightButtonPressEvent - triggers a AddFinalPoint event
  MouseMoveEvent - triggers a Move event
  LeftButtonReleaseEvent - triggers an EndSelect event
  Delete key event - triggers a Delete event
  Shift + Delete key event - triggers a Reset event
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkContourWidget's widget events:
  vtkWidgetEvent::Select
       widget state is:
           Start or
           Define: If we already have at least 2 nodes, test
                whether the current (X,Y) location is near an existing
                node. If so, close the contour and change to Manipulate
                state. Otherwise, attempt to add a node at this (X,Y)
                location.
           Manipulate: If this (X,Y) location activates a node, then
                set the current operation to Translate. Otherwise, if
                this location is near the contour, attempt to add a
                new node on the contour at this (X,Y) location.
Event Bindings:
  vtkWidgetEvent::AddFinalPoint
       widget state is:
           Start: Do nothing.
           Define: If we already have at least 2 nodes, test
                whether the current (X,Y) location is near an existing
                node. If so, close the contour and change to Manipulate
                state. Otherwise, attempt to add a node at this (X,Y)
                location. If we do, then leave the contour open and
                change to Manipulate state.
           Manipulate: Do nothing.
Event Bindings:
  vtkWidgetEvent::Move
       widget state is:
           Start or
           Define: Do nothing.
           Manipulate: If our operation is Translate, then invoke
                 WidgetInteraction() on the representation. If our
                 operation is Inactive, then just attempt to activate
                 a node at this (X,Y) location.
Event Bindings:
  vtkWidgetEvent::EndSelect
       widget state is:
           Start or
           Define: Do nothing.
           Manipulate: If our operation is not Inactive, set it to
                 Inactive.
Event Bindings:
  vtkWidgetEvent::Delete
       widget state is:
           Start: Do nothing.
           Define: Remove the last point on the contour.
           Manipulate: Attempt to activate a node at (X,Y). If
                  we do activate a node, delete it. If we now
                  have less than 3 nodes, go back to Define state.
Event Bindings:
  vtkWidgetEvent::Reset
       widget state is:
           Start: Do nothing.
           Define: Remove all points and line segments of the contour.
                Essentially calls Initialize(nullptr)
           Manipulate: Do nothing.
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 after selecting something)
  vtkCommand::PlacePointEvent (after point is positioned;
                               call data includes handle id (0,1))
  vtkCommand::WidgetValueChangedEvent (Invoked when the contour is closed
                                       for the first time. )
See also
vtkHandleWidget
Tests:
vtkContourWidget (Tests)

Definition at line 136 of file vtkContourWidget.h.

Member Typedef Documentation

Standard methods for a VTK class.

Definition at line 148 of file vtkContourWidget.h.

Member Enumeration Documentation

anonymous enum
Enumerator
Start 
Define 
Manipulate 

Definition at line 250 of file vtkContourWidget.h.

Constructor & Destructor Documentation

vtkContourWidget::vtkContourWidget ( )
protected
vtkContourWidget::~vtkContourWidget ( )
overrideprotected

Member Function Documentation

static vtkContourWidget* vtkContourWidget::New ( )
static

Instantiate this class.

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

Standard methods for a VTK class.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

virtual vtkObjectBase* vtkContourWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkContourWidget* vtkContourWidget::NewInstance ( ) const

Standard methods for a VTK class.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

void vtkContourWidget::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.

void vtkContourWidget::SetRepresentation ( vtkContourRepresentation 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 164 of file vtkContourWidget.h.

vtkContourRepresentation* vtkContourWidget::GetContourRepresentation ( )
inline

Return the representation as a vtkContourRepresentation.

Definition at line 170 of file vtkContourWidget.h.

void vtkContourWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

void vtkContourWidget::CloseLoop ( )

Convenient method to close the contour loop.

virtual void vtkContourWidget::SetWidgetState ( int  )
virtual

Convenient method to change what state the widget is in.

virtual int vtkContourWidget::GetWidgetState ( )
virtual

Convenient method to determine the state of the method.

void vtkContourWidget::SetAllowNodePicking ( vtkTypeBool  )

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

virtual vtkTypeBool vtkContourWidget::GetAllowNodePicking ( )
virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

virtual void vtkContourWidget::AllowNodePickingOn ( )
virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

virtual void vtkContourWidget::AllowNodePickingOff ( )
virtual

Set / Get the AllowNodePicking value.

This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

virtual void vtkContourWidget::SetFollowCursor ( vtkTypeBool  )
virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

virtual vtkTypeBool vtkContourWidget::GetFollowCursor ( )
virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

virtual void vtkContourWidget::FollowCursorOn ( )
virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

virtual void vtkContourWidget::FollowCursorOff ( )
virtual

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the point to be dropped.

This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

virtual void vtkContourWidget::SetContinuousDraw ( vtkTypeBool  )
virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

virtual vtkTypeBool vtkContourWidget::GetContinuousDraw ( )
virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

virtual void vtkContourWidget::ContinuousDrawOn ( )
virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

virtual void vtkContourWidget::ContinuousDrawOff ( )
virtual

Define a contour by continuously drawing with the mouse cursor.

Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

virtual void vtkContourWidget::Initialize ( vtkPolyData poly,
int  state = 1,
vtkIdList idList = nullptr 
)
virtual

Initialize the contour widget from a user supplied set of points.

The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.

virtual void vtkContourWidget::Initialize ( )
inlinevirtual

Definition at line 245 of file vtkContourWidget.h.

static void vtkContourWidget::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::AddFinalPointAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::MoveAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::DeleteAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::TranslateContourAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::ScaleContourAction ( vtkAbstractWidget )
staticprotected
static void vtkContourWidget::ResetAction ( vtkAbstractWidget )
staticprotected
void vtkContourWidget::SelectNode ( )
protected
void vtkContourWidget::AddNode ( )
protected

Member Data Documentation

int vtkContourWidget::WidgetState
protected

Definition at line 256 of file vtkContourWidget.h.

int vtkContourWidget::CurrentHandle
protected

Definition at line 257 of file vtkContourWidget.h.

vtkTypeBool vtkContourWidget::AllowNodePicking
protected

Definition at line 258 of file vtkContourWidget.h.

vtkTypeBool vtkContourWidget::FollowCursor
protected

Definition at line 259 of file vtkContourWidget.h.

vtkTypeBool vtkContourWidget::ContinuousDraw
protected

Definition at line 260 of file vtkContourWidget.h.

int vtkContourWidget::ContinuousActive
protected

Definition at line 261 of file vtkContourWidget.h.


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