vtkSplineWidget - 3D widget for manipulating a spline More...

Inheritance diagram for Kitware.VTK.vtkSplineWidget:

Collaboration diagram for Kitware.VTK.vtkSplineWidget:

Public Member Functions
	vtkSplineWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkSplineWidget ()
	Instantiate the object.
virtual void	ClosedOff ()
	Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.
virtual void	ClosedOn ()
	Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.
virtual int	GetClosed ()
	Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.
void	GetHandlePosition (int handle, IntPtr xyz)
	Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.
double[]	GetHandlePosition (int handle)
	Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.
virtual vtkProperty	GetHandleProperty ()
	Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.
virtual vtkProperty	GetLineProperty ()
	Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.
virtual int	GetNumberOfHandles ()
	Set/Get the number of handles for this widget.
virtual vtkParametricSpline	GetParametricSpline ()
	Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.
void	GetPolyData (vtkPolyData pd)
	Grab the polydata (including points) that defines the spline. The polydata consists of points and line segments numbering Resolution + 1 and Resoltuion, 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 int	GetProcessEvents ()
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual int	GetProcessEventsMaxValue ()
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual int	GetProcessEventsMinValue ()
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual int	GetProjectToPlane ()
	Force the spline 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 spline to the plane if it is orginally 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	GetProjectionNormal ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
virtual int	GetProjectionNormalMaxValue ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
virtual int	GetProjectionNormalMinValue ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
virtual double	GetProjectionPosition ()
	Set the position of spline 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 spline points when Projection normal is set to 3 for arbritrary plane orientations.
virtual int	GetResolution ()
	Set/Get the number of line segments representing the spline for this widget.
virtual vtkProperty	GetSelectedHandleProperty ()
	Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.
virtual vtkProperty	GetSelectedLineProperty ()
	Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.
double	GetSummedLength ()
	Get the approximate vs. the true arc length of the spline. Calculated as the summed lengths of the individual straight line segments. Use SetResolution to control the accuracy.
void	InitializeHandles (vtkPoints points)
	Convenience method to allocate and set the handles from a vtkPoints instance. If the first and last points are the same, the spline sets Closed to the on state and disregards the last point, otherwise Closed remains unchanged.
override int	IsA (string type)
	Instantiate the object.
int	IsClosed ()
	Convenience method to determine whether the spline is closed in a geometric sense. The widget may be set "closed" but still be geometrically open (e.g., a straight line).
new vtkSplineWidget	NewInstance ()
	Instantiate the object.
override void	PlaceWidget (IntPtr bounds)
	Methods that satisfy the superclass' API.
override void	PlaceWidget ()
	Methods that satisfy the superclass' API.
override void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	Methods that satisfy the superclass' API.
virtual void	ProcessEventsOff ()
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual void	ProcessEventsOn ()
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual void	ProjectToPlaneOff ()
	Force the spline 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 spline to the plane if it is orginally 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	ProjectToPlaneOn ()
	Force the spline 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 spline to the plane if it is orginally 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	SetClosed (int closed)
	Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.
override void	SetEnabled (int arg0)
	Methods that satisfy the superclass' API.
void	SetHandlePosition (int handle, double x, double y, double z)
	Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.
void	SetHandlePosition (int handle, IntPtr xyz)
	Set/Get the position of the spline handles. Call GetNumberOfHandles to determine the valid range of handle indices.
virtual void	SetHandleProperty (vtkProperty arg0)
	Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.
virtual void	SetLineProperty (vtkProperty arg0)
	Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.
virtual void	SetNumberOfHandles (int npts)
	Set/Get the number of handles for this widget.
virtual void	SetParametricSpline (vtkParametricSpline arg0)
	Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.
void	SetPlaneSource (vtkPlaneSource plane)
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
virtual void	SetProcessEvents (int _arg)
	Turn on / off event processing for this widget. If off, the widget will not respond to user interaction.
virtual void	SetProjectToPlane (int _arg)
	Force the spline 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 spline to the plane if it is orginally 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	SetProjectionNormal (int _arg)
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
void	SetProjectionNormalToOblique ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
void	SetProjectionNormalToXAxes ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
void	SetProjectionNormalToYAxes ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
void	SetProjectionNormalToZAxes ()
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. a vtkPolyDataSourceWidget.
void	SetProjectionPosition (double position)
	Set the position of spline 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 spline points when Projection normal is set to 3 for arbritrary plane orientations.
void	SetResolution (int resolution)
	Set/Get the number of line segments representing the spline for this widget.
virtual void	SetSelectedHandleProperty (vtkProperty arg0)
	Set/Get the handle properties (the spheres are the handles). The properties of the handles when selected and unselected can be manipulated.
virtual void	SetSelectedLineProperty (vtkProperty arg0)
	Set/Get the line properties. The properties of the line when selected and unselected can be manipulated.
Public Member Functions inherited from Kitware.VTK.vtk3DWidget
	vtk3DWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
virtual double	GetHandleSizeMaxValue ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
virtual double	GetHandleSizeMinValue ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
virtual vtkDataSet	GetInput ()
	Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.
virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
virtual double	GetPlaceFactorMaxValue ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
virtual double	GetPlaceFactorMinValue ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
virtual vtkProp3D	GetProp3D ()
	Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.
virtual void	SetHandleSize (double _arg)
	Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
virtual void	SetInput (vtkDataSet arg0)
	Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.
virtual void	SetPlaceFactor (double _arg)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
virtual void	SetProp3D (vtkProp3D arg0)
	Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.
Public Member Functions inherited from Kitware.VTK.vtkInteractorObserver
	vtkInteractorObserver (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
void	EnabledOff ()
	Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
void	EnabledOn ()
	Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
virtual vtkRenderer	GetCurrentRenderer ()
	Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
virtual vtkRenderer	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
int	GetEnabled ()
	Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
virtual vtkRenderWindowInteractor	GetInteractor ()
	This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.
virtual int	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual sbyte	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
virtual float	GetPriority ()
	Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
virtual float	GetPriorityMaxValue ()
	Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
virtual float	GetPriorityMinValue ()
	Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents)
	Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
void	Off ()
	Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
void	On ()
	Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
virtual void	OnChar ()
	Sets up the keypress-i event.
void	ReleaseFocus ()
	Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
virtual void	SetCurrentRenderer (vtkRenderer arg0)
	Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
virtual void	SetDefaultRenderer (vtkRenderer arg0)
	Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
virtual void	SetInteractor (vtkRenderWindowInteractor iren)
	This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.
virtual void	SetKeyPressActivation (int _arg)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
virtual void	SetKeyPressActivationValue (sbyte _arg)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
virtual void	SetPriority (float _arg)
	Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkSplineWidget	New ()
	Instantiate the object.
static new int	IsTypeOf (string type)
	Instantiate the object.
static new vtkSplineWidget	SafeDownCast (vtkObjectBase o)
	Instantiate the object.

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkSplineWidget"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtk3DWidget
Public Attributes inherited from Kitware.VTK.vtkInteractorObserver
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "15vtkSplineWidget"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtk3DWidget
Static Public Attributes inherited from Kitware.VTK.vtkInteractorObserver
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkSplineWidget ()
	Automatically generated type registration mechanics.

Detailed Description

vtkSplineWidget - 3D widget for manipulating a spline

Description This 3D widget defines a spline that can be interactively placed in a scene. The spline has handles, the number of which can be changed, plus it can be picked on the spline itself to translate or rotate it in the scene. A nice feature of the object is that the vtkSplineWidget, like any 3D widget, will work with the current interactor style. That is, if vtkSplineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkSplineWidget 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 vtkSplineWidget 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 spline: the handles act as "control points". 2) left button or middle button down on a line segment forming the spline 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 spline 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 spline. 6) shift key + right button down on any line segment will insert a handle onto the spline at the cursor position.

The vtkSplineWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the spline; 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 spline. For example, you can set the property for the handles and spline. In addition there are methods to constrain the spline 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!

Constructor & Destructor Documentation

static Kitware.VTK.vtkSplineWidget.vtkSplineWidget ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkSplineWidget.vtkSplineWidget	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkSplineWidget.vtkSplineWidget ( )

Instantiate the object.

Member Function Documentation

virtual void Kitware.VTK.vtkSplineWidget.ClosedOff ( )

virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

virtual void Kitware.VTK.vtkSplineWidget.ClosedOn ( )

virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

override void Kitware.VTK.vtkSplineWidget.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtk3DWidget.

virtual int Kitware.VTK.vtkSplineWidget.GetClosed ( )

virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

void Kitware.VTK.vtkSplineWidget.GetHandlePosition	(	int	handle,
		IntPtr	xyz
	)

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

double [] Kitware.VTK.vtkSplineWidget.GetHandlePosition ( int handle )

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

virtual vtkProperty Kitware.VTK.vtkSplineWidget.GetHandleProperty ( )

virtual

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

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkSplineWidget.GetLineProperty ( )

virtual

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

Here is the call graph for this function:

virtual int Kitware.VTK.vtkSplineWidget.GetNumberOfHandles ( )

virtual

Set/Get the number of handles for this widget.

virtual vtkParametricSpline Kitware.VTK.vtkSplineWidget.GetParametricSpline ( )

virtual

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

Here is the call graph for this function:

void Kitware.VTK.vtkSplineWidget.GetPolyData ( vtkPolyData pd )

Grab the polydata (including points) that defines the spline. The polydata consists of points and line segments numbering Resolution + 1 and Resoltuion, 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 int Kitware.VTK.vtkSplineWidget.GetProcessEvents ( )

virtual

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

virtual int Kitware.VTK.vtkSplineWidget.GetProcessEventsMaxValue ( )

virtual

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

virtual int Kitware.VTK.vtkSplineWidget.GetProcessEventsMinValue ( )

virtual

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

virtual int Kitware.VTK.vtkSplineWidget.GetProjectionNormal ( )

virtual

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

virtual int Kitware.VTK.vtkSplineWidget.GetProjectionNormalMaxValue ( )

virtual

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

virtual int Kitware.VTK.vtkSplineWidget.GetProjectionNormalMinValue ( )

virtual

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

virtual double Kitware.VTK.vtkSplineWidget.GetProjectionPosition ( )

virtual

Set the position of spline 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 spline points when Projection normal is set to 3 for arbritrary plane orientations.

virtual int Kitware.VTK.vtkSplineWidget.GetProjectToPlane ( )

virtual

Force the spline 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 spline to the plane if it is orginally 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 Kitware.VTK.vtkSplineWidget.GetResolution ( )

virtual

Set/Get the number of line segments representing the spline for this widget.

virtual vtkProperty Kitware.VTK.vtkSplineWidget.GetSelectedHandleProperty ( )

virtual

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

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkSplineWidget.GetSelectedLineProperty ( )

virtual

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

Here is the call graph for this function:

double Kitware.VTK.vtkSplineWidget.GetSummedLength ( )

Get the approximate vs. the true arc length of the spline. Calculated as the summed lengths of the individual straight line segments. Use SetResolution to control the accuracy.

void Kitware.VTK.vtkSplineWidget.InitializeHandles ( vtkPoints points )

Convenience method to allocate and set the handles from a vtkPoints instance. If the first and last points are the same, the spline sets Closed to the on state and disregards the last point, otherwise Closed remains unchanged.

override int Kitware.VTK.vtkSplineWidget.IsA ( string type )

virtual

Instantiate the object.

Reimplemented from Kitware.VTK.vtk3DWidget.

int Kitware.VTK.vtkSplineWidget.IsClosed ( )

Convenience method to determine whether the spline is closed in a geometric sense. The widget may be set "closed" but still be geometrically open (e.g., a straight line).

static new int Kitware.VTK.vtkSplineWidget.IsTypeOf ( string type )

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtk3DWidget.

static new vtkSplineWidget Kitware.VTK.vtkSplineWidget.New ( )

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

new vtkSplineWidget Kitware.VTK.vtkSplineWidget.NewInstance ( )

Instantiate the object.

Reimplemented from Kitware.VTK.vtk3DWidget.

override void Kitware.VTK.vtkSplineWidget.PlaceWidget ( IntPtr bounds )

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

override void Kitware.VTK.vtkSplineWidget.PlaceWidget ( )

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

override void Kitware.VTK.vtkSplineWidget.PlaceWidget	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

virtual void Kitware.VTK.vtkSplineWidget.ProcessEventsOff ( )

virtual

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

virtual void Kitware.VTK.vtkSplineWidget.ProcessEventsOn ( )

virtual

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

virtual void Kitware.VTK.vtkSplineWidget.ProjectToPlaneOff ( )

virtual

Force the spline 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 spline to the plane if it is orginally 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 Kitware.VTK.vtkSplineWidget.ProjectToPlaneOn ( )

virtual

Force the spline 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 spline to the plane if it is orginally 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.

static new vtkSplineWidget Kitware.VTK.vtkSplineWidget.SafeDownCast ( vtkObjectBase o )

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtk3DWidget.

Here is the call graph for this function:

void Kitware.VTK.vtkSplineWidget.SetClosed ( int closed )

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous. A minimum of 3 handles are required to form a closed loop. This method enforces consistency with user supplied subclasses of vtkSpline.

override void Kitware.VTK.vtkSplineWidget.SetEnabled ( int arg0 )

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

void Kitware.VTK.vtkSplineWidget.SetHandlePosition	(	int	handle,
		double	x,
		double	y,
		double	z
	)

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

void Kitware.VTK.vtkSplineWidget.SetHandlePosition	(	int	handle,
		IntPtr	xyz
	)

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

virtual void Kitware.VTK.vtkSplineWidget.SetHandleProperty ( vtkProperty arg0 )

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 Kitware.VTK.vtkSplineWidget.SetLineProperty ( vtkProperty arg0 )

virtual

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

virtual void Kitware.VTK.vtkSplineWidget.SetNumberOfHandles ( int npts )

virtual

Set/Get the number of handles for this widget.

virtual void Kitware.VTK.vtkSplineWidget.SetParametricSpline ( vtkParametricSpline arg0 )

virtual

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of currently two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

void Kitware.VTK.vtkSplineWidget.SetPlaneSource ( vtkPlaneSource plane )

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

virtual void Kitware.VTK.vtkSplineWidget.SetProcessEvents ( int _arg )

virtual

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

virtual void Kitware.VTK.vtkSplineWidget.SetProjectionNormal ( int _arg )

virtual

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

void Kitware.VTK.vtkSplineWidget.SetProjectionNormalToOblique ( )

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

void Kitware.VTK.vtkSplineWidget.SetProjectionNormalToXAxes ( )

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

void Kitware.VTK.vtkSplineWidget.SetProjectionNormalToYAxes ( )

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

void Kitware.VTK.vtkSplineWidget.SetProjectionNormalToZAxes ( )

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

void Kitware.VTK.vtkSplineWidget.SetProjectionPosition ( double position )

Set the position of spline 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 spline points when Projection normal is set to 3 for arbritrary plane orientations.

virtual void Kitware.VTK.vtkSplineWidget.SetProjectToPlane ( int _arg )

virtual

Force the spline 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 spline to the plane if it is orginally 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 Kitware.VTK.vtkSplineWidget.SetResolution ( int resolution )

Set/Get the number of line segments representing the spline for this widget.

virtual void Kitware.VTK.vtkSplineWidget.SetSelectedHandleProperty ( vtkProperty arg0 )

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 Kitware.VTK.vtkSplineWidget.SetSelectedLineProperty ( vtkProperty arg0 )

virtual

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

Member Data Documentation

new readonly string Kitware.VTK.vtkSplineWidget.MRClassNameKey = "15vtkSplineWidget"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtk3DWidget.

new const string Kitware.VTK.vtkSplineWidget.MRFullTypeName = "Kitware.VTK.vtkSplineWidget"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtk3DWidget.

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

csharp/vtkSplineWidget.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation