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 vtkTypeBool 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 SetEnabled (int) override
 Methods that satisfy the superclass' API. More...
 
void PlaceWidget (double bounds[6]) override
 This method is used to initially place the widget. More...
 
void PlaceWidget () override
 
void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
 
virtual void SetHandleProperty (vtkProperty *)
 Set/Get the handle properties (the 2D glyphs are the handles). More...
 
virtual vtkPropertyGetHandleProperty ()
 
virtual void SetSelectedHandleProperty (vtkProperty *)
 
virtual vtkPropertyGetSelectedHandleProperty ()
 
virtual void SetLineProperty (vtkProperty *)
 Set/Get the line properties. More...
 
virtual vtkPropertyGetLineProperty ()
 
virtual void SetSelectedLineProperty (vtkProperty *)
 
virtual vtkPropertyGetSelectedLineProperty ()
 
void SetViewProp (vtkProp *prop)
 Set the prop, usually a vtkImageActor, to trace over. More...
 
virtual void SetProjectToPlane (vtkTypeBool)
 Force handles to be on a specific ortho plane. More...
 
virtual vtkTypeBool GetProjectToPlane ()
 
virtual void ProjectToPlaneOn ()
 
virtual void ProjectToPlaneOff ()
 
virtual void SetProjectionNormal (int)
 Set the projection normal. More...
 
virtual int GetProjectionNormal ()
 
void SetProjectionNormalToXAxes ()
 
void SetProjectionNormalToYAxes ()
 
void SetProjectionNormalToZAxes ()
 
void SetProjectionPosition (double position)
 Set the position of the widgets' handles in terms of a plane's position. More...
 
virtual double GetProjectionPosition ()
 
void SetSnapToImage (vtkTypeBool snap)
 Force snapping to image data while tracing. More...
 
virtual vtkTypeBool GetSnapToImage ()
 
virtual void SnapToImageOn ()
 
virtual void SnapToImageOff ()
 
virtual void SetAutoClose (vtkTypeBool)
 In concert with a CaptureRadius value, automatically form a closed path by connecting first to last path points. More...
 
virtual vtkTypeBool GetAutoClose ()
 
virtual void AutoCloseOn ()
 
virtual void AutoCloseOff ()
 
virtual void SetCaptureRadius (double)
 Set/Get the capture radius for automatic path closing. More...
 
virtual double GetCaptureRadius ()
 
void GetPath (vtkPolyData *pd)
 Grab the points and lines that define the traced path. More...
 
vtkGlyphSource2DGetGlyphSource ()
 Get the handles' geometric representation via vtkGlyphSource2D. 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 ()
 
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)
 
void GetHandlePosition (int handle, double xyz[3])
 
double * GetHandlePosition (int handle)
 
virtual int GetNumberOfHandles ()
 Get the number of handles. More...
 
void SetInteraction (vtkTypeBool interact)
 Enable/disable mouse interaction when the widget is visible. More...
 
virtual vtkTypeBool GetInteraction ()
 
virtual void InteractionOn ()
 
virtual void InteractionOff ()
 
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...
 
virtual void SetHandleLeftMouseButton (vtkTypeBool)
 Enable/Disable mouse button events. More...
 
virtual vtkTypeBool GetHandleLeftMouseButton ()
 
virtual void HandleLeftMouseButtonOn ()
 
virtual void HandleLeftMouseButtonOff ()
 
virtual void SetHandleMiddleMouseButton (vtkTypeBool)
 
virtual vtkTypeBool GetHandleMiddleMouseButton ()
 
virtual void HandleMiddleMouseButtonOn ()
 
virtual void HandleMiddleMouseButtonOff ()
 
virtual void SetHandleRightMouseButton (vtkTypeBool)
 
virtual vtkTypeBool GetHandleRightMouseButton ()
 
virtual void HandleRightMouseButtonOn ()
 
virtual void HandleRightMouseButtonOff ()
 
- Public Member Functions inherited from vtk3DWidget
vtk3DWidgetNewInstance () const
 
virtual void SetProp3D (vtkProp3D *)
 Specify a vtkProp3D around which to place the widget. More...
 
virtual vtkProp3DGetProp3D ()
 
virtual void SetInputData (vtkDataSet *)
 Specify the input dataset. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *)
 
virtual vtkDataSetGetInput ()
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 
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 ()
 
- 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 SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
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 SetCurrentRenderer (vtkRenderer *)
 
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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageTracerWidgetNew ()
 Instantiate the object. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageTracerWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtk3DWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtk3DWidgetSafeDownCast (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 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
 
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])
 
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 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
 
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
 
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
 
vtkTypeBool HandleLeftMouseButton
 
vtkTypeBool HandleMiddleMouseButton
 
vtkTypeBool 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
 
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

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

Definition at line 80 of file vtkImageTracerWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 88 of file vtkImageTracerWidget.h.

Member Enumeration Documentation

◆ WidgetState

Enumerator
Start 
Tracing 
Snapping 
Erasing 
Inserting 
Moving 
Translating 
Outside 

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

This method is used to initially place the widget.

The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Implements vtk3DWidget.

◆ PlaceWidget() [2/3]

void vtkImageTracerWidget::PlaceWidget ( )
inlineoverridevirtual

Reimplemented from vtk3DWidget.

Definition at line 97 of file vtkImageTracerWidget.h.

◆ PlaceWidget() [3/3]

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

Reimplemented from vtk3DWidget.

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

◆ SetSelectedHandleProperty()

virtual void vtkImageTracerWidget::SetSelectedHandleProperty ( vtkProperty )
virtual

◆ GetSelectedHandleProperty()

virtual vtkProperty* vtkImageTracerWidget::GetSelectedHandleProperty ( )
virtual

◆ 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

◆ SetSelectedLineProperty()

virtual void vtkImageTracerWidget::SetSelectedLineProperty ( vtkProperty )
virtual

◆ GetSelectedLineProperty()

virtual vtkProperty* vtkImageTracerWidget::GetSelectedLineProperty ( )
virtual

◆ 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

◆ ProjectToPlaneOn()

virtual void vtkImageTracerWidget::ProjectToPlaneOn ( )
virtual

◆ ProjectToPlaneOff()

virtual void vtkImageTracerWidget::ProjectToPlaneOff ( )
virtual

◆ 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

◆ SetProjectionNormalToXAxes()

void vtkImageTracerWidget::SetProjectionNormalToXAxes ( )
inline

Definition at line 150 of file vtkImageTracerWidget.h.

◆ SetProjectionNormalToYAxes()

void vtkImageTracerWidget::SetProjectionNormalToYAxes ( )
inline

Definition at line 151 of file vtkImageTracerWidget.h.

◆ SetProjectionNormalToZAxes()

void vtkImageTracerWidget::SetProjectionNormalToZAxes ( )
inline

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

◆ SetSnapToImage()

void vtkImageTracerWidget::SetSnapToImage ( vtkTypeBool  snap)

Force snapping to image data while tracing.

Default is Off.

◆ GetSnapToImage()

virtual vtkTypeBool vtkImageTracerWidget::GetSnapToImage ( )
virtual

◆ SnapToImageOn()

virtual void vtkImageTracerWidget::SnapToImageOn ( )
virtual

◆ SnapToImageOff()

virtual void vtkImageTracerWidget::SnapToImageOff ( )
virtual

◆ 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

◆ AutoCloseOn()

virtual void vtkImageTracerWidget::AutoCloseOn ( )
virtual

◆ AutoCloseOff()

virtual void vtkImageTracerWidget::AutoCloseOff ( )
virtual

◆ 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

◆ 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 209 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

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

◆ GetHandlePosition() [1/2]

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

◆ GetHandlePosition() [2/2]

double* vtkImageTracerWidget::GetHandlePosition ( int  handle)

◆ 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

◆ InteractionOn()

virtual void vtkImageTracerWidget::InteractionOn ( )
virtual

◆ InteractionOff()

virtual void vtkImageTracerWidget::InteractionOff ( )
virtual

◆ 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?

◆ SetHandleLeftMouseButton()

virtual void vtkImageTracerWidget::SetHandleLeftMouseButton ( vtkTypeBool  )
virtual

Enable/Disable mouse button events.

◆ GetHandleLeftMouseButton()

virtual vtkTypeBool vtkImageTracerWidget::GetHandleLeftMouseButton ( )
virtual

◆ HandleLeftMouseButtonOn()

virtual void vtkImageTracerWidget::HandleLeftMouseButtonOn ( )
virtual

◆ HandleLeftMouseButtonOff()

virtual void vtkImageTracerWidget::HandleLeftMouseButtonOff ( )
virtual

◆ SetHandleMiddleMouseButton()

virtual void vtkImageTracerWidget::SetHandleMiddleMouseButton ( vtkTypeBool  )
virtual

◆ GetHandleMiddleMouseButton()

virtual vtkTypeBool vtkImageTracerWidget::GetHandleMiddleMouseButton ( )
virtual

◆ HandleMiddleMouseButtonOn()

virtual void vtkImageTracerWidget::HandleMiddleMouseButtonOn ( )
virtual

◆ HandleMiddleMouseButtonOff()

virtual void vtkImageTracerWidget::HandleMiddleMouseButtonOff ( )
virtual

◆ SetHandleRightMouseButton()

virtual void vtkImageTracerWidget::SetHandleRightMouseButton ( vtkTypeBool  )
virtual

◆ GetHandleRightMouseButton()

virtual vtkTypeBool vtkImageTracerWidget::GetHandleRightMouseButton ( )
virtual

◆ HandleRightMouseButtonOn()

virtual void vtkImageTracerWidget::HandleRightMouseButtonOn ( )
virtual

◆ HandleRightMouseButtonOff()

virtual void vtkImageTracerWidget::HandleRightMouseButtonOff ( )
virtual

◆ ProcessEvents()

static void vtkImageTracerWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

◆ OnLeftButtonDown()

void vtkImageTracerWidget::OnLeftButtonDown ( )
protected

◆ OnLeftButtonUp()

void vtkImageTracerWidget::OnLeftButtonUp ( )
protected

◆ OnMiddleButtonDown()

void vtkImageTracerWidget::OnMiddleButtonDown ( )
protected

◆ OnMiddleButtonUp()

void vtkImageTracerWidget::OnMiddleButtonUp ( )
protected

◆ OnRightButtonDown()

void vtkImageTracerWidget::OnRightButtonDown ( )
protected

◆ OnRightButtonUp()

void vtkImageTracerWidget::OnRightButtonUp ( )
protected

◆ OnMouseMove()

void vtkImageTracerWidget::OnMouseMove ( )
protected

◆ AddObservers()

void vtkImageTracerWidget::AddObservers ( )
protected

◆ Trace()

void vtkImageTracerWidget::Trace ( int  ,
int   
)
protected

◆ Snap()

void vtkImageTracerWidget::Snap ( double *  )
protected

◆ MovePoint()

void vtkImageTracerWidget::MovePoint ( const double *  ,
const double *   
)
protected

◆ Translate()

void vtkImageTracerWidget::Translate ( const double *  ,
const double *   
)
protected

◆ ClosePath()

void vtkImageTracerWidget::ClosePath ( )
protected

◆ AppendHandles()

void vtkImageTracerWidget::AppendHandles ( double *  )
protected

◆ ResetHandles()

void vtkImageTracerWidget::ResetHandles ( )
protected

◆ AllocateHandles()

void vtkImageTracerWidget::AllocateHandles ( const int &  )
protected

◆ AdjustHandlePosition()

void vtkImageTracerWidget::AdjustHandlePosition ( const int &  ,
double *   
)
protected

◆ HighlightHandle()

int vtkImageTracerWidget::HighlightHandle ( vtkProp )
protected

◆ EraseHandle()

void vtkImageTracerWidget::EraseHandle ( const int &  )
protected

◆ SizeHandles()

void vtkImageTracerWidget::SizeHandles ( )
overrideprotectedvirtual

Reimplemented from vtk3DWidget.

◆ InsertHandleOnLine()

void vtkImageTracerWidget::InsertHandleOnLine ( double *  )
protected

◆ HighlightLine()

void vtkImageTracerWidget::HighlightLine ( const int &  )
protected

◆ BuildLinesFromHandles()

void vtkImageTracerWidget::BuildLinesFromHandles ( )
protected

◆ ResetLine()

void vtkImageTracerWidget::ResetLine ( double *  )
protected

◆ AppendLine()

void vtkImageTracerWidget::AppendLine ( double *  )
protected

◆ RegisterPickers()

void vtkImageTracerWidget::RegisterPickers ( )
overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

◆ CreateDefaultProperties()

void vtkImageTracerWidget::CreateDefaultProperties ( )
protected

Member Data Documentation

◆ State

int vtkImageTracerWidget::State
protected

Definition at line 278 of file vtkImageTracerWidget.h.

◆ Interaction

vtkTypeBool vtkImageTracerWidget::Interaction
protected

Definition at line 307 of file vtkImageTracerWidget.h.

◆ ProjectionNormal

int vtkImageTracerWidget::ProjectionNormal
protected

Definition at line 308 of file vtkImageTracerWidget.h.

◆ ProjectionPosition

double vtkImageTracerWidget::ProjectionPosition
protected

Definition at line 309 of file vtkImageTracerWidget.h.

◆ ProjectToPlane

vtkTypeBool vtkImageTracerWidget::ProjectToPlane
protected

Definition at line 310 of file vtkImageTracerWidget.h.

◆ ImageSnapType

int vtkImageTracerWidget::ImageSnapType
protected

Definition at line 311 of file vtkImageTracerWidget.h.

◆ SnapToImage

vtkTypeBool vtkImageTracerWidget::SnapToImage
protected

Definition at line 312 of file vtkImageTracerWidget.h.

◆ CaptureRadius

double vtkImageTracerWidget::CaptureRadius
protected

Definition at line 313 of file vtkImageTracerWidget.h.

◆ AutoClose

vtkTypeBool vtkImageTracerWidget::AutoClose
protected

Definition at line 314 of file vtkImageTracerWidget.h.

◆ IsSnapping

int vtkImageTracerWidget::IsSnapping
protected

Definition at line 315 of file vtkImageTracerWidget.h.

◆ LastX

int vtkImageTracerWidget::LastX
protected

Definition at line 316 of file vtkImageTracerWidget.h.

◆ LastY

int vtkImageTracerWidget::LastY
protected

Definition at line 317 of file vtkImageTracerWidget.h.

◆ Handle

vtkActor** vtkImageTracerWidget::Handle
protected

Definition at line 326 of file vtkImageTracerWidget.h.

◆ HandleGeometry

vtkPolyData** vtkImageTracerWidget::HandleGeometry
protected

Definition at line 327 of file vtkImageTracerWidget.h.

◆ HandleGenerator

vtkGlyphSource2D* vtkImageTracerWidget::HandleGenerator
protected

Definition at line 328 of file vtkImageTracerWidget.h.

◆ TransformFilter

vtkTransformPolyDataFilter* vtkImageTracerWidget::TransformFilter
protected

Definition at line 331 of file vtkImageTracerWidget.h.

◆ Transform

vtkTransform* vtkImageTracerWidget::Transform
protected

Definition at line 332 of file vtkImageTracerWidget.h.

◆ TemporaryHandlePoints

vtkFloatArray* vtkImageTracerWidget::TemporaryHandlePoints
protected

Definition at line 333 of file vtkImageTracerWidget.h.

◆ NumberOfHandles

int vtkImageTracerWidget::NumberOfHandles
protected

Definition at line 344 of file vtkImageTracerWidget.h.

◆ CurrentHandle

vtkActor* vtkImageTracerWidget::CurrentHandle
protected

Definition at line 345 of file vtkImageTracerWidget.h.

◆ CurrentHandleIndex

int vtkImageTracerWidget::CurrentHandleIndex
protected

Definition at line 346 of file vtkImageTracerWidget.h.

◆ ViewProp

vtkProp* vtkImageTracerWidget::ViewProp
protected

Definition at line 348 of file vtkImageTracerWidget.h.

◆ PropPicker

vtkPropPicker* vtkImageTracerWidget::PropPicker
protected

Definition at line 349 of file vtkImageTracerWidget.h.

◆ LinePoints

vtkPoints* vtkImageTracerWidget::LinePoints
protected

Definition at line 352 of file vtkImageTracerWidget.h.

◆ LineCells

vtkCellArray* vtkImageTracerWidget::LineCells
protected

Definition at line 353 of file vtkImageTracerWidget.h.

◆ LineActor

vtkActor* vtkImageTracerWidget::LineActor
protected

Definition at line 354 of file vtkImageTracerWidget.h.

◆ LineData

vtkPolyData* vtkImageTracerWidget::LineData
protected

Definition at line 355 of file vtkImageTracerWidget.h.

◆ CurrentPoints

vtkIdType vtkImageTracerWidget::CurrentPoints[2]
protected

Definition at line 356 of file vtkImageTracerWidget.h.

◆ PickCount

int vtkImageTracerWidget::PickCount
protected

Definition at line 362 of file vtkImageTracerWidget.h.

◆ HandlePicker

vtkCellPicker* vtkImageTracerWidget::HandlePicker
protected

Definition at line 365 of file vtkImageTracerWidget.h.

◆ LinePicker

vtkCellPicker* vtkImageTracerWidget::LinePicker
protected

Definition at line 366 of file vtkImageTracerWidget.h.

◆ CurrentPicker

vtkAbstractPropPicker* vtkImageTracerWidget::CurrentPicker
protected

Definition at line 367 of file vtkImageTracerWidget.h.

◆ HandleProperty

vtkProperty* vtkImageTracerWidget::HandleProperty
protected

Definition at line 374 of file vtkImageTracerWidget.h.

◆ SelectedHandleProperty

vtkProperty* vtkImageTracerWidget::SelectedHandleProperty
protected

Definition at line 375 of file vtkImageTracerWidget.h.

◆ LineProperty

vtkProperty* vtkImageTracerWidget::LineProperty
protected

Definition at line 376 of file vtkImageTracerWidget.h.

◆ SelectedLineProperty

vtkProperty* vtkImageTracerWidget::SelectedLineProperty
protected

Definition at line 377 of file vtkImageTracerWidget.h.

◆ HandleLeftMouseButton

vtkTypeBool vtkImageTracerWidget::HandleLeftMouseButton
protected

Definition at line 381 of file vtkImageTracerWidget.h.

◆ HandleMiddleMouseButton

vtkTypeBool vtkImageTracerWidget::HandleMiddleMouseButton
protected

Definition at line 382 of file vtkImageTracerWidget.h.

◆ HandleRightMouseButton

vtkTypeBool vtkImageTracerWidget::HandleRightMouseButton
protected

Definition at line 383 of file vtkImageTracerWidget.h.


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