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 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.
vtkBrokenLineWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetPlaneSource (vtkPlaneSource *plane)
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g.
virtual void	SetProjectionNormal (int)
virtual int	GetProjectionNormal ()
void	SetProjectionNormalToXAxes ()
void	SetProjectionNormalToYAxes ()
void	SetProjectionNormalToZAxes ()
void	SetProjectionNormalToOblique ()
void	GetPolyData (vtkPolyData *pd)
	Grab the polydata (including points) that defines the broken line.
double	GetSummedLength ()
	Get the summed lengths of the individual straight line segments.
void	InitializeHandles (vtkPoints *points)
	Convenience method to allocate and set the handles from a vtkPoints instance.
void	SetEnabled (int) override
	Methods that satisfy the superclass' API.
void	PlaceWidget (double bounds[6]) override
	Methods that satisfy the superclass' API.
void	PlaceWidget () override
	Methods that satisfy the superclass' API.
void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
	Methods that satisfy the superclass' API.
virtual void	SetProjectToPlane (vtkTypeBool)
	Force the broken line widget to be projected onto one of the orthogonal planes.
virtual vtkTypeBool	GetProjectToPlane ()
	Force the broken line widget to be projected onto one of the orthogonal planes.
virtual void	ProjectToPlaneOn ()
	Force the broken line widget to be projected onto one of the orthogonal planes.
virtual void	ProjectToPlaneOff ()
	Force the broken line widget to be projected onto one of the orthogonal planes.
void	SetProjectionPosition (double position)
	Set the position of broken line handles and points in terms of a plane's position.
virtual double	GetProjectionPosition ()
	Set the position of broken line handles and points in terms of a plane's position.
virtual void	SetHandleProperty (vtkProperty *)
	Set/Get the handle properties (the spheres are the handles).
virtual vtkProperty *	GetHandleProperty ()
	Set/Get the handle properties (the spheres are the handles).
virtual void	SetSelectedHandleProperty (vtkProperty *)
	Set/Get the handle properties (the spheres are the handles).
virtual vtkProperty *	GetSelectedHandleProperty ()
	Set/Get the handle properties (the spheres are the handles).
virtual void	SetLineProperty (vtkProperty *)
	Set/Get the line properties.
virtual vtkProperty *	GetLineProperty ()
	Set/Get the line properties.
virtual void	SetSelectedLineProperty (vtkProperty *)
	Set/Get the line properties.
virtual vtkProperty *	GetSelectedLineProperty ()
	Set/Get the line properties.
virtual void	SetNumberOfHandles (int npts)
	Set/Get the number of handles for this widget.
virtual int	GetNumberOfHandles ()
	Set/Get the number of handles for this widget.
void	SetHandlePosition (int handle, double x, double y, double z)
	Set/Get the position of the broken line handles.
void	SetHandlePosition (int handle, double xyz[3])
	Set/Get the position of the broken line handles.
void	GetHandlePosition (int handle, double xyz[3])
	Set/Get the position of the broken line handles.
double *	GetHandlePosition (int handle)
	Set/Get the position of the broken line handles.
virtual void	SetProcessEvents (vtkTypeBool)
	Turn on / off event processing for this widget.
virtual vtkTypeBool	GetProcessEvents ()
	Turn on / off event processing for this widget.
virtual void	ProcessEventsOn ()
	Turn on / off event processing for this widget.
virtual void	ProcessEventsOff ()
	Turn on / off event processing for this widget.
virtual void	SetHandleSizeFactor (double)
	Set/Get the size factor to be applied to the handle radii.
virtual double	GetHandleSizeFactor ()
	Set/Get the size factor to be applied to the handle radii.
Public Member Functions inherited from vtk3DWidget
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtk3DWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetProp3D (vtkProp3D *)
	Specify a vtkProp3D around which to place the widget.
virtual vtkProp3D *	GetProp3D ()
	Specify a vtkProp3D around which to place the widget.
virtual void	SetInputData (vtkDataSet *)
	Specify the input dataset.
virtual void	SetInputConnection (vtkAlgorithmOutput *)
	Specify the input dataset.
virtual vtkDataSet *	GetInput ()
	Specify the input dataset.
virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget.
virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget.
Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkInteractorObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual void	OnChar ()
	Sets up the keypress-i event.
virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.
virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.
virtual float	GetPriority ()
	Set/Get the priority at which events are processed.
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.
virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.
virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.
virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.
virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.
virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.
virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.
virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.
virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.
virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.
virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.
virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkBrokenLineWidget *	New ()
	Instantiate the object.
static vtkTypeBool	IsTypeOf (const char *type)
static vtkBrokenLineWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtk3DWidget
static vtkTypeBool	IsTypeOf (const char *type)
static vtk3DWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBrokenLineWidget ()
	~vtkBrokenLineWidget () override
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)
void	SizeHandles () override
void	InsertHandleOnLine (double *pos)
void	EraseHandle (const int &)
void	RegisterPickers () override
	Register internal Pickers in the Picking Manager.
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
virtual vtkObjectBase *	NewInstanceInternal () const
	vtk3DWidget ()
	~vtk3DWidget () override
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double	SizeHandles (double factor)
virtual void	SizeHandles ()
void	UpdateInput ()
Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractorObserver ()
	~vtkInteractorObserver () override
virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.
void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.
vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
	Utility routines used to start and end interaction.
virtual void	EndInteraction ()
	Utility routines used to start and end interaction.
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	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)
	Handles the char widget activation event.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
int	State
int	ProjectionNormal
double	ProjectionPosition
vtkTypeBool	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]
vtkTypeBool	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
vtkTypeBool	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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::DisableEvent vtkCommand::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Tests:

vtkBrokenLineWidget (Tests)

Definition at line 100 of file vtkBrokenLineWidget.h.

Member Typedef Documentation

Superclass

typedef vtk3DWidget vtkBrokenLineWidget::Superclass

Definition at line 108 of file vtkBrokenLineWidget.h.

Member Enumeration Documentation

WidgetState

enum vtkBrokenLineWidget::WidgetState

protected

Enumerator
Start
Moving
Scaling
Spinning
Inserting
Erasing
Outside

Definition at line 250 of file vtkBrokenLineWidget.h.

Constructor & Destructor Documentation

vtkBrokenLineWidget()

vtkBrokenLineWidget::vtkBrokenLineWidget ( )

protected

~vtkBrokenLineWidget()

vtkBrokenLineWidget::~vtkBrokenLineWidget ( )

overrideprotected

Member Function Documentation

New()

static vtkBrokenLineWidget * vtkBrokenLineWidget::New ( )

static

Instantiate the object.

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkBrokenLineWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtk3DWidget.

NewInstance()

vtkBrokenLineWidget * vtkBrokenLineWidget::NewInstance

(

)

const

PrintSelf()

void vtkBrokenLineWidget::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 vtkBrokenLineWidget::SetEnabled ( int  )

overridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

PlaceWidget() [1/3]

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

overridevirtual

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

PlaceWidget() [2/3]

void vtkBrokenLineWidget::PlaceWidget ( )

inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 117 of file vtkBrokenLineWidget.h.

PlaceWidget() [3/3]

void vtkBrokenLineWidget::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 118 of file vtkBrokenLineWidget.h.

SetProjectToPlane()

virtual void vtkBrokenLineWidget::SetProjectToPlane ( vtkTypeBool  )

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.

GetProjectToPlane()

virtual vtkTypeBool 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.

ProjectToPlaneOn()

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.

ProjectToPlaneOff()

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.

SetPlaneSource()

void vtkBrokenLineWidget::SetPlaneSource

(

vtkPlaneSource *

plane

)

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

a vtkPolyDataSourceWidget.

SetProjectionNormal()

virtual void vtkBrokenLineWidget::SetProjectionNormal ( int  )

virtual

GetProjectionNormal()

virtual int vtkBrokenLineWidget::GetProjectionNormal ( )

virtual

SetProjectionNormalToXAxes()

void vtkBrokenLineWidget::SetProjectionNormalToXAxes ( )

inline

Definition at line 147 of file vtkBrokenLineWidget.h.

SetProjectionNormalToYAxes()

void vtkBrokenLineWidget::SetProjectionNormalToYAxes ( )

inline

Definition at line 148 of file vtkBrokenLineWidget.h.

SetProjectionNormalToZAxes()

void vtkBrokenLineWidget::SetProjectionNormalToZAxes ( )

inline

Definition at line 149 of file vtkBrokenLineWidget.h.

SetProjectionNormalToOblique()

void vtkBrokenLineWidget::SetProjectionNormalToOblique ( )

inline

Definition at line 150 of file vtkBrokenLineWidget.h.

SetProjectionPosition()

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 arbitrary plane orientations.

GetProjectionPosition()

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 arbitrary plane orientations.

GetPolyData()

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.

SetHandleProperty()

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.

GetHandleProperty()

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.

SetSelectedHandleProperty()

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.

GetSelectedHandleProperty()

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.

SetLineProperty()

virtual void vtkBrokenLineWidget::SetLineProperty ( vtkProperty *  )

virtual

Set/Get the line properties.

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

GetLineProperty()

virtual vtkProperty * vtkBrokenLineWidget::GetLineProperty ( )

virtual

Set/Get the line properties.

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

SetSelectedLineProperty()

virtual void vtkBrokenLineWidget::SetSelectedLineProperty ( vtkProperty *  )

virtual

Set/Get the line properties.

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

GetSelectedLineProperty()

virtual vtkProperty * vtkBrokenLineWidget::GetSelectedLineProperty ( )

virtual

Set/Get the line properties.

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

SetNumberOfHandles()

virtual void vtkBrokenLineWidget::SetNumberOfHandles ( int  npts )

virtual

Set/Get the number of handles for this widget.

GetNumberOfHandles()

virtual int vtkBrokenLineWidget::GetNumberOfHandles ( )

virtual

Set/Get the number of handles for this widget.

SetHandlePosition() [1/2]

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.

SetHandlePosition() [2/2]

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.

GetHandlePosition() [1/2]

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.

GetHandlePosition() [2/2]

double * vtkBrokenLineWidget::GetHandlePosition

(

int

handle

)

Set/Get the position of the broken line handles.

Call GetNumberOfHandles to determine the valid range of handle indices.

GetSummedLength()

double vtkBrokenLineWidget::GetSummedLength

(

)

Get the summed lengths of the individual straight line segments.

InitializeHandles()

void vtkBrokenLineWidget::InitializeHandles

(

vtkPoints *

points

)

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

SetProcessEvents()

virtual void vtkBrokenLineWidget::SetProcessEvents ( vtkTypeBool  )

virtual

Turn on / off event processing for this widget.

If off, the widget will not respond to user interaction

GetProcessEvents()

virtual vtkTypeBool vtkBrokenLineWidget::GetProcessEvents ( )

virtual

Turn on / off event processing for this widget.

If off, the widget will not respond to user interaction

ProcessEventsOn()

virtual void vtkBrokenLineWidget::ProcessEventsOn ( )

virtual

Turn on / off event processing for this widget.

If off, the widget will not respond to user interaction

ProcessEventsOff()

virtual void vtkBrokenLineWidget::ProcessEventsOff ( )

virtual

Turn on / off event processing for this widget.

If off, the widget will not respond to user interaction

SetHandleSizeFactor()

virtual void vtkBrokenLineWidget::SetHandleSizeFactor ( double  )

virtual

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

Default: 1.

GetHandleSizeFactor()

virtual double vtkBrokenLineWidget::GetHandleSizeFactor ( )

virtual

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

Default: 1.

ProcessEventsHandler()

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

staticprotected

OnLeftButtonDown()

void vtkBrokenLineWidget::OnLeftButtonDown ( )

protected

OnLeftButtonUp()

void vtkBrokenLineWidget::OnLeftButtonUp ( )

protected

OnMiddleButtonDown()

void vtkBrokenLineWidget::OnMiddleButtonDown ( )

protected

OnMiddleButtonUp()

void vtkBrokenLineWidget::OnMiddleButtonUp ( )

protected

OnRightButtonDown()

void vtkBrokenLineWidget::OnRightButtonDown ( )

protected

OnRightButtonUp()

void vtkBrokenLineWidget::OnRightButtonUp ( )

protected

OnMouseMove()

void vtkBrokenLineWidget::OnMouseMove ( )

protected

ProjectPointsToPlane()

void vtkBrokenLineWidget::ProjectPointsToPlane ( )

protected

ProjectPointsToOrthoPlane()

void vtkBrokenLineWidget::ProjectPointsToOrthoPlane ( )

protected

ProjectPointsToObliquePlane()

void vtkBrokenLineWidget::ProjectPointsToObliquePlane ( )

protected

HighlightLine()

void vtkBrokenLineWidget::HighlightLine ( int  highlight )

protected

BuildRepresentation()

void vtkBrokenLineWidget::BuildRepresentation ( )

protected

Initialize()

void vtkBrokenLineWidget::Initialize ( )

protected

HighlightHandle()

int vtkBrokenLineWidget::HighlightHandle ( vtkProp *  prop )

protected

SizeHandles()

void vtkBrokenLineWidget::SizeHandles ( )

overrideprotectedvirtual

Reimplemented from vtk3DWidget.

InsertHandleOnLine()

void vtkBrokenLineWidget::InsertHandleOnLine ( double *  pos )

protected

EraseHandle()

void vtkBrokenLineWidget::EraseHandle ( const int &  )

protected

RegisterPickers()

void vtkBrokenLineWidget::RegisterPickers ( )

overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

MovePoint()

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

protected

Scale()

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

protected

Translate()

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

protected

Spin()

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

protected

CreateDefaultProperties()

void vtkBrokenLineWidget::CreateDefaultProperties ( )

protected

CalculateCentroid()

void vtkBrokenLineWidget::CalculateCentroid ( )

protected

Member Data Documentation

State

int vtkBrokenLineWidget::State

protected

Definition at line 249 of file vtkBrokenLineWidget.h.

ProjectionNormal

int vtkBrokenLineWidget::ProjectionNormal

protected

Definition at line 275 of file vtkBrokenLineWidget.h.

ProjectionPosition

double vtkBrokenLineWidget::ProjectionPosition

protected

Definition at line 276 of file vtkBrokenLineWidget.h.

ProjectToPlane

vtkTypeBool vtkBrokenLineWidget::ProjectToPlane

protected

Definition at line 277 of file vtkBrokenLineWidget.h.

PlaneSource

vtkPlaneSource* vtkBrokenLineWidget::PlaneSource

protected

Definition at line 278 of file vtkBrokenLineWidget.h.

LineActor

vtkActor* vtkBrokenLineWidget::LineActor

protected

Definition at line 286 of file vtkBrokenLineWidget.h.

LineMapper

vtkPolyDataMapper* vtkBrokenLineWidget::LineMapper

protected

Definition at line 287 of file vtkBrokenLineWidget.h.

LineSource

vtkLineSource* vtkBrokenLineWidget::LineSource

protected

Definition at line 288 of file vtkBrokenLineWidget.h.

NumberOfHandles

int vtkBrokenLineWidget::NumberOfHandles

protected

Definition at line 290 of file vtkBrokenLineWidget.h.

Handle

vtkActor** vtkBrokenLineWidget::Handle

protected

Definition at line 294 of file vtkBrokenLineWidget.h.

HandleGeometry

vtkSphereSource** vtkBrokenLineWidget::HandleGeometry

protected

Definition at line 295 of file vtkBrokenLineWidget.h.

HandlePicker

vtkCellPicker* vtkBrokenLineWidget::HandlePicker

protected

Definition at line 303 of file vtkBrokenLineWidget.h.

LinePicker

vtkCellPicker* vtkBrokenLineWidget::LinePicker

protected

Definition at line 304 of file vtkBrokenLineWidget.h.

CurrentHandle

vtkActor* vtkBrokenLineWidget::CurrentHandle

protected

Definition at line 305 of file vtkBrokenLineWidget.h.

CurrentHandleIndex

int vtkBrokenLineWidget::CurrentHandleIndex

protected

Definition at line 306 of file vtkBrokenLineWidget.h.

Transform

vtkTransform* vtkBrokenLineWidget::Transform

protected

Definition at line 318 of file vtkBrokenLineWidget.h.

HandleProperty

vtkProperty* vtkBrokenLineWidget::HandleProperty

protected

Definition at line 322 of file vtkBrokenLineWidget.h.

SelectedHandleProperty

vtkProperty* vtkBrokenLineWidget::SelectedHandleProperty

protected

Definition at line 323 of file vtkBrokenLineWidget.h.

LineProperty

vtkProperty* vtkBrokenLineWidget::LineProperty

protected

Definition at line 324 of file vtkBrokenLineWidget.h.

SelectedLineProperty

vtkProperty* vtkBrokenLineWidget::SelectedLineProperty

protected

Definition at line 325 of file vtkBrokenLineWidget.h.

Centroid

double vtkBrokenLineWidget::Centroid[3]

protected

Definition at line 329 of file vtkBrokenLineWidget.h.

ProcessEvents

vtkTypeBool vtkBrokenLineWidget::ProcessEvents

protected

Definition at line 331 of file vtkBrokenLineWidget.h.

HandleSizeFactor

double vtkBrokenLineWidget::HandleSizeFactor

protected

Definition at line 334 of file vtkBrokenLineWidget.h.

---

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

• Interaction/Widgets/vtkBrokenLineWidget.h