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

3D widget for manipulating a line More...

#include <vtkLineWidget.h>

Inheritance diagram for vtkLineWidget:
[legend]
Collaboration diagram for vtkLineWidget:
[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...
 
vtkLineWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetResolution (int r)
 Set/Get the resolution (number of subdivisions) of the line. More...
 
int GetResolution ()
 
void SetPoint1 (double x, double y, double z)
 Set/Get the position of first end point. More...
 
void SetPoint1 (double x[3])
 
doubleGetPoint1 ()
 
void GetPoint1 (double xyz[3])
 
void SetPoint2 (double x, double y, double z)
 Set position of other end point. More...
 
void SetPoint2 (double x[3])
 
doubleGetPoint2 ()
 
void GetPoint2 (double xyz[3])
 
void GetPolyData (vtkPolyData *pd)
 Grab the polydata (including points) that defines the line. 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 SetAlign (int)
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
virtual int GetAlign ()
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
void SetAlignToXAxis ()
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
void SetAlignToYAxis ()
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
void SetAlignToZAxis ()
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
void SetAlignToNone ()
 Force the line widget to be aligned with one of the x-y-z axes. More...
 
virtual void SetClampToBounds (int)
 Enable/disable clamping of the point end points to the bounding box of the data. More...
 
virtual int GetClampToBounds ()
 Enable/disable clamping of the point end points to the bounding box of the data. More...
 
virtual void ClampToBoundsOn ()
 Enable/disable clamping of the point end points to the bounding box of the data. More...
 
virtual void ClampToBoundsOff ()
 Enable/disable clamping of the point end points to the bounding box of the data. More...
 
virtual vtkPropertyGetHandleProperty ()
 Get the handle properties (the little balls are the handles). More...
 
virtual vtkPropertyGetSelectedHandleProperty ()
 Get the handle properties (the little balls are the handles). More...
 
virtual vtkPropertyGetLineProperty ()
 Get the line properties. More...
 
virtual vtkPropertyGetSelectedLineProperty ()
 Get the line properties. 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=NULL)
 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 vtkLineWidgetNew ()
 Instantiate the object. More...
 
static int IsTypeOf (const char *type)
 
static vtkLineWidgetSafeDownCast (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, MovingHandle, MovingLine, Scaling,
  Outside
}
 
enum  AlignmentState { XAxis, YAxis, ZAxis, None }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLineWidget ()
 
 ~vtkLineWidget () override
 
void OnLeftButtonDown ()
 
void OnLeftButtonUp ()
 
void OnMiddleButtonDown ()
 
void OnMiddleButtonUp ()
 
void OnRightButtonDown ()
 
void OnRightButtonUp ()
 
virtual void OnMouseMove ()
 
void HighlightLine (int highlight)
 
void BuildRepresentation ()
 
void SizeHandles () override
 
void HandlesOn (double length)
 
void HandlesOff ()
 
int HighlightHandle (vtkProp *prop)
 
void HighlightHandles (int highlight)
 
void SetLinePosition (double x[3])
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
void Scale (double *p1, double *p2, int X, int Y)
 
void ClampPosition (double x[3])
 
int InBounds (double x[3])
 
void CreateDefaultProperties ()
 
void GenerateLine ()
 
void EnablePointWidget ()
 
void DisablePointWidget ()
 
int ForwardEvent (unsigned long event)
 
- 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=NULL)
 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 Align
 
vtkActorLineActor
 
vtkPolyDataMapperLineMapper
 
vtkLineSourceLineSource
 
vtkActor ** Handle
 
vtkPolyDataMapper ** HandleMapper
 
vtkSphereSource ** HandleGeometry
 
vtkCellPickerHandlePicker
 
vtkCellPickerLinePicker
 
vtkActorCurrentHandle
 
double LastPosition [3]
 
int ClampToBounds
 
vtkPropertyHandleProperty
 
vtkPropertySelectedHandleProperty
 
vtkPropertyLineProperty
 
vtkPropertySelectedLineProperty
 
vtkPointWidgetPointWidget
 
vtkPointWidgetPointWidget1
 
vtkPointWidgetPointWidget2
 
vtkPWCallbackPWCallback
 
vtkPW1Callback * PW1Callback
 
vtkPW2Callback * PW2Callback
 
vtkPointWidgetCurrentPointWidget
 
- 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
 

Friends

class vtkPWCallback
 

Detailed Description

3D widget for manipulating a line

This 3D widget defines a line that can be interactively placed in a scene. The line has two handles (at its endpoints), plus the line can be picked to translate it in the scene. A nice feature of the object is that the vtkLineWidget, like any 3D widget, will work with the current interactor style and any other widgets present in the scene. That is, if vtkLineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkLineWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. The interactor will act normally until the "i" key (for "interactor") is pressed, at which point the vtkLineWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing one of the two end point handles (use the left mouse button), the line can be oriented and stretched (the other end point remains fixed). By grabbing the line itself, or using the middle mouse button, the entire line can be translated. Scaling (about the center of the line) is achieved by using the right mouse button. By moving the mouse "up" the render window the line will be made bigger; by moving "down" the render window the widget will be made smaller. Turn off the widget by pressing the "i" key again (or invoke the Off() method). (Note: picking the line or either one of the two end point handles causes a vtkPointWidget to appear. This widget has the ability to constrain motion to an axis by pressing the "shift" key while moving the mouse.)

The vtkLineWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the line; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button).

Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the line. For example, you can set the property for the handles and line. In addition there are methods to constrain the line so that it is aligned along the x-y-z axes.

See also
vtk3DWidget vtkBoxWidget vtkPlaneWidget
Examples:
vtkLineWidget (Examples)
Tests:
vtkLineWidget (Tests)

Definition at line 93 of file vtkLineWidget.h.

Member Typedef Documentation

Definition at line 101 of file vtkLineWidget.h.

Member Enumeration Documentation

Enumerator
Start 
MovingHandle 
MovingLine 
Scaling 
Outside 

Definition at line 210 of file vtkLineWidget.h.

Enumerator
XAxis 
YAxis 
ZAxis 
None 

Definition at line 237 of file vtkLineWidget.h.

Constructor & Destructor Documentation

vtkLineWidget::vtkLineWidget ( )
protected
vtkLineWidget::~vtkLineWidget ( )
overrideprotected

Member Function Documentation

static vtkLineWidget* vtkLineWidget::New ( )
static

Instantiate the object.

static int vtkLineWidget::IsTypeOf ( const char *  type)
static
virtual int vtkLineWidget::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 vtkLineWidget* vtkLineWidget::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkLineWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtk3DWidget.

vtkLineWidget* vtkLineWidget::NewInstance ( ) const
void vtkLineWidget::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 vtkLineWidget::SetEnabled ( int  )
overridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkLineWidget::PlaceWidget ( )
inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 110 of file vtkLineWidget.h.

void vtkLineWidget::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 112 of file vtkLineWidget.h.

void vtkLineWidget::SetResolution ( int  r)
inline

Set/Get the resolution (number of subdivisions) of the line.

Definition at line 120 of file vtkLineWidget.h.

int vtkLineWidget::GetResolution ( )
inline

Definition at line 122 of file vtkLineWidget.h.

void vtkLineWidget::SetPoint1 ( double  x,
double  y,
double  z 
)

Set/Get the position of first end point.

void vtkLineWidget::SetPoint1 ( double  x[3])
inline

Definition at line 129 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint1 ( )
inline

Definition at line 131 of file vtkLineWidget.h.

void vtkLineWidget::GetPoint1 ( double  xyz[3])
inline

Definition at line 133 of file vtkLineWidget.h.

void vtkLineWidget::SetPoint2 ( double  x,
double  y,
double  z 
)

Set position of other end point.

void vtkLineWidget::SetPoint2 ( double  x[3])
inline

Definition at line 140 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint2 ( )
inline

Definition at line 142 of file vtkLineWidget.h.

void vtkLineWidget::GetPoint2 ( double  xyz[3])
inline

Definition at line 144 of file vtkLineWidget.h.

virtual void vtkLineWidget::SetAlign ( int  )
virtual

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

virtual int vtkLineWidget::GetAlign ( )
virtual

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

void vtkLineWidget::SetAlignToXAxis ( )
inline

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

Definition at line 156 of file vtkLineWidget.h.

void vtkLineWidget::SetAlignToYAxis ( )
inline

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

Definition at line 157 of file vtkLineWidget.h.

void vtkLineWidget::SetAlignToZAxis ( )
inline

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

Definition at line 158 of file vtkLineWidget.h.

void vtkLineWidget::SetAlignToNone ( )
inline

Force the line widget to be aligned with one of the x-y-z axes.

Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is originally not aligned.

Definition at line 159 of file vtkLineWidget.h.

virtual void vtkLineWidget::SetClampToBounds ( int  )
virtual

Enable/disable clamping of the point end points to the bounding box of the data.

The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.

virtual int vtkLineWidget::GetClampToBounds ( )
virtual

Enable/disable clamping of the point end points to the bounding box of the data.

The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.

virtual void vtkLineWidget::ClampToBoundsOn ( )
virtual

Enable/disable clamping of the point end points to the bounding box of the data.

The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.

virtual void vtkLineWidget::ClampToBoundsOff ( )
virtual

Enable/disable clamping of the point end points to the bounding box of the data.

The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.

void vtkLineWidget::GetPolyData ( vtkPolyData pd)

Grab the polydata (including points) that defines the line.

The polydata consists of n+1 points, where n is the resolution of the line. 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 polyline are added to it.

virtual vtkProperty* vtkLineWidget::GetHandleProperty ( )
virtual

Get the handle properties (the little balls are the handles).

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

virtual vtkProperty* vtkLineWidget::GetSelectedHandleProperty ( )
virtual

Get the handle properties (the little balls are the handles).

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

virtual vtkProperty* vtkLineWidget::GetLineProperty ( )
virtual

Get the line properties.

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

virtual vtkProperty* vtkLineWidget::GetSelectedLineProperty ( )
virtual

Get the line properties.

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

static void vtkLineWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected
void vtkLineWidget::OnLeftButtonDown ( )
protected
void vtkLineWidget::OnLeftButtonUp ( )
protected
void vtkLineWidget::OnMiddleButtonDown ( )
protected
void vtkLineWidget::OnMiddleButtonUp ( )
protected
void vtkLineWidget::OnRightButtonDown ( )
protected
void vtkLineWidget::OnRightButtonUp ( )
protected
virtual void vtkLineWidget::OnMouseMove ( )
protectedvirtual
void vtkLineWidget::HighlightLine ( int  highlight)
protected
void vtkLineWidget::BuildRepresentation ( )
protected
void vtkLineWidget::SizeHandles ( )
overrideprotectedvirtual

Reimplemented from vtk3DWidget.

void vtkLineWidget::HandlesOn ( double  length)
protected
void vtkLineWidget::HandlesOff ( )
protected
int vtkLineWidget::HighlightHandle ( vtkProp prop)
protected
void vtkLineWidget::HighlightHandles ( int  highlight)
protected
void vtkLineWidget::SetLinePosition ( double  x[3])
protected
void vtkLineWidget::RegisterPickers ( )
overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

void vtkLineWidget::Scale ( double p1,
double p2,
int  X,
int  Y 
)
protected
void vtkLineWidget::ClampPosition ( double  x[3])
protected
int vtkLineWidget::InBounds ( double  x[3])
protected
void vtkLineWidget::CreateDefaultProperties ( )
protected
void vtkLineWidget::GenerateLine ( )
protected
void vtkLineWidget::EnablePointWidget ( )
protected
void vtkLineWidget::DisablePointWidget ( )
protected
int vtkLineWidget::ForwardEvent ( unsigned long  event)
protected

Friends And Related Function Documentation

friend class vtkPWCallback
friend

Definition at line 207 of file vtkLineWidget.h.

Member Data Documentation

int vtkLineWidget::State
protected

Definition at line 209 of file vtkLineWidget.h.

int vtkLineWidget::Align
protected

Definition at line 235 of file vtkLineWidget.h.

vtkActor* vtkLineWidget::LineActor
protected

Definition at line 245 of file vtkLineWidget.h.

vtkPolyDataMapper* vtkLineWidget::LineMapper
protected

Definition at line 246 of file vtkLineWidget.h.

vtkLineSource* vtkLineWidget::LineSource
protected

Definition at line 247 of file vtkLineWidget.h.

vtkActor** vtkLineWidget::Handle
protected

Definition at line 251 of file vtkLineWidget.h.

vtkPolyDataMapper** vtkLineWidget::HandleMapper
protected

Definition at line 252 of file vtkLineWidget.h.

vtkSphereSource** vtkLineWidget::HandleGeometry
protected

Definition at line 253 of file vtkLineWidget.h.

vtkCellPicker* vtkLineWidget::HandlePicker
protected

Definition at line 263 of file vtkLineWidget.h.

vtkCellPicker* vtkLineWidget::LinePicker
protected

Definition at line 264 of file vtkLineWidget.h.

vtkActor* vtkLineWidget::CurrentHandle
protected

Definition at line 265 of file vtkLineWidget.h.

double vtkLineWidget::LastPosition[3]
protected

Definition at line 266 of file vtkLineWidget.h.

int vtkLineWidget::ClampToBounds
protected

Definition at line 276 of file vtkLineWidget.h.

vtkProperty* vtkLineWidget::HandleProperty
protected

Definition at line 282 of file vtkLineWidget.h.

vtkProperty* vtkLineWidget::SelectedHandleProperty
protected

Definition at line 283 of file vtkLineWidget.h.

vtkProperty* vtkLineWidget::LineProperty
protected

Definition at line 284 of file vtkLineWidget.h.

vtkProperty* vtkLineWidget::SelectedLineProperty
protected

Definition at line 285 of file vtkLineWidget.h.

vtkPointWidget* vtkLineWidget::PointWidget
protected

Definition at line 291 of file vtkLineWidget.h.

vtkPointWidget* vtkLineWidget::PointWidget1
protected

Definition at line 292 of file vtkLineWidget.h.

vtkPointWidget* vtkLineWidget::PointWidget2
protected

Definition at line 293 of file vtkLineWidget.h.

vtkPWCallback* vtkLineWidget::PWCallback
protected

Definition at line 294 of file vtkLineWidget.h.

vtkPW1Callback* vtkLineWidget::PW1Callback
protected

Definition at line 295 of file vtkLineWidget.h.

vtkPW2Callback* vtkLineWidget::PW2Callback
protected

Definition at line 296 of file vtkLineWidget.h.

vtkPointWidget* vtkLineWidget::CurrentPointWidget
protected

Definition at line 297 of file vtkLineWidget.h.


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