vtkSeedWidget Class Reference

#include <vtkSeedWidget.h>

Inheritance diagram for vtkSeedWidget:

[legend]

Collaboration diagram for vtkSeedWidget:

[legend]

List of all members.

Detailed Description

place multiple seed points

The vtkSeedWidget is used to placed multiple seed points in the scene. The seed points can be used for operations like connectivity, segmentation, and region growing.

To use this widget, specify an instance of vtkSeedWidget and a representation (a subclass of vtkSeedRepresentation). The widget is implemented using multiple instances of vtkHandleWidget which can be used to position the seed points (after they are initially placed). The representations for these handle widgets are provided by the vtkSeedRepresentation.

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

   LeftButtonPressEvent - add a point or select a handle (i.e., seed)
   RightButtonPressEvent - finish adding the seeds
   MouseMoveEvent - move a handle (i.e., seed)
   LeftButtonReleaseEvent - release the selected handle (seed)

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkSeedWidget's widget events:

   vtkWidgetEvent::AddPoint -- add one point; depending on the state
                               it may the first or second point added. Or,
                               if near handle, select handle.
   vtkWidgetEvent::Completed -- finished adding seeds.
   vtkWidgetEvent::Move -- move the second point or handle depending on the state.
   vtkWidgetEvent::EndSelect -- the handle 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 after selecting something)
   vtkCommand::PlacePointEvent (after point is positioned; 
                                call data includes handle id (0,1))

See also:: vtkHandleWidget vtkSeedReoresentation

Events:: vtkCommand::EndInteractionEvent vtkCommand::MouseMoveEvent vtkCommand::InteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::PlacePointEvent vtkCommand::LeftButtonReleaseEvent

Tests:: vtkSeedWidget (Tests)

Definition at line 84 of file vtkSeedWidget.h.


typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkSeedWidget *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions
virtual void	SetEnabled (int)
virtual void	SetCurrentRenderer (vtkRenderer *)
virtual void	SetInteractor (vtkRenderWindowInteractor *)
void	CreateDefaultRepresentation ()
virtual void	SetProcessEvents (int)
virtual void	CompleteInteraction ()
virtual void	RestartInteraction ()
virtual vtkHandleWidget *	CreateNewHandle ()
void	DeleteSeed (int n)
vtkHandleWidget *	GetSeed (int n)

void	SetRepresentation (vtkSeedRepresentation *rep)
Static Public Member Functions
static vtkSeedWidget *	New ()
Protected Types
enum	{ Start = 0, PlacingSeeds, PlacedSeeds, MovingSeed }
Protected Member Functions
	vtkSeedWidget ()
	~vtkSeedWidget ()
Static Protected Member Functions
static void	AddPointAction (vtkAbstractWidget *)
static void	CompletedAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	DeleteAction (vtkAbstractWidget *)
Protected Attributes
int	WidgetState
vtkSeedList *	Seeds

Member Typedef Documentation

typedef vtkAbstractWidget vtkSeedWidget::Superclass

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

Definition at line 92 of file vtkSeedWidget.h.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

Start
PlacingSeeds
PlacedSeeds
MovingSeed

Definition at line 156 of file vtkSeedWidget.h.

Constructor & Destructor Documentation

vtkSeedWidget::vtkSeedWidget ( ) [protected]

vtkSeedWidget::~vtkSeedWidget ( ) [protected]

Member Function Documentation

static vtkSeedWidget* vtkSeedWidget::New ( ) [static]

Instantiate this class.

Reimplemented from vtkObject.

virtual const char* vtkSeedWidget::GetClassName ( ) [virtual]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

static int vtkSeedWidget::IsTypeOf ( const char * type ) [static]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual int vtkSeedWidget::IsA ( const char * type ) [virtual]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

static vtkSeedWidget* vtkSeedWidget::SafeDownCast ( vtkObject * o ) [static]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

void vtkSeedWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkSeedWidget::SetEnabled ( int ) [virtual]

The method for activiating and deactiviating 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.

virtual void vtkSeedWidget::SetCurrentRenderer ( vtkRenderer * ) [virtual]

Set the current renderer. This method also propagates to all the child handle widgets, if any exist

Reimplemented from vtkInteractorObserver.

virtual void vtkSeedWidget::SetInteractor ( vtkRenderWindowInteractor * ) [virtual]

Set the interactor. This method also propagates to all the child handle widgets, if any exist

Reimplemented from vtkInteractorObserver.

void vtkSeedWidget::SetRepresentation ( vtkSeedRepresentation * rep ) [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 113 of file vtkSeedWidget.h.

void vtkSeedWidget::CreateDefaultRepresentation ( ) [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkSeedWidget::SetProcessEvents ( int ) [virtual]

Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

virtual void vtkSeedWidget::CompleteInteraction ( ) [virtual]

Method to be called when the seed widget should stop responding to the interaction. The seed widget, when defined allows you place seeds by clicking on the render window. Use this method to indicate that you would like to stop placing seeds interactively.

virtual void vtkSeedWidget::RestartInteraction ( ) [virtual]

Method to be called when the seed widget should start responding to the interaction.

virtual vtkHandleWidget* vtkSeedWidget::CreateNewHandle ( ) [virtual]

Use this method to programmatically create a new handle. In interactive mode, (when the widget is in the PlacingSeeds state) this method is automatically invoked. The method returns the handle created. A valid seed representation must exist for the widget to create a new handle.

void vtkSeedWidget::DeleteSeed ( int n )

Delete the nth seed.

vtkHandleWidget* vtkSeedWidget::GetSeed ( int n )

Get the nth seed

static void vtkSeedWidget::AddPointAction ( vtkAbstractWidget * ) [static, protected]

static void vtkSeedWidget::CompletedAction ( vtkAbstractWidget * ) [static, protected]

static void vtkSeedWidget::MoveAction ( vtkAbstractWidget * ) [static, protected]

static void vtkSeedWidget::EndSelectAction ( vtkAbstractWidget * ) [static, protected]

static void vtkSeedWidget::DeleteAction ( vtkAbstractWidget * ) [static, protected]

Member Data Documentation

int vtkSeedWidget::WidgetState [protected]

Definition at line 164 of file vtkSeedWidget.h.

vtkSeedList* vtkSeedWidget::Seeds [protected]

Definition at line 175 of file vtkSeedWidget.h.

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

dox/Widgets/vtkSeedWidget.h

vtkSeedWidget Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation