vtkBrokenLineWidget Class Reference

3D widget for manipulating a broken line More...

#include <vtkBrokenLineWidget.h>

Inheritance diagram for vtkBrokenLineWidget:

Collaboration diagram for vtkBrokenLineWidget:

Public Types
typedef vtk3DWidget	Superclass
Public Types inherited from vtk3DWidget
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkBrokenLineWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetPlaneSource (vtkPlaneSource *plane)
virtual void	SetProjectionNormal (int)
virtual int	GetProjectionNormal ()
void	SetProjectionNormalToXAxes ()
void	SetProjectionNormalToYAxes ()
void	SetProjectionNormalToZAxes ()
void	SetProjectionNormalToOblique ()
void	GetPolyData (vtkPolyData *pd)
double	GetSummedLength ()
void	InitializeHandles (vtkPoints *points)
virtual void	SetEnabled (int)
virtual void	PlaceWidget (double bounds[6])
void	PlaceWidget ()
void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
virtual void	SetProjectToPlane (int)
virtual int	GetProjectToPlane ()
virtual void	ProjectToPlaneOn ()
virtual void	ProjectToPlaneOff ()
void	SetProjectionPosition (double position)
virtual double	GetProjectionPosition ()
virtual void	SetHandleProperty (vtkProperty *)
virtual vtkProperty *	GetHandleProperty ()
virtual void	SetSelectedHandleProperty (vtkProperty *)
virtual vtkProperty *	GetSelectedHandleProperty ()
virtual void	SetLineProperty (vtkProperty *)
virtual vtkProperty *	GetLineProperty ()
virtual void	SetSelectedLineProperty (vtkProperty *)
virtual vtkProperty *	GetSelectedLineProperty ()
virtual void	SetNumberOfHandles (int npts)
virtual int	GetNumberOfHandles ()
void	SetHandlePosition (int handle, double x, double y, double z)
void	SetHandlePosition (int handle, double xyz[3])
void	GetHandlePosition (int handle, double xyz[3])
double *	GetHandlePosition (int handle)
virtual void	SetProcessEvents (int)
virtual int	GetProcessEvents ()
virtual void	ProcessEventsOn ()
virtual void	ProcessEventsOff ()
virtual void	SetHandleSizeFactor (double)
virtual double	GetHandleSizeFactor ()
Public Member Functions inherited from vtk3DWidget
vtk3DWidget *	NewInstance () const
virtual void	SetProp3D (vtkProp3D *)
virtual vtkProp3D *	GetProp3D ()
virtual void	SetInputData (vtkDataSet *)
virtual void	SetInputConnection (vtkAlgorithmOutput *)
virtual vtkDataSet *	GetInput ()
virtual void	SetPlaceFactor (double)
virtual double	GetPlaceFactor ()
virtual void	SetHandleSize (double)
virtual double	GetHandleSize ()
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnChar ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetPriority (float)
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkBrokenLineWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkBrokenLineWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtk3DWidget
static int	IsTypeOf (const char *type)
static vtk3DWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Types
enum	WidgetState {   Start =0, Moving, Scaling, Spinning,   Inserting, Erasing, Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBrokenLineWidget ()
	~vtkBrokenLineWidget ()
void	OnLeftButtonDown ()
void	OnLeftButtonUp ()
void	OnMiddleButtonDown ()
void	OnMiddleButtonUp ()
void	OnRightButtonDown ()
void	OnRightButtonUp ()
void	OnMouseMove ()
void	ProjectPointsToPlane ()
void	ProjectPointsToOrthoPlane ()
void	ProjectPointsToObliquePlane ()
void	HighlightLine (int highlight)
void	BuildRepresentation ()
void	Initialize ()
int	HighlightHandle (vtkProp *prop)
virtual void	SizeHandles ()
void	InsertHandleOnLine (double *pos)
void	EraseHandle (const int &)
virtual void	RegisterPickers ()
void	MovePoint (double *p1, double *p2)
void	Scale (double *p1, double *p2, int X, int Y)
void	Translate (double *p1, double *p2)
void	Spin (double *p1, double *p2, double *vpn)
void	CreateDefaultProperties ()
void	CalculateCentroid ()
Protected Member Functions inherited from vtk3DWidget
	vtk3DWidget ()
	~vtk3DWidget ()
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 ()
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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	ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes
int	State
int	ProjectionNormal
double	ProjectionPosition
int	ProjectToPlane
vtkPlaneSource *	PlaneSource
vtkActor *	LineActor
vtkPolyDataMapper *	LineMapper
vtkLineSource *	LineSource
int	NumberOfHandles
vtkActor **	Handle
vtkSphereSource **	HandleGeometry
vtkCellPicker *	HandlePicker
vtkCellPicker *	LinePicker
vtkActor *	CurrentHandle
int	CurrentHandleIndex
vtkTransform *	Transform
vtkProperty *	HandleProperty
vtkProperty *	SelectedHandleProperty
vtkProperty *	LineProperty
vtkProperty *	SelectedLineProperty
double	Centroid [3]
int	ProcessEvents
double	HandleSizeFactor
Protected Attributes inherited from vtk3DWidget
vtkProp3D *	Prop3D
vtk3DWidgetConnection *	ConnectionHolder
double	PlaceFactor
int	Placed
double	InitialBounds [6]
double	InitialLength
double	HandleSize
int	ValidPick
double	LastPickPosition [3]
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

3D widget for manipulating a broken line

This 3D widget defines a broken line that can be interactively placed in a scene. The broken line has handles, the number of which can be changed, plus it can be picked on the broken line itself to translate or rotate it in the scene. A nice feature of the object is that the vtkBrokenLineWidget, like any 3D widget, will work with the current interactor style. That is, if vtkBrokenLineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkBrokenLineWidget 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 vtkBrokenLineWidget will appear. (See superclass documentation for information about changing this behavior.) Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method).

The button actions and key modifiers are as follows for controlling the widget: 1) left button down on and drag one of the spherical handles to change the shape of the broken line: the handles act as "control points". 2) left button or middle button down on a line segment forming the broken line allows uniform translation of the widget. 3) ctrl + middle button down on the widget enables spinning of the widget about its center. 4) right button down on the widget enables scaling of the widget. By moving the mouse "up" the render window the broken line will be made bigger; by moving "down" the render window the widget will be made smaller. 5) ctrl key + right button down on any handle will erase it providing there will be two or more points remaining to form a broken line. 6) shift key + right button down on any line segment will insert a handle onto the broken line at the cursor position.

The vtkBrokenLineWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines or probing other data sets. 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 broken line. For example, you can set the property for the handles and broken line. In addition there are methods to constrain the broken line so that it is aligned with a plane. Note that a simple ruler widget can be derived by setting the resolution to 1, the number of handles to 2, and calling the GetSummedLength method!

Thanks:

This class was written by Philippe Pebay, Kitware SAS 2012 This work was supported by CEA/DIF - Commissariat a l'Energie Atomique, Centre DAM Ile-De-France, BP12, F-91297 Arpajon, France.

See also

vtk3DWidget vtkBoxWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitPlaneWidget vtkPlaneWidget

Events:

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

Tests:

vtkBrokenLineWidget (Tests)

Definition at line 110 of file vtkBrokenLineWidget.h.

Member Typedef Documentation

typedef vtk3DWidget vtkBrokenLineWidget::Superclass

Definition at line 116 of file vtkBrokenLineWidget.h.

Member Enumeration Documentation

enum vtkBrokenLineWidget::WidgetState

protected

Enumerator
Start
Moving
Scaling
Spinning
Inserting
Erasing
Outside

Definition at line 238 of file vtkBrokenLineWidget.h.

Constructor & Destructor Documentation

vtkBrokenLineWidget::vtkBrokenLineWidget ( )

protected

vtkBrokenLineWidget::~vtkBrokenLineWidget ( )

protected

Member Function Documentation

static vtkBrokenLineWidget* vtkBrokenLineWidget::New ( )

static

Instantiate the object.

static int vtkBrokenLineWidget::IsTypeOf ( const char *  type )

static

virtual int vtkBrokenLineWidget::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 vtkBrokenLineWidget* vtkBrokenLineWidget::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkBrokenLineWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtk3DWidget.

vtkBrokenLineWidget* vtkBrokenLineWidget::NewInstance

(

)

const

void vtkBrokenLineWidget::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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.

virtual void vtkBrokenLineWidget::SetEnabled ( int  )

virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

virtual void vtkBrokenLineWidget::PlaceWidget ( double  bounds[6] )

virtual

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkBrokenLineWidget::PlaceWidget ( )

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 123 of file vtkBrokenLineWidget.h.

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

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 125 of file vtkBrokenLineWidget.h.

virtual void vtkBrokenLineWidget::SetProjectToPlane ( int  )

virtual

Force the broken line widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the broken line to the plane if it is originally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual int vtkBrokenLineWidget::GetProjectToPlane ( )

virtual

Force the broken line widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the broken line to the plane if it is originally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual void vtkBrokenLineWidget::ProjectToPlaneOn ( )

virtual

Force the broken line widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the broken line to the plane if it is originally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

virtual void vtkBrokenLineWidget::ProjectToPlaneOff ( )

virtual

Force the broken line widget to be projected onto one of the orthogonal planes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the broken line to the plane if it is originally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

void vtkBrokenLineWidget::SetPlaneSource

(

vtkPlaneSource *

plane

)

Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.

virtual void vtkBrokenLineWidget::SetProjectionNormal ( int  )

virtual

virtual int vtkBrokenLineWidget::GetProjectionNormal ( )

virtual

void vtkBrokenLineWidget::SetProjectionNormalToXAxes ( )

inline

Definition at line 149 of file vtkBrokenLineWidget.h.

void vtkBrokenLineWidget::SetProjectionNormalToYAxes ( )

inline

Definition at line 151 of file vtkBrokenLineWidget.h.

void vtkBrokenLineWidget::SetProjectionNormalToZAxes ( )

inline

Definition at line 153 of file vtkBrokenLineWidget.h.

void vtkBrokenLineWidget::SetProjectionNormalToOblique ( )

inline

Definition at line 155 of file vtkBrokenLineWidget.h.

void vtkBrokenLineWidget::SetProjectionPosition

(

double

position

)

Set the position of broken line handles and points in terms of a plane's position. i.e., if ProjectionNormal is 0, all of the x-coordinate values of the points are set to position. Any value can be passed (and is ignored) to update the broken line points when Projection normal is set to 3 for arbritrary plane orientations.

virtual double vtkBrokenLineWidget::GetProjectionPosition ( )

virtual

Set the position of broken line handles and points in terms of a plane's position. i.e., if ProjectionNormal is 0, all of the x-coordinate values of the points are set to position. Any value can be passed (and is ignored) to update the broken line points when Projection normal is set to 3 for arbritrary plane orientations.

void vtkBrokenLineWidget::GetPolyData

(

vtkPolyData *

pd

)

Grab the polydata (including points) that defines the broken line. The polydata consists of points and line segments numbering nHandles and nHandles - 1, respectively. Points 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 void vtkBrokenLineWidget::SetHandleProperty ( vtkProperty *  )

virtual

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual vtkProperty* vtkBrokenLineWidget::GetHandleProperty ( )

virtual

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual void vtkBrokenLineWidget::SetSelectedHandleProperty ( vtkProperty *  )

virtual

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual vtkProperty* vtkBrokenLineWidget::GetSelectedHandleProperty ( )

virtual

Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.

virtual void vtkBrokenLineWidget::SetLineProperty ( vtkProperty *  )

virtual

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

virtual vtkProperty* vtkBrokenLineWidget::GetLineProperty ( )

virtual

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

virtual void vtkBrokenLineWidget::SetSelectedLineProperty ( vtkProperty *  )

virtual

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

virtual vtkProperty* vtkBrokenLineWidget::GetSelectedLineProperty ( )

virtual

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

virtual void vtkBrokenLineWidget::SetNumberOfHandles ( int  npts )

virtual

Set/Get the number of handles for this widget.

virtual int vtkBrokenLineWidget::GetNumberOfHandles ( )

virtual

Set/Get the number of handles for this widget.

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

Set/Get the position of the broken line handles. Call GetNumberOfHandles to determine the valid range of handle indices.

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

Set/Get the position of the broken line handles. Call GetNumberOfHandles to determine the valid range of handle indices.

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

Set/Get the position of the broken line handles. Call GetNumberOfHandles to determine the valid range of handle indices.

double* vtkBrokenLineWidget::GetHandlePosition

(

int

handle

)

Set/Get the position of the broken line handles. Call GetNumberOfHandles to determine the valid range of handle indices.

double vtkBrokenLineWidget::GetSummedLength

(

)

Get the summed lengths of the individual straight line segments.

void vtkBrokenLineWidget::InitializeHandles

(

vtkPoints *

points

)

Convenience method to allocate and set the handles from a vtkPoints instance.

virtual void vtkBrokenLineWidget::SetProcessEvents ( int  )

virtual

Turn on / off event processing for this widget. If off, the widget will not respond to user interaction

virtual int vtkBrokenLineWidget::GetProcessEvents ( )

virtual

Turn on / off event processing for this widget. If off, the widget will not respond to user interaction

virtual void vtkBrokenLineWidget::ProcessEventsOn ( )

virtual

Turn on / off event processing for this widget. If off, the widget will not respond to user interaction

virtual void vtkBrokenLineWidget::ProcessEventsOff ( )

virtual

Turn on / off event processing for this widget. If off, the widget will not respond to user interaction

virtual void vtkBrokenLineWidget::SetHandleSizeFactor ( double  )

virtual

Set/Get the size factor to be applied to the handle radii. Default:

virtual double vtkBrokenLineWidget::GetHandleSizeFactor ( )

virtual

Set/Get the size factor to be applied to the handle radii. Default:

static void vtkBrokenLineWidget::ProcessEventsHandler ( vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata  )

staticprotected

void vtkBrokenLineWidget::OnLeftButtonDown ( )

protected

void vtkBrokenLineWidget::OnLeftButtonUp ( )

protected

void vtkBrokenLineWidget::OnMiddleButtonDown ( )

protected

void vtkBrokenLineWidget::OnMiddleButtonUp ( )

protected

void vtkBrokenLineWidget::OnRightButtonDown ( )

protected

void vtkBrokenLineWidget::OnRightButtonUp ( )

protected

void vtkBrokenLineWidget::OnMouseMove ( )

protected

void vtkBrokenLineWidget::ProjectPointsToPlane ( )

protected

void vtkBrokenLineWidget::ProjectPointsToOrthoPlane ( )

protected

void vtkBrokenLineWidget::ProjectPointsToObliquePlane ( )

protected

void vtkBrokenLineWidget::HighlightLine ( int  highlight )

protected

void vtkBrokenLineWidget::BuildRepresentation ( )

protected

void vtkBrokenLineWidget::Initialize ( )

protected

int vtkBrokenLineWidget::HighlightHandle ( vtkProp *  prop )

protected

virtual void vtkBrokenLineWidget::SizeHandles ( )

protectedvirtual

Reimplemented from vtk3DWidget.

void vtkBrokenLineWidget::InsertHandleOnLine ( double *  pos )

protected

void vtkBrokenLineWidget::EraseHandle ( const int &  )

protected

virtual void vtkBrokenLineWidget::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

void vtkBrokenLineWidget::MovePoint ( double *  p1, double *  p2  )

protected

void vtkBrokenLineWidget::Scale ( double *  p1, double *  p2, int  X, int  Y  )

protected

void vtkBrokenLineWidget::Translate ( double *  p1, double *  p2  )

protected

void vtkBrokenLineWidget::Spin ( double *  p1, double *  p2, double *  vpn  )

protected

void vtkBrokenLineWidget::CreateDefaultProperties ( )

protected

void vtkBrokenLineWidget::CalculateCentroid ( )

protected

Member Data Documentation

int vtkBrokenLineWidget::State

protected

Definition at line 237 of file vtkBrokenLineWidget.h.

int vtkBrokenLineWidget::ProjectionNormal

protected

Definition at line 266 of file vtkBrokenLineWidget.h.

double vtkBrokenLineWidget::ProjectionPosition

protected

Definition at line 267 of file vtkBrokenLineWidget.h.

int vtkBrokenLineWidget::ProjectToPlane

protected

Definition at line 268 of file vtkBrokenLineWidget.h.

vtkPlaneSource* vtkBrokenLineWidget::PlaneSource

protected

Definition at line 269 of file vtkBrokenLineWidget.h.

vtkActor* vtkBrokenLineWidget::LineActor

protected

Definition at line 277 of file vtkBrokenLineWidget.h.

vtkPolyDataMapper* vtkBrokenLineWidget::LineMapper

protected

Definition at line 278 of file vtkBrokenLineWidget.h.

vtkLineSource* vtkBrokenLineWidget::LineSource

protected

Definition at line 279 of file vtkBrokenLineWidget.h.

int vtkBrokenLineWidget::NumberOfHandles

protected

Definition at line 281 of file vtkBrokenLineWidget.h.

vtkActor** vtkBrokenLineWidget::Handle

protected

Definition at line 285 of file vtkBrokenLineWidget.h.

vtkSphereSource** vtkBrokenLineWidget::HandleGeometry

protected

Definition at line 286 of file vtkBrokenLineWidget.h.

vtkCellPicker* vtkBrokenLineWidget::HandlePicker

protected

Definition at line 294 of file vtkBrokenLineWidget.h.

vtkCellPicker* vtkBrokenLineWidget::LinePicker

protected

Definition at line 295 of file vtkBrokenLineWidget.h.

vtkActor* vtkBrokenLineWidget::CurrentHandle

protected

Definition at line 296 of file vtkBrokenLineWidget.h.

int vtkBrokenLineWidget::CurrentHandleIndex

protected

Definition at line 297 of file vtkBrokenLineWidget.h.

vtkTransform* vtkBrokenLineWidget::Transform

protected

Definition at line 309 of file vtkBrokenLineWidget.h.

vtkProperty* vtkBrokenLineWidget::HandleProperty

protected

Definition at line 313 of file vtkBrokenLineWidget.h.

vtkProperty* vtkBrokenLineWidget::SelectedHandleProperty

protected

Definition at line 314 of file vtkBrokenLineWidget.h.

vtkProperty* vtkBrokenLineWidget::LineProperty

protected

Definition at line 315 of file vtkBrokenLineWidget.h.

vtkProperty* vtkBrokenLineWidget::SelectedLineProperty

protected

Definition at line 316 of file vtkBrokenLineWidget.h.

double vtkBrokenLineWidget::Centroid[3]

protected

Definition at line 320 of file vtkBrokenLineWidget.h.

int vtkBrokenLineWidget::ProcessEvents

protected

Definition at line 322 of file vtkBrokenLineWidget.h.

double vtkBrokenLineWidget::HandleSizeFactor

protected

Definition at line 325 of file vtkBrokenLineWidget.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkBrokenLineWidget.h