Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
189 lines (158 sloc) 6.47 KB
Program: Visualization Toolkit
Module: vtkSeedWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or for details.
This software is distributed WITHOUT ANY WARRANTY; without even
PURPOSE. See the above copyright notice for more information.
// .NAME vtkSeedWidget - place multiple seed points
// .SECTION Description
// 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.
// .SECTION Event Bindings
// By default, the widget responds to the following VTK events (i.e., it
// watches the vtkRenderWindowInteractor for these events):
// <pre>
// 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)
// </pre>
// 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:
// <pre>
// 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.
// </pre>
// This widget invokes the following VTK events on itself (which observers
// can listen for):
// <pre>
// 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))
// </pre>
// .SECTION See Also
// vtkHandleWidget vtkSeedReoresentation
#ifndef __vtkSeedWidget_h
#define __vtkSeedWidget_h
#include "vtkAbstractWidget.h"
class vtkHandleRepresentation;
class vtkHandleWidget;
class vtkSeedList;
class vtkSeedRepresentation;
class VTK_WIDGETS_EXPORT vtkSeedWidget : public vtkAbstractWidget
// Description:
// Instantiate this class.
static vtkSeedWidget *New();
// Description:
// Standard methods for a VTK class.
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// 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.
virtual void SetEnabled(int);
// Description:
// Set the current renderer. This method also propagates to all the child
// handle widgets, if any exist
virtual void SetCurrentRenderer( vtkRenderer * );
// Description:
// Set the interactor. This method also propagates to all the child
// handle widgets, if any exist
virtual void SetInteractor( vtkRenderWindowInteractor * );
// Description:
// 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.
void SetRepresentation( vtkSeedRepresentation *rep )
reinterpret_cast<vtkWidgetRepresentation*>(rep) );
// Description:
// Create the default widget representation if one is not set.
void CreateDefaultRepresentation();
// Description:
// Methods to change the whether the widget responds to interaction.
// Overridden to pass the state to component widgets.
virtual void SetProcessEvents(int);
// Description:
// Method to be called when the seed widget should stop responding to
// the place point 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. If
// you'd like the widget to stop responding to *any* user interaction
// simply disable event processing by the widget by calling
// widget->ProcessEventsOff()
virtual void CompleteInteraction();
// Description:
// Method to be called when the seed widget should start responding
// to the interaction.
virtual void RestartInteraction();
// Description:
// 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.
virtual vtkHandleWidget * CreateNewHandle();
// Description:
// Delete the nth seed.
void DeleteSeed(int n);
// Description:
// Get the nth seed
vtkHandleWidget * GetSeed( int n );
// The state of the widget
Start = 1,
PlacingSeeds = 2,
PlacedSeeds = 4,
MovingSeed = 8
int WidgetState;
// Callback interface to capture events when
// placing the widget.
static void AddPointAction( vtkAbstractWidget* );
static void CompletedAction( vtkAbstractWidget* );
static void MoveAction( vtkAbstractWidget* );
static void EndSelectAction( vtkAbstractWidget* );
static void DeleteAction( vtkAbstractWidget* );
// The positioning handle widgets
vtkSeedList *Seeds;
// Manipulating or defining ?
int Defining;
vtkSeedWidget(const vtkSeedWidget&); //Not implemented
void operator=(const vtkSeedWidget&); //Not implemented