3D widget for tracing on planar props. More...

#include <vtkImageTracerWidget.h>

Inheritance diagram for vtkImageTracerWidget:

Collaboration diagram for vtkImageTracerWidget:

Public Types
typedef vtk3DWidget	Superclass

Public Types inherited from vtk3DWidget
typedef vtkInteractorObserver	Superclass

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.

vtkImageTracerWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetViewProp (vtkProp *prop)
	Set the prop, usually a vtkImageActor, to trace over.

void	GetPath (vtkPolyData *pd)
	Grab the points and lines that define the traced path.

vtkGlyphSource2D *	GetGlyphSource ()
	Get the handles' geometric representation via vtkGlyphSource2D.

void	InitializeHandles (vtkPoints *)
	Initialize the widget with a set of points and generate lines between them.

int	IsClosed ()
	Is the path closed or open?


void	SetEnabled (int) override
	Methods that satisfy the superclass' API.

void	PlaceWidget (double bounds[6]) override
	Methods that satisfy the superclass' API.

void	PlaceWidget () override
	Methods that satisfy the superclass' API.

void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
	Methods that satisfy the superclass' API.


virtual void	SetHandleProperty (vtkProperty *)
	Set/Get the handle properties (the 2D glyphs are the handles).

virtual vtkProperty *	GetHandleProperty ()
	Set/Get the handle properties (the 2D glyphs are the handles).

virtual void	SetSelectedHandleProperty (vtkProperty *)
	Set/Get the handle properties (the 2D glyphs are the handles).

virtual vtkProperty *	GetSelectedHandleProperty ()
	Set/Get the handle properties (the 2D glyphs are the handles).


virtual void	SetLineProperty (vtkProperty *)
	Set/Get the line properties.

virtual vtkProperty *	GetLineProperty ()
	Set/Get the line properties.

virtual void	SetSelectedLineProperty (vtkProperty *)
	Set/Get the line properties.

virtual vtkProperty *	GetSelectedLineProperty ()
	Set/Get the line properties.


virtual void	SetProjectToPlane (vtkTypeBool)
	Force handles to be on a specific ortho plane.

virtual vtkTypeBool	GetProjectToPlane ()
	Force handles to be on a specific ortho plane.

virtual void	ProjectToPlaneOn ()
	Force handles to be on a specific ortho plane.

virtual void	ProjectToPlaneOff ()
	Force handles to be on a specific ortho plane.


virtual void	SetProjectionNormal (int)
	Set the projection normal.

virtual int	GetProjectionNormal ()
	Set the projection normal.

void	SetProjectionNormalToXAxes ()
	Set the projection normal.

void	SetProjectionNormalToYAxes ()
	Set the projection normal.

void	SetProjectionNormalToZAxes ()
	Set the projection normal.


void	SetProjectionPosition (double position)
	Set the position of the widgets' handles in terms of a plane's position.

virtual double	GetProjectionPosition ()
	Set the position of the widgets' handles in terms of a plane's position.


void	SetSnapToImage (vtkTypeBool snap)
	Force snapping to image data while tracing.

virtual vtkTypeBool	GetSnapToImage ()
	Force snapping to image data while tracing.

virtual void	SnapToImageOn ()
	Force snapping to image data while tracing.

virtual void	SnapToImageOff ()
	Force snapping to image data while tracing.


virtual void	SetAutoClose (vtkTypeBool)
	In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

virtual vtkTypeBool	GetAutoClose ()
	In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

virtual void	AutoCloseOn ()
	In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

virtual void	AutoCloseOff ()
	In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.


virtual void	SetCaptureRadius (double)
	Set/Get the capture radius for automatic path closing.

virtual double	GetCaptureRadius ()
	Set/Get the capture radius for automatic path closing.


virtual void	SetImageSnapType (int)
	Set/Get the type of snapping to image data: center of a pixel/voxel or nearest point defining a pixel/voxel.

virtual int	GetImageSnapType ()
	Set/Get the type of snapping to image data: center of a pixel/voxel or nearest point defining a pixel/voxel.


void	SetHandlePosition (int handle, double xyz[3])
	Set/Get the handle position in terms of a zero-based array of handles.

void	SetHandlePosition (int handle, double x, double y, double z)
	Set/Get the handle position in terms of a zero-based array of handles.

void	GetHandlePosition (int handle, double xyz[3])
	Set/Get the handle position in terms of a zero-based array of handles.

double *	GetHandlePosition (int handle)
	Set/Get the handle position in terms of a zero-based array of handles.


virtual int	GetNumberOfHandles ()
	Get the number of handles.


void	SetInteraction (vtkTypeBool interact)
	Enable/disable mouse interaction when the widget is visible.

virtual vtkTypeBool	GetInteraction ()
	Enable/disable mouse interaction when the widget is visible.

virtual void	InteractionOn ()
	Enable/disable mouse interaction when the widget is visible.

virtual void	InteractionOff ()
	Enable/disable mouse interaction when the widget is visible.


virtual void	SetHandleLeftMouseButton (vtkTypeBool)
	Enable/Disable mouse button events.

virtual vtkTypeBool	GetHandleLeftMouseButton ()
	Enable/Disable mouse button events.

virtual void	HandleLeftMouseButtonOn ()
	Enable/Disable mouse button events.

virtual void	HandleLeftMouseButtonOff ()
	Enable/Disable mouse button events.

virtual void	SetHandleMiddleMouseButton (vtkTypeBool)
	Enable/Disable mouse button events.

virtual vtkTypeBool	GetHandleMiddleMouseButton ()
	Enable/Disable mouse button events.

virtual void	HandleMiddleMouseButtonOn ()
	Enable/Disable mouse button events.

virtual void	HandleMiddleMouseButtonOff ()
	Enable/Disable mouse button events.

virtual void	SetHandleRightMouseButton (vtkTypeBool)
	Enable/Disable mouse button events.

virtual vtkTypeBool	GetHandleRightMouseButton ()
	Enable/Disable mouse button events.

virtual void	HandleRightMouseButtonOn ()
	Enable/Disable mouse button events.

virtual void	HandleRightMouseButtonOff ()
	Enable/Disable mouse button events.

Public Member Functions inherited from vtk3DWidget
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtk3DWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetProp3D (vtkProp3D *)
	Specify a vtkProp3D around which to place the widget.

virtual vtkProp3D *	GetProp3D ()
	Specify a vtkProp3D around which to place the widget.

virtual void	SetInputData (vtkDataSet *)
	Specify the input dataset.

virtual void	SetInputConnection (vtkAlgorithmOutput *)
	Specify the input dataset.

virtual vtkDataSet *	GetInput ()
	Specify the input dataset.

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).

virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget.

virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget.

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkImageTracerWidget *	New ()
	Instantiate the object.

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageTracerWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtk3DWidget
static vtkTypeBool	IsTypeOf (const char *type)

static vtk3DWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Types
enum	WidgetState { Start = 0 , Tracing , Snapping , Erasing , Inserting , Moving , Translating , Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageTracerWidget ()

	~vtkImageTracerWidget () override

void	OnLeftButtonDown ()

void	OnLeftButtonUp ()

void	OnMiddleButtonDown ()

void	OnMiddleButtonUp ()

void	OnRightButtonDown ()

void	OnRightButtonUp ()

void	OnMouseMove ()

void	AddObservers ()

void	Trace (int, int)

void	Snap (double *)

void	MovePoint (const double , const double )

void	Translate (const double , const double )

void	ClosePath ()

void	AppendHandles (double *)

void	ResetHandles ()

void	AllocateHandles (const int &)

void	AdjustHandlePosition (const int &, double *)

int	HighlightHandle (vtkProp *)

void	EraseHandle (const int &)

void	SizeHandles () override

void	InsertHandleOnLine (double *)

void	HighlightLine (const int &)

void	BuildLinesFromHandles ()

void	ResetLine (double *)

void	AppendLine (double *)

void	RegisterPickers () override
	Register internal Pickers in the Picking Manager.

void	CreateDefaultProperties ()

Protected Member Functions inherited from vtk3DWidget
virtual vtkObjectBase *	NewInstanceInternal () const

	vtk3DWidget ()

	~vtk3DWidget () override

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

double	SizeHandles (double factor)

virtual void	SizeHandles ()

void	UpdateInput ()

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (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.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ProcessEvents (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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
int	State

vtkTypeBool	Interaction

int	ProjectionNormal

double	ProjectionPosition

vtkTypeBool	ProjectToPlane

int	ImageSnapType

vtkTypeBool	SnapToImage

double	CaptureRadius

vtkTypeBool	AutoClose

int	IsSnapping

int	LastX

int	LastY

vtkActor **	Handle

vtkPolyData **	HandleGeometry

vtkGlyphSource2D *	HandleGenerator

vtkTransformPolyDataFilter *	TransformFilter

vtkTransform *	Transform

vtkFloatArray *	TemporaryHandlePoints

int	NumberOfHandles

vtkActor *	CurrentHandle

int	CurrentHandleIndex

vtkProp *	ViewProp

vtkPropPicker *	PropPicker

vtkPoints *	LinePoints

vtkCellArray *	LineCells

vtkActor *	LineActor

vtkPolyData *	LineData

vtkIdType	CurrentPoints [2]

int	PickCount

vtkCellPicker *	HandlePicker

vtkCellPicker *	LinePicker

vtkAbstractPropPicker *	CurrentPicker

vtkProperty *	HandleProperty

vtkProperty *	SelectedHandleProperty

vtkProperty *	LineProperty

vtkProperty *	SelectedLineProperty

vtkTypeBool	HandleLeftMouseButton

vtkTypeBool	HandleMiddleMouseButton

vtkTypeBool	HandleRightMouseButton

Protected Attributes inherited from vtk3DWidget
vtkProp3D *	Prop3D

vtk3DWidgetConnection *	ConnectionHolder

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

double	HandleSize

int	ValidPick

double	LastPickPosition [3]

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

3D widget for tracing on planar props.

vtkImageTracerWidget is different from other widgets in three distinct ways: 1) any sub-class of vtkProp can be input rather than just vtkProp3D, so that vtkImageActor can be set as the prop and then traced over, 2) the widget fires pick events at the input prop to decide where to move its handles, 3) the widget has 2D glyphs for handles instead of 3D spheres as is done in other sub-classes of vtk3DWidget. This widget is primarily designed for manually tracing over image data. The button actions and key modifiers are as follows for controlling the widget: 1) left button click over the image, hold and drag draws a free hand line. 2) left button click and release erases the widget line, if it exists, and repositions the first handle. 3) middle button click starts a snap drawn line. The line is terminated by clicking the middle button while depressing the ctrl key. 4) when tracing a continuous or snap drawn line, if the last cursor position is within a specified tolerance to the first handle, the widget line will form a closed loop. 5) right button clicking and holding on any handle that is part of a snap drawn line allows handle dragging: existing line segments are updated accordingly. If the path is open and AutoClose is set to On, the path can be closed by repositioning the first and last points over one another. 6) ctrl key + right button down on any handle will erase it: existing snap drawn line segments are updated accordingly. If the line was formed by continuous tracing, the line is deleted leaving one handle. 7) shift key + right button down on any snap drawn line segment will insert a handle at the cursor position. The line segment is split accordingly.

Warning: the input vtkDataSet should be vtkImageData.

See also: vtk3DWidget vtkBoxWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitPlaneWidget vtkPlaneWidget

Events:: vtkCommand::DisableEvent vtkCommand::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Online Examples:

ImageTracerWidget

ImageTracerWidgetInsideContour

ImageTracerWidgetNonPlanar

Tests:: vtkImageTracerWidget (Tests)

Definition at line 125 of file vtkImageTracerWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtk3DWidget vtkImageTracerWidget::Superclass

Definition at line 133 of file vtkImageTracerWidget.h.

Member Enumeration Documentation

◆ WidgetState

enum vtkImageTracerWidget::WidgetState

protected

Enumerator
Start
Tracing
Snapping
Erasing
Inserting
Moving
Translating
Outside

Definition at line 324 of file vtkImageTracerWidget.h.

Constructor & Destructor Documentation

◆ vtkImageTracerWidget()

vtkImageTracerWidget::vtkImageTracerWidget ( )

protected

◆ ~vtkImageTracerWidget()

vtkImageTracerWidget::~vtkImageTracerWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImageTracerWidget * vtkImageTracerWidget::New ( )

static

Instantiate the object.

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkImageTracerWidget::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 vtk3DWidget.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageTracerWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtk3DWidget.

◆ NewInstance()

vtkImageTracerWidget * vtkImageTracerWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkImageTracerWidget::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 vtk3DWidget.

◆ SetEnabled()

void vtkImageTracerWidget::SetEnabled ( int )

overridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

◆ PlaceWidget() [1/3]

void vtkImageTracerWidget::PlaceWidget ( double bounds[6] )

overridevirtual

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

◆ PlaceWidget() [2/3]

void vtkImageTracerWidget::PlaceWidget ( )

inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 142 of file vtkImageTracerWidget.h.

◆ PlaceWidget() [3/3]

void vtkImageTracerWidget::PlaceWidget	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 143 of file vtkImageTracerWidget.h.

◆ SetHandleProperty()

virtual void vtkImageTracerWidget::SetHandleProperty ( vtkProperty * )

virtual

Set/Get the handle properties (the 2D glyphs are the handles).

The properties of the handles when selected and normal can be manipulated.

◆ GetHandleProperty()

virtual vtkProperty * vtkImageTracerWidget::GetHandleProperty ( )

virtual

Set/Get the handle properties (the 2D glyphs are the handles).

The properties of the handles when selected and normal can be manipulated.

◆ SetSelectedHandleProperty()

virtual void vtkImageTracerWidget::SetSelectedHandleProperty ( vtkProperty * )

virtual

Set/Get the handle properties (the 2D glyphs are the handles).

The properties of the handles when selected and normal can be manipulated.

◆ GetSelectedHandleProperty()

virtual vtkProperty * vtkImageTracerWidget::GetSelectedHandleProperty ( )

virtual

Set/Get the handle properties (the 2D glyphs are the handles).

The properties of the handles when selected and normal can be manipulated.

◆ SetLineProperty()

virtual void vtkImageTracerWidget::SetLineProperty ( vtkProperty * )

virtual

Set/Get the line properties.

The properties of the line when selected and unselected can be manipulated.

◆ GetLineProperty()

virtual vtkProperty * vtkImageTracerWidget::GetLineProperty ( )

virtual

Set/Get the line properties.

The properties of the line when selected and unselected can be manipulated.

◆ SetSelectedLineProperty()

virtual void vtkImageTracerWidget::SetSelectedLineProperty ( vtkProperty * )

virtual

Set/Get the line properties.

The properties of the line when selected and unselected can be manipulated.

◆ GetSelectedLineProperty()

virtual vtkProperty * vtkImageTracerWidget::GetSelectedLineProperty ( )

virtual

Set/Get the line properties.

The properties of the line when selected and unselected can be manipulated.

◆ SetViewProp()

void vtkImageTracerWidget::SetViewProp ( vtkProp * prop )

Set the prop, usually a vtkImageActor, to trace over.

◆ SetProjectToPlane()

virtual void vtkImageTracerWidget::SetProjectToPlane ( vtkTypeBool )

virtual

Force handles to be on a specific ortho plane.

Default is Off.

◆ GetProjectToPlane()

virtual vtkTypeBool vtkImageTracerWidget::GetProjectToPlane ( )

virtual

Force handles to be on a specific ortho plane.

Default is Off.

◆ ProjectToPlaneOn()

virtual void vtkImageTracerWidget::ProjectToPlaneOn ( )

virtual

Force handles to be on a specific ortho plane.

Default is Off.

◆ ProjectToPlaneOff()

virtual void vtkImageTracerWidget::ProjectToPlaneOff ( )

virtual

Force handles to be on a specific ortho plane.

Default is Off.

◆ SetProjectionNormal()

virtual void vtkImageTracerWidget::SetProjectionNormal ( int )

virtual

Set the projection normal.

The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively. Since the handles are 2D glyphs, it is necessary to specify a plane on which to generate them, even though ProjectToPlane may be turned off.

◆ GetProjectionNormal()

virtual int vtkImageTracerWidget::GetProjectionNormal ( )

virtual

Set the projection normal.

The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively. Since the handles are 2D glyphs, it is necessary to specify a plane on which to generate them, even though ProjectToPlane may be turned off.

◆ SetProjectionNormalToXAxes()

void vtkImageTracerWidget::SetProjectionNormalToXAxes ( )

inline

Set the projection normal.

The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively. Since the handles are 2D glyphs, it is necessary to specify a plane on which to generate them, even though ProjectToPlane may be turned off.

Definition at line 195 of file vtkImageTracerWidget.h.

◆ SetProjectionNormalToYAxes()

void vtkImageTracerWidget::SetProjectionNormalToYAxes ( )

inline

Set the projection normal.

The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively. Since the handles are 2D glyphs, it is necessary to specify a plane on which to generate them, even though ProjectToPlane may be turned off.

Definition at line 196 of file vtkImageTracerWidget.h.

◆ SetProjectionNormalToZAxes()

void vtkImageTracerWidget::SetProjectionNormalToZAxes ( )

inline

Set the projection normal.

The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively. Since the handles are 2D glyphs, it is necessary to specify a plane on which to generate them, even though ProjectToPlane may be turned off.

Definition at line 197 of file vtkImageTracerWidget.h.

◆ SetProjectionPosition()

void vtkImageTracerWidget::SetProjectionPosition ( double position )

Set the position of the widgets' handles in terms of a plane's position.

e.g., if ProjectionNormal is 0, all of the x-coordinate values of the handles are set to ProjectionPosition. No attempt is made to ensure that the position is within the bounds of either the underlying image data or the prop on which tracing is performed.

◆ GetProjectionPosition()

virtual double vtkImageTracerWidget::GetProjectionPosition ( )

virtual

Set the position of the widgets' handles in terms of a plane's position.

e.g., if ProjectionNormal is 0, all of the x-coordinate values of the handles are set to ProjectionPosition. No attempt is made to ensure that the position is within the bounds of either the underlying image data or the prop on which tracing is performed.

◆ SetSnapToImage()

void vtkImageTracerWidget::SetSnapToImage ( vtkTypeBool snap )

Force snapping to image data while tracing.

Default is Off.

◆ GetSnapToImage()

virtual vtkTypeBool vtkImageTracerWidget::GetSnapToImage ( )

virtual

Force snapping to image data while tracing.

Default is Off.

◆ SnapToImageOn()

virtual void vtkImageTracerWidget::SnapToImageOn ( )

virtual

Force snapping to image data while tracing.

Default is Off.

◆ SnapToImageOff()

virtual void vtkImageTracerWidget::SnapToImageOff ( )

virtual

Force snapping to image data while tracing.

Default is Off.

◆ SetAutoClose()

virtual void vtkImageTracerWidget::SetAutoClose ( vtkTypeBool )

virtual

In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

Default is Off.

◆ GetAutoClose()

virtual vtkTypeBool vtkImageTracerWidget::GetAutoClose ( )

virtual

In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

Default is Off.

◆ AutoCloseOn()

virtual void vtkImageTracerWidget::AutoCloseOn ( )

virtual

In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

Default is Off.

◆ AutoCloseOff()

virtual void vtkImageTracerWidget::AutoCloseOff ( )

virtual

In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points.

Default is Off.

◆ SetCaptureRadius()

virtual void vtkImageTracerWidget::SetCaptureRadius ( double )

virtual

Set/Get the capture radius for automatic path closing.

For image data, capture radius should be half the distance between voxel/pixel centers. Default is 1.0

◆ GetCaptureRadius()

virtual double vtkImageTracerWidget::GetCaptureRadius ( )

virtual

Set/Get the capture radius for automatic path closing.

For image data, capture radius should be half the distance between voxel/pixel centers. Default is 1.0

◆ GetPath()

void vtkImageTracerWidget::GetPath ( vtkPolyData * pd )

Grab the points and lines that define the traced path.

These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and cells representing the line are added to it.

◆ GetGlyphSource()

vtkGlyphSource2D * vtkImageTracerWidget::GetGlyphSource ( )

inline

Get the handles' geometric representation via vtkGlyphSource2D.

Definition at line 254 of file vtkImageTracerWidget.h.

◆ SetImageSnapType()

virtual void vtkImageTracerWidget::SetImageSnapType ( int )

virtual

Set/Get the type of snapping to image data: center of a pixel/voxel or nearest point defining a pixel/voxel.

◆ GetImageSnapType()

virtual int vtkImageTracerWidget::GetImageSnapType ( )

virtual

Set/Get the type of snapping to image data: center of a pixel/voxel or nearest point defining a pixel/voxel.

◆ SetHandlePosition() [1/2]

void vtkImageTracerWidget::SetHandlePosition	(	int	handle,
		double	xyz[3]
	)

Set/Get the handle position in terms of a zero-based array of handles.

◆ SetHandlePosition() [2/2]

void vtkImageTracerWidget::SetHandlePosition	(	int	handle,
		double	x,
		double	y,
		double	z
	)

Set/Get the handle position in terms of a zero-based array of handles.

◆ GetHandlePosition() [1/2]

void vtkImageTracerWidget::GetHandlePosition	(	int	handle,
		double	xyz[3]
	)

Set/Get the handle position in terms of a zero-based array of handles.

◆ GetHandlePosition() [2/2]

double * vtkImageTracerWidget::GetHandlePosition ( int handle )

Set/Get the handle position in terms of a zero-based array of handles.

◆ GetNumberOfHandles()

virtual int vtkImageTracerWidget::GetNumberOfHandles ( )

virtual

Get the number of handles.

◆ SetInteraction()

void vtkImageTracerWidget::SetInteraction ( vtkTypeBool interact )

Enable/disable mouse interaction when the widget is visible.

◆ GetInteraction()

virtual vtkTypeBool vtkImageTracerWidget::GetInteraction ( )

virtual

Enable/disable mouse interaction when the widget is visible.

◆ InteractionOn()

virtual void vtkImageTracerWidget::InteractionOn ( )

virtual

Enable/disable mouse interaction when the widget is visible.

◆ InteractionOff()

virtual void vtkImageTracerWidget::InteractionOff ( )

virtual

Enable/disable mouse interaction when the widget is visible.

◆ InitializeHandles()

void vtkImageTracerWidget::InitializeHandles ( vtkPoints * )

Initialize the widget with a set of points and generate lines between them.

If AutoClose is on it will handle the case wherein the first and last points are congruent.

◆ IsClosed()

int vtkImageTracerWidget::IsClosed ( )

Is the path closed or open?