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

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

#include <vtkImageTracerWidget.h>

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

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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageTracerWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetViewProp (vtkProp *prop)
 Set the prop, usually a vtkImageActor, to trace over. More...
 
void GetPath (vtkPolyData *pd)
 Grab the points and lines that define the traced path. More...
 
vtkGlyphSource2DGetGlyphSource ()
 Get the handles' geometric representation via vtkGlyphSource2D. More...
 
void InitializeHandles (vtkPoints *)
 Initialize the widget with a set of points and generate lines between them. More...
 
int IsClosed ()
 Is the path closed or open? More...
 
void SetEnabled (int) override
 Methods that satisfy the superclass' API. More...
 
void PlaceWidget (double bounds[6]) override
 Methods that satisfy the superclass' API. More...
 
void PlaceWidget () override
 Methods that satisfy the superclass' API. More...
 
void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
 Methods that satisfy the superclass' API. More...
 
virtual void SetHandleProperty (vtkProperty *)
 Set/Get the handle properties (the 2D glyphs are the handles). More...
 
virtual vtkPropertyGetHandleProperty ()
 Set/Get the handle properties (the 2D glyphs are the handles). More...
 
virtual void SetSelectedHandleProperty (vtkProperty *)
 Set/Get the handle properties (the 2D glyphs are the handles). More...
 
virtual vtkPropertyGetSelectedHandleProperty ()
 Set/Get the handle properties (the 2D glyphs are the handles). More...
 
virtual void SetLineProperty (vtkProperty *)
 Set/Get the line properties. More...
 
virtual vtkPropertyGetLineProperty ()
 Set/Get the line properties. More...
 
virtual void SetSelectedLineProperty (vtkProperty *)
 Set/Get the line properties. More...
 
virtual vtkPropertyGetSelectedLineProperty ()
 Set/Get the line properties. More...
 
virtual void SetProjectToPlane (int)
 Force handles to be on a specific ortho plane. More...
 
virtual int GetProjectToPlane ()
 Force handles to be on a specific ortho plane. More...
 
virtual void ProjectToPlaneOn ()
 Force handles to be on a specific ortho plane. More...
 
virtual void ProjectToPlaneOff ()
 Force handles to be on a specific ortho plane. More...
 
virtual void SetProjectionNormal (int)
 Set the projection normal. More...
 
virtual int GetProjectionNormal ()
 Set the projection normal. More...
 
void SetProjectionNormalToXAxes ()
 Set the projection normal. More...
 
void SetProjectionNormalToYAxes ()
 Set the projection normal. More...
 
void SetProjectionNormalToZAxes ()
 Set the projection normal. More...
 
void SetProjectionPosition (double position)
 Set the position of the widgets' handles in terms of a plane's position. More...
 
virtual double GetProjectionPosition ()
 Set the position of the widgets' handles in terms of a plane's position. More...
 
void SetSnapToImage (int snap)
 Force snapping to image data while tracing. More...
 
virtual int GetSnapToImage ()
 Force snapping to image data while tracing. More...
 
virtual void SnapToImageOn ()
 Force snapping to image data while tracing. More...
 
virtual void SnapToImageOff ()
 Force snapping to image data while tracing. More...
 
virtual void SetAutoClose (int)
 In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points. More...
 
virtual int GetAutoClose ()
 In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points. More...
 
virtual void AutoCloseOn ()
 In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points. More...
 
virtual void AutoCloseOff ()
 In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points. More...
 
virtual void SetCaptureRadius (double)
 Set/Get the capture radius for automatic path closing. More...
 
virtual double GetCaptureRadius ()
 Set/Get the capture radius for automatic path closing. More...
 
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. More...
 
virtual int GetImageSnapType ()
 Set/Get the type of snapping to image data: center of a pixel/voxel or nearest point defining a pixel/voxel. More...
 
void SetHandlePosition (int handle, double xyz[3])
 Set/Get the handle position in terms of a zero-based array of handles. More...
 
void SetHandlePosition (int handle, double x, double y, double z)
 Set/Get the handle position in terms of a zero-based array of handles. More...
 
void GetHandlePosition (int handle, double xyz[3])
 Set/Get the handle position in terms of a zero-based array of handles. More...
 
doubleGetHandlePosition (int handle)
 Set/Get the handle position in terms of a zero-based array of handles. More...
 
virtual int GetNumberOfHandles ()
 Get the number of handles. More...
 
void SetInteraction (int interact)
 Enable/disable mouse interaction when the widget is visible. More...
 
virtual int GetInteraction ()
 Enable/disable mouse interaction when the widget is visible. More...
 
virtual void InteractionOn ()
 Enable/disable mouse interaction when the widget is visible. More...
 
virtual void InteractionOff ()
 Enable/disable mouse interaction when the widget is visible. More...
 
virtual void SetHandleLeftMouseButton (int)
 Enable/Disable mouse button events. More...
 
virtual int GetHandleLeftMouseButton ()
 Enable/Disable mouse button events. More...
 
virtual void HandleLeftMouseButtonOn ()
 Enable/Disable mouse button events. More...
 
virtual void HandleLeftMouseButtonOff ()
 Enable/Disable mouse button events. More...
 
virtual void SetHandleMiddleMouseButton (int)
 Enable/Disable mouse button events. More...
 
virtual int GetHandleMiddleMouseButton ()
 Enable/Disable mouse button events. More...
 
virtual void HandleMiddleMouseButtonOn ()
 Enable/Disable mouse button events. More...
 
virtual void HandleMiddleMouseButtonOff ()
 Enable/Disable mouse button events. More...
 
virtual void SetHandleRightMouseButton (int)
 Enable/Disable mouse button events. More...
 
virtual int GetHandleRightMouseButton ()
 Enable/Disable mouse button events. More...
 
virtual void HandleRightMouseButtonOn ()
 Enable/Disable mouse button events. More...
 
virtual void HandleRightMouseButtonOff ()
 Enable/Disable mouse button events. More...
 
- Public Member Functions inherited from vtk3DWidget
vtk3DWidgetNewInstance () const
 
virtual void SetProp3D (vtkProp3D *)
 Specify a vtkProp3D around which to place the widget. More...
 
virtual vtkProp3DGetProp3D ()
 Specify a vtkProp3D around which to place the widget. More...
 
virtual void SetInputData (vtkDataSet *)
 Specify the input dataset. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *)
 Specify the input dataset. More...
 
virtual vtkDataSetGetInput ()
 Specify the input dataset. More...
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget. More...
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget. 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 void OnChar ()
 Sets up the keypress-i event. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor. More...
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetPickingManaged (bool)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (int)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual int GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
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 ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. 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 ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
- 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...
 
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)
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkImageTracerWidgetNew ()
 Instantiate the object. More...
 
static int IsTypeOf (const char *type)
 
static vtkImageTracerWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtk3DWidget
static int IsTypeOf (const char *type)
 
static vtk3DWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static int 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])
 Convenience methods for outside classes. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void CreateDefaultProperties ()
 
- Protected Member Functions inherited from vtk3DWidget
 vtk3DWidget ()
 
 ~vtk3DWidget () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
double SizeHandles (double factor)
 
void UpdateInput ()
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickersModified ()
 Update the pickers registered in the Picking Manager when pickers are modified. 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)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
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])
 Helper method for subclasses. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 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. More...
 

Protected Attributes

int State
 
int Interaction
 
int ProjectionNormal
 
double ProjectionPosition
 
int ProjectToPlane
 
int ImageSnapType
 
int SnapToImage
 
double CaptureRadius
 
int AutoClose
 
int IsSnapping
 
int LastX
 
int LastY
 
vtkActor ** Handle
 
vtkPolyData ** HandleGeometry
 
vtkGlyphSource2DHandleGenerator
 
vtkTransformPolyDataFilterTransformFilter
 
vtkTransformTransform
 
vtkFloatArrayTemporaryHandlePoints
 
int NumberOfHandles
 
vtkActorCurrentHandle
 
int CurrentHandleIndex
 
vtkPropViewProp
 
vtkPropPickerPropPicker
 
vtkPointsLinePoints
 
vtkCellArrayLineCells
 
vtkActorLineActor
 
vtkPolyDataLineData
 
vtkIdType CurrentPoints [2]
 
int PickCount
 
vtkCellPickerHandlePicker
 
vtkCellPickerLinePicker
 
vtkAbstractPropPickerCurrentPicker
 
vtkPropertyHandleProperty
 
vtkPropertySelectedHandleProperty
 
vtkPropertyLineProperty
 
vtkPropertySelectedLineProperty
 
int HandleLeftMouseButton
 
int HandleMiddleMouseButton
 
int HandleRightMouseButton
 
- Protected Attributes inherited from vtk3DWidget
vtkProp3DProp3D
 
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
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
int 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
vtkAtomicInt32 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
Examples:
vtkImageTracerWidget (Examples)
Tests:
vtkImageTracerWidget (Tests)

Definition at line 86 of file vtkImageTracerWidget.h.

Member Typedef Documentation

Definition at line 94 of file vtkImageTracerWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Tracing 
Snapping 
Erasing 
Inserting 
Moving 
Translating 
Outside 

Definition at line 297 of file vtkImageTracerWidget.h.

Constructor & Destructor Documentation

vtkImageTracerWidget::vtkImageTracerWidget ( )
protected
vtkImageTracerWidget::~vtkImageTracerWidget ( )
overrideprotected

Member Function Documentation

static vtkImageTracerWidget* vtkImageTracerWidget::New ( )
static

Instantiate the object.

static int vtkImageTracerWidget::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkImageTracerWidget* vtkImageTracerWidget::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImageTracerWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtk3DWidget.

vtkImageTracerWidget* vtkImageTracerWidget::NewInstance ( ) const
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.

void vtkImageTracerWidget::SetEnabled ( int  )
overridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkImageTracerWidget::PlaceWidget ( )
inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 103 of file vtkImageTracerWidget.h.

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 105 of file vtkImageTracerWidget.h.

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.

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.

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.

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.

virtual void vtkImageTracerWidget::SetLineProperty ( vtkProperty )
virtual

Set/Get the line properties.

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

virtual vtkProperty* vtkImageTracerWidget::GetLineProperty ( )
virtual

Set/Get the line properties.

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

virtual void vtkImageTracerWidget::SetSelectedLineProperty ( vtkProperty )
virtual

Set/Get the line properties.

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

virtual vtkProperty* vtkImageTracerWidget::GetSelectedLineProperty ( )
virtual

Set/Get the line properties.

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

void vtkImageTracerWidget::SetViewProp ( vtkProp prop)

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

virtual void vtkImageTracerWidget::SetProjectToPlane ( int  )
virtual

Force handles to be on a specific ortho plane.

Default is Off.

virtual int vtkImageTracerWidget::GetProjectToPlane ( )
virtual

Force handles to be on a specific ortho plane.

Default is Off.

virtual void vtkImageTracerWidget::ProjectToPlaneOn ( )
virtual

Force handles to be on a specific ortho plane.

Default is Off.

virtual void vtkImageTracerWidget::ProjectToPlaneOff ( )
virtual

Force handles to be on a specific ortho plane.

Default is Off.

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.

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.

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 155 of file vtkImageTracerWidget.h.

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 157 of file vtkImageTracerWidget.h.

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 159 of file vtkImageTracerWidget.h.

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.

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.

void vtkImageTracerWidget::SetSnapToImage ( int  snap)

Force snapping to image data while tracing.

Default is Off.

virtual int vtkImageTracerWidget::GetSnapToImage ( )
virtual

Force snapping to image data while tracing.

Default is Off.

virtual void vtkImageTracerWidget::SnapToImageOn ( )
virtual

Force snapping to image data while tracing.

Default is Off.

virtual void vtkImageTracerWidget::SnapToImageOff ( )
virtual

Force snapping to image data while tracing.

Default is Off.

virtual void vtkImageTracerWidget::SetAutoClose ( int  )
virtual

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

Default is Off.

virtual int vtkImageTracerWidget::GetAutoClose ( )
virtual

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

Default is Off.

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.

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.

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

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

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.

vtkGlyphSource2D* vtkImageTracerWidget::GetGlyphSource ( )
inline

Get the handles' geometric representation via vtkGlyphSource2D.

Definition at line 217 of file vtkImageTracerWidget.h.

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.

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.

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

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

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.

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

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

double* vtkImageTracerWidget::GetHandlePosition ( int  handle)

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

virtual int vtkImageTracerWidget::GetNumberOfHandles ( )
virtual

Get the number of handles.

void vtkImageTracerWidget::SetInteraction ( int  interact)

Enable/disable mouse interaction when the widget is visible.

virtual int vtkImageTracerWidget::GetInteraction ( )
virtual

Enable/disable mouse interaction when the widget is visible.

virtual void vtkImageTracerWidget::InteractionOn ( )
virtual

Enable/disable mouse interaction when the widget is visible.

virtual void vtkImageTracerWidget::InteractionOff ( )
virtual

Enable/disable mouse interaction when the widget is visible.

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.

int vtkImageTracerWidget::IsClosed ( )

Is the path closed or open?

virtual void vtkImageTracerWidget::SetHandleLeftMouseButton ( int  )
virtual

Enable/Disable mouse button events.

virtual int vtkImageTracerWidget::GetHandleLeftMouseButton ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleLeftMouseButtonOn ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleLeftMouseButtonOff ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::SetHandleMiddleMouseButton ( int  )
virtual

Enable/Disable mouse button events.

virtual int vtkImageTracerWidget::GetHandleMiddleMouseButton ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleMiddleMouseButtonOn ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleMiddleMouseButtonOff ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::SetHandleRightMouseButton ( int  )
virtual

Enable/Disable mouse button events.

virtual int vtkImageTracerWidget::GetHandleRightMouseButton ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleRightMouseButtonOn ( )
virtual

Enable/Disable mouse button events.

virtual void vtkImageTracerWidget::HandleRightMouseButtonOff ( )
virtual

Enable/Disable mouse button events.

static void vtkImageTracerWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected
void vtkImageTracerWidget::OnLeftButtonDown ( )
protected
void vtkImageTracerWidget::OnLeftButtonUp ( )
protected
void vtkImageTracerWidget::OnMiddleButtonDown ( )
protected
void vtkImageTracerWidget::OnMiddleButtonUp ( )
protected
void vtkImageTracerWidget::OnRightButtonDown ( )
protected
void vtkImageTracerWidget::OnRightButtonUp ( )
protected
void vtkImageTracerWidget::OnMouseMove ( )
protected
void vtkImageTracerWidget::AddObservers ( )
protected
void vtkImageTracerWidget::Trace ( int  ,
int   
)
protected
void vtkImageTracerWidget::Snap ( double )
protected
void vtkImageTracerWidget::MovePoint ( const double ,
const double  
)
protected
void vtkImageTracerWidget::Translate ( const double ,
const double  
)
protected
void vtkImageTracerWidget::ClosePath ( )
protected
void vtkImageTracerWidget::AppendHandles ( double )
protected
void vtkImageTracerWidget::ResetHandles ( )
protected
void vtkImageTracerWidget::AllocateHandles ( const int )
protected
void vtkImageTracerWidget::AdjustHandlePosition ( const int ,
double  
)
protected
int vtkImageTracerWidget::HighlightHandle ( vtkProp )
protected
void vtkImageTracerWidget::EraseHandle ( const int )
protected
void vtkImageTracerWidget::SizeHandles ( )
overrideprotectedvirtual

Reimplemented from vtk3DWidget.

void vtkImageTracerWidget::InsertHandleOnLine ( double )
protected
void vtkImageTracerWidget::HighlightLine ( const int )
protected
void vtkImageTracerWidget::BuildLinesFromHandles ( )
protected
void vtkImageTracerWidget::ResetLine ( double )
protected
void vtkImageTracerWidget::AppendLine ( double )
protected
void vtkImageTracerWidget::RegisterPickers ( )
overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

void vtkImageTracerWidget::CreateDefaultProperties ( )
protected

Member Data Documentation

int vtkImageTracerWidget::State
protected

Definition at line 296 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::Interaction
protected

Definition at line 327 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::ProjectionNormal
protected

Definition at line 328 of file vtkImageTracerWidget.h.

double vtkImageTracerWidget::ProjectionPosition
protected

Definition at line 329 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::ProjectToPlane
protected

Definition at line 330 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::ImageSnapType
protected

Definition at line 331 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::SnapToImage
protected

Definition at line 332 of file vtkImageTracerWidget.h.

double vtkImageTracerWidget::CaptureRadius
protected

Definition at line 333 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::AutoClose
protected

Definition at line 334 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::IsSnapping
protected

Definition at line 335 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::LastX
protected

Definition at line 336 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::LastY
protected

Definition at line 337 of file vtkImageTracerWidget.h.

vtkActor** vtkImageTracerWidget::Handle
protected

Definition at line 346 of file vtkImageTracerWidget.h.

vtkPolyData** vtkImageTracerWidget::HandleGeometry
protected

Definition at line 347 of file vtkImageTracerWidget.h.

vtkGlyphSource2D* vtkImageTracerWidget::HandleGenerator
protected

Definition at line 348 of file vtkImageTracerWidget.h.

vtkTransformPolyDataFilter* vtkImageTracerWidget::TransformFilter
protected

Definition at line 351 of file vtkImageTracerWidget.h.

vtkTransform* vtkImageTracerWidget::Transform
protected

Definition at line 352 of file vtkImageTracerWidget.h.

vtkFloatArray* vtkImageTracerWidget::TemporaryHandlePoints
protected

Definition at line 353 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::NumberOfHandles
protected

Definition at line 364 of file vtkImageTracerWidget.h.

vtkActor* vtkImageTracerWidget::CurrentHandle
protected

Definition at line 365 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::CurrentHandleIndex
protected

Definition at line 366 of file vtkImageTracerWidget.h.

vtkProp* vtkImageTracerWidget::ViewProp
protected

Definition at line 368 of file vtkImageTracerWidget.h.

vtkPropPicker* vtkImageTracerWidget::PropPicker
protected

Definition at line 369 of file vtkImageTracerWidget.h.

vtkPoints* vtkImageTracerWidget::LinePoints
protected

Definition at line 372 of file vtkImageTracerWidget.h.

vtkCellArray* vtkImageTracerWidget::LineCells
protected

Definition at line 373 of file vtkImageTracerWidget.h.

vtkActor* vtkImageTracerWidget::LineActor
protected

Definition at line 374 of file vtkImageTracerWidget.h.

vtkPolyData* vtkImageTracerWidget::LineData
protected

Definition at line 375 of file vtkImageTracerWidget.h.

vtkIdType vtkImageTracerWidget::CurrentPoints[2]
protected

Definition at line 376 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::PickCount
protected

Definition at line 382 of file vtkImageTracerWidget.h.

vtkCellPicker* vtkImageTracerWidget::HandlePicker
protected

Definition at line 385 of file vtkImageTracerWidget.h.

vtkCellPicker* vtkImageTracerWidget::LinePicker
protected

Definition at line 386 of file vtkImageTracerWidget.h.

vtkAbstractPropPicker* vtkImageTracerWidget::CurrentPicker
protected

Definition at line 387 of file vtkImageTracerWidget.h.

vtkProperty* vtkImageTracerWidget::HandleProperty
protected

Definition at line 394 of file vtkImageTracerWidget.h.

vtkProperty* vtkImageTracerWidget::SelectedHandleProperty
protected

Definition at line 395 of file vtkImageTracerWidget.h.

vtkProperty* vtkImageTracerWidget::LineProperty
protected

Definition at line 396 of file vtkImageTracerWidget.h.

vtkProperty* vtkImageTracerWidget::SelectedLineProperty
protected

Definition at line 397 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::HandleLeftMouseButton
protected

Definition at line 401 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::HandleMiddleMouseButton
protected

Definition at line 402 of file vtkImageTracerWidget.h.

int vtkImageTracerWidget::HandleRightMouseButton
protected

Definition at line 403 of file vtkImageTracerWidget.h.


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