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

place multiple seed points More...

#include <vtkSeedWidget.h>

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

Public Types

enum  { Start = 1, PlacingSeeds = 2, PlacedSeeds = 4, MovingSeed = 8 }
 
typedef vtkAbstractWidget Superclass
 Standard methods for a VTK class. 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

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSeedWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEnabled (int) override
 The method for activating and deactivating this widget. More...
 
void SetCurrentRenderer (vtkRenderer *) override
 Set the current renderer. More...
 
void SetInteractor (vtkRenderWindowInteractor *) override
 Set the interactor. More...
 
void SetRepresentation (vtkSeedRepresentation *rep)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
vtkSeedRepresentationGetSeedRepresentation ()
 Return the representation as a vtkSeedRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
void SetProcessEvents (vtkTypeBool) override
 Methods to change the whether the widget responds to interaction. More...
 
virtual void CompleteInteraction ()
 Method to be called when the seed widget should stop responding to the place point interaction. More...
 
virtual void RestartInteraction ()
 Method to be called when the seed widget should start responding to the interaction. More...
 
virtual vtkHandleWidgetCreateNewHandle ()
 Use this method to programmatically create a new handle. More...
 
void DeleteSeed (int n)
 Delete the nth seed. More...
 
vtkHandleWidgetGetSeed (int n)
 Get the nth seed. More...
 
virtual int GetWidgetState ()
 Get the widget state. More...
 
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
 
virtual vtkTypeBool GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
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 ()
 
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 ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
void SetPriority (float) override
 Override the superclass method. 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 vtkRenderWindowInteractorGetInteractor ()
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
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 ()
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void OnChar ()
 Sets up the keypress-i event. 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 ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkSeedWidgetNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSeedWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 
- 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])
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSeedWidget ()
 
 ~vtkSeedWidget () override
 
- 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 StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
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])
 
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)
 
- 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 ()
 
- 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 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)
 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
 
vtkSeedList * Seeds
 
int Defining
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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))
  vtkCommand::DeletePointEvent (before point is deleted;
                               call data includes handle id (0,1))
See also
vtkHandleWidget vtkSeedRepresentation
Events:
vtkCommand::DeletePointEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::MouseMoveEvent vtkCommand::PlacePointEvent vtkCommand::StartInteractionEvent
Tests:
vtkSeedWidget (Tests)

Definition at line 87 of file vtkSeedWidget.h.

Member Typedef Documentation

◆ Superclass

Standard methods for a VTK class.

Definition at line 99 of file vtkSeedWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Start 
PlacingSeeds 
PlacedSeeds 
MovingSeed 

Definition at line 196 of file vtkSeedWidget.h.

Constructor & Destructor Documentation

◆ vtkSeedWidget()

vtkSeedWidget::vtkSeedWidget ( )
protected

◆ ~vtkSeedWidget()

vtkSeedWidget::~vtkSeedWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSeedWidget* vtkSeedWidget::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSeedWidget::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSeedWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkSeedWidget* vtkSeedWidget::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

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

◆ SetCurrentRenderer()

void vtkSeedWidget::SetCurrentRenderer ( vtkRenderer )
overridevirtual

Set the current renderer.

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

Reimplemented from vtkInteractorObserver.

◆ SetInteractor()

void vtkSeedWidget::SetInteractor ( vtkRenderWindowInteractor )
overridevirtual

Set the interactor.

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

Reimplemented from vtkInteractorObserver.

◆ SetRepresentation()

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

◆ GetSeedRepresentation()

vtkSeedRepresentation* vtkSeedWidget::GetSeedRepresentation ( )
inline

Return the representation as a vtkSeedRepresentation.

Definition at line 135 of file vtkSeedWidget.h.

◆ CreateDefaultRepresentation()

void vtkSeedWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SetProcessEvents()

void vtkSeedWidget::SetProcessEvents ( vtkTypeBool  )
overridevirtual

Methods to change the whether the widget responds to interaction.

Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

◆ CompleteInteraction()

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

◆ RestartInteraction()

virtual void vtkSeedWidget::RestartInteraction ( )
virtual

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

◆ CreateNewHandle()

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.

◆ DeleteSeed()

void vtkSeedWidget::DeleteSeed ( int  n)

Delete the nth seed.

◆ GetSeed()

vtkHandleWidget* vtkSeedWidget::GetSeed ( int  n)

Get the nth seed.

◆ GetWidgetState()

virtual int vtkSeedWidget::GetWidgetState ( )
virtual

Get the widget state.

◆ AddPointAction()

static void vtkSeedWidget::AddPointAction ( vtkAbstractWidget )
staticprotected

◆ CompletedAction()

static void vtkSeedWidget::CompletedAction ( vtkAbstractWidget )
staticprotected

◆ MoveAction()

static void vtkSeedWidget::MoveAction ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction()

static void vtkSeedWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected

◆ DeleteAction()

static void vtkSeedWidget::DeleteAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

◆ WidgetState

int vtkSeedWidget::WidgetState
protected

Definition at line 208 of file vtkSeedWidget.h.

◆ Seeds

vtkSeedList* vtkSeedWidget::Seeds
protected

Definition at line 219 of file vtkSeedWidget.h.

◆ Defining

int vtkSeedWidget::Defining
protected

Definition at line 222 of file vtkSeedWidget.h.


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