vtkSeedWidget Class Reference

place multiple seed points More...

#include <vtkSeedWidget.h>

Inheritance diagram for vtkSeedWidget:

Collaboration diagram for vtkSeedWidget:

Public Types
enum	{ Start = 1, PlacingSeeds = 2, PlacedSeeds = 4, MovingSeed = 8 }
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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)
vtkSeedRepresentation *	GetSeedRepresentation ()
virtual int	GetWidgetState ()
Public Member Functions inherited from vtkAbstractWidget
void	Render ()
virtual void	SetPriority (float)
virtual int	GetProcessEvents ()
virtual void	ProcessEventsOn ()
virtual void	ProcessEventsOff ()
vtkWidgetEventTranslator *	GetEventTranslator ()
void	SetParent (vtkAbstractWidget *parent)
virtual vtkAbstractWidget *	GetParent ()
vtkWidgetRepresentation *	GetRepresentation ()
virtual void	SetManagesCursor (int)
virtual int	GetManagesCursor ()
virtual void	ManagesCursorOn ()
virtual void	ManagesCursorOff ()
vtkAbstractWidget *	NewInstance () const
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnChar ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkSeedWidget *	New ()
Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
	vtkSeedWidget ()
	~vtkSeedWidget ()
Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()
	~vtkAbstractWidget ()
void	SetWidgetRepresentation (vtkWidgetRepresentation *r)
virtual void	SetCursor (int vtkNotUsed(state))
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
virtual void	RegisterPickers ()
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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	CompletedAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	DeleteAction (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)

Protected Attributes
int	WidgetState
vtkSeedList *	Seeds
int	Defining
Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep
int	ManagesCursor
vtkWidgetEventTranslator *	EventTranslator
vtkWidgetCallbackMapper *	CallbackMapper
vtkAbstractWidget *	Parent
void *	CallData
int	ProcessEvents
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkSeedWidget *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkSeedWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

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

Tests:

vtkSeedWidget (Tests)

Definition at line 85 of file vtkSeedWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkSeedWidget::Superclass

Standard methods for a VTK class.

Definition at line 93 of file vtkSeedWidget.h.

Member Enumeration Documentation

anonymous enum

Enumerator
Start
PlacingSeeds
PlacedSeeds
MovingSeed

Definition at line 167 of file vtkSeedWidget.h.

Constructor & Destructor Documentation

vtkSeedWidget::vtkSeedWidget ( )

protected

vtkSeedWidget::~vtkSeedWidget ( )

protected

Member Function Documentation

static vtkSeedWidget* vtkSeedWidget::New ( )

static

Instantiate this class.

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

static

Standard methods for a VTK class.

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

static

Standard methods for a VTK class.

virtual vtkObjectBase* vtkSeedWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkSeedWidget* vtkSeedWidget::NewInstance

(

)

const

Standard methods for a VTK class.

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 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.

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 114 of file vtkSeedWidget.h.

vtkSeedRepresentation* vtkSeedWidget::GetSeedRepresentation ( )

inline

Return the representation as a vtkSeedRepresentation.

Definition at line 123 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 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 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

virtual int vtkSeedWidget::GetWidgetState ( )

virtual

Get the widget state.

static void vtkSeedWidget::AddPointAction ( vtkAbstractWidget *  )

staticprotected

static void vtkSeedWidget::CompletedAction ( vtkAbstractWidget *  )

staticprotected

static void vtkSeedWidget::MoveAction ( vtkAbstractWidget *  )

staticprotected

static void vtkSeedWidget::EndSelectAction ( vtkAbstractWidget *  )

staticprotected

static void vtkSeedWidget::DeleteAction ( vtkAbstractWidget *  )

staticprotected

Member Data Documentation

int vtkSeedWidget::WidgetState

protected

Definition at line 181 of file vtkSeedWidget.h.

vtkSeedList* vtkSeedWidget::Seeds

protected

Definition at line 192 of file vtkSeedWidget.h.

int vtkSeedWidget::Defining

protected

Definition at line 195 of file vtkSeedWidget.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkSeedWidget.h