vtkPlaneWidget - 3D widget for manipulating a finite plane More...

Inheritance diagram for Kitware.VTK.vtkPlaneWidget:

Collaboration diagram for Kitware.VTK.vtkPlaneWidget:

Public Member Functions
	vtkPlaneWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkPlaneWidget ()
	Instantiate the object.
double[]	GetCenter ()
	Get the center of the plane.
void	GetCenter (IntPtr xyz)
	Get the center of the plane.
virtual vtkProperty	GetHandleProperty ()
	Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.
double[]	GetNormal ()
	Get the normal to the plane.
void	GetNormal (IntPtr xyz)
	Get the normal to the plane.
virtual int	GetNormalToXAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual int	GetNormalToYAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual int	GetNormalToZAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
double[]	GetOrigin ()
	Set/Get the origin of the plane.
void	GetOrigin (IntPtr xyz)
	Set/Get the origin of the plane.
void	GetPlane (vtkPlane plane)
	Get the planes describing the implicit function defined by the plane widget. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.
virtual vtkProperty	GetPlaneProperty ()
	Get the plane properties. The properties of the plane when selected and unselected can be manipulated.
double[]	GetPoint1 ()
	Set/Get the position of the point defining the first axis of the plane.
void	GetPoint1 (IntPtr xyz)
	Set/Get the position of the point defining the first axis of the plane.
double[]	GetPoint2 ()
	Set/Get the position of the point defining the second axis of the plane.
void	GetPoint2 (IntPtr xyz)
	Set/Get the position of the point defining the second axis of the plane.
void	GetPolyData (vtkPolyData pd)
	Grab the polydata (including points) that defines the plane. The polydata consists of (res+1)(res+1) points, and resres quadrilateral polygons, where res is the resolution of the plane. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyplane are added to it.
override vtkPolyDataAlgorithm	GetPolyDataAlgorithm ()
	Satisfies superclass API. This returns a pointer to the underlying PolyData. Make changes to this before calling the initial PlaceWidget() to have the initial placement follow suit. Or, make changes after the widget has been initialised and call UpdatePlacement() to realise.
virtual int	GetRepresentation ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
virtual int	GetRepresentationMaxValue ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
virtual int	GetRepresentationMinValue ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
int	GetResolution ()
	Set/Get the resolution (number of subdivisions) of the plane.
virtual vtkProperty	GetSelectedHandleProperty ()
	Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.
virtual vtkProperty	GetSelectedPlaneProperty ()
	Get the plane properties. The properties of the plane when selected and unselected can be manipulated.
override int	IsA (string type)
	Instantiate the object.
new vtkPlaneWidget	NewInstance ()
	Instantiate the object.
virtual void	NormalToXAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	NormalToXAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	NormalToYAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	NormalToYAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	NormalToZAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	NormalToZAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
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.
void	SetCenter (double x, double y, double z)
	Get the center of the plane.
void	SetCenter (IntPtr x)
	Get the center of the plane.
override void	SetEnabled (int arg0)
	Methods that satisfy the superclass' API.
void	SetNormal (double x, double y, double z)
	Get the normal to the plane.
void	SetNormal (IntPtr x)
	Get the normal to the plane.
virtual void	SetNormalToXAxis (int _arg)
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	SetNormalToYAxis (int _arg)
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
virtual void	SetNormalToZAxis (int _arg)
	Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.
void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the plane.
void	SetOrigin (IntPtr x)
	Set/Get the origin of the plane.
virtual void	SetPlaneProperty (vtkProperty arg0)
	Get the plane properties. The properties of the plane when selected and unselected can be manipulated.
void	SetPoint1 (double x, double y, double z)
	Set/Get the position of the point defining the first axis of the plane.
void	SetPoint1 (IntPtr x)
	Set/Get the position of the point defining the first axis of the plane.
void	SetPoint2 (double x, double y, double z)
	Set/Get the position of the point defining the second axis of the plane.
void	SetPoint2 (IntPtr x)
	Set/Get the position of the point defining the second axis of the plane.
virtual void	SetRepresentation (int _arg)
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
void	SetRepresentationToOff ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
void	SetRepresentationToOutline ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
void	SetRepresentationToSurface ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
void	SetRepresentationToWireframe ()
	Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.
void	SetResolution (int r)
	Set/Get the resolution (number of subdivisions) of the plane.
override void	UpdatePlacement ()
	Satisfies superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource.
Public Member Functions inherited from Kitware.VTK.vtkPolyDataSourceWidget
	vtkPolyDataSourceWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkPolyDataSource	GetPolyDataSource ()
	Returns underlying vtkPolyDataSource that determines geometry. This can be modified after which PlaceWidget() or UpdatePlacement() can be called. UpdatePlacement() will always update the planewidget according to the geometry of the underlying PolyDataSource. PlaceWidget() will only make use of this geometry if there is no Input and no Prop3D set.
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 vtkPlaneWidget	New ()
	Instantiate the object.
static new int	IsTypeOf (string type)
	Instantiate the object.
static new vtkPlaneWidget	SafeDownCast (vtkObjectBase o)
	Instantiate the object.

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkPlaneWidget"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkPolyDataSourceWidget
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 = "14vtkPlaneWidget"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkPolyDataSourceWidget
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	vtkPlaneWidget ()
	Automatically generated type registration mechanics.

Detailed Description

vtkPlaneWidget - 3D widget for manipulating a finite plane

Description This 3D widget defines a finite (bounded) plane that can be interactively placed in a scene. The plane has four handles (at its corner vertices), a normal vector, and the plane itself. The handles are used to resize the plane; the normal vector to rotate it, and the plane can be picked and translated. Selecting the plane while pressing CTRL makes it spin around the normal. A nice feature of the object is that the vtkPlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPlaneWidget 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. If the "i" key (for "interactor") is pressed, the vtkPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the one of the four handles (use the left mouse button), the plane can be resized. By grabbing the plane itself, the entire plane can be arbitrarily translated. Pressing CTRL while grabbing the plane will spin the plane around the normal. If you select the normal vector, the plane can be arbitrarily rotated. Selecting any part of the widget with the middle mouse button enables translation of the plane along its normal. (Once selected using middle mouse, moving the mouse in the direction of the normal translates the plane in the direction of the normal; moving in the direction opposite the normal translates the plane in the direction opposite the normal.) Scaling (about the center of the plane) is achieved by using the right mouse button. By moving the mouse "up" the render window the plane will be made bigger; by moving "down" the render window the widget will be made smaller. 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 vtkPlaneWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the plane; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding stream lines. GetPlane() can be used to update a vtkPlane implicit function. 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 plane. For example, you can set the property for the handles and plane. In addition there are methods to constrain the plane so that it is perpendicular to the x-y-z axes.

Constructor & Destructor Documentation

static Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget ( )

Instantiate the object.

Member Function Documentation

override void Kitware.VTK.vtkPlaneWidget.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.vtkPolyDataSourceWidget.

double [] Kitware.VTK.vtkPlaneWidget.GetCenter ( )

Get the center of the plane.

void Kitware.VTK.vtkPlaneWidget.GetCenter ( IntPtr xyz )

Get the center of the plane.

virtual vtkProperty Kitware.VTK.vtkPlaneWidget.GetHandleProperty ( )

virtual

Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.

Here is the call graph for this function:

double [] Kitware.VTK.vtkPlaneWidget.GetNormal ( )

Get the normal to the plane.

void Kitware.VTK.vtkPlaneWidget.GetNormal ( IntPtr xyz )

Get the normal to the plane.

virtual int Kitware.VTK.vtkPlaneWidget.GetNormalToXAxis ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual int Kitware.VTK.vtkPlaneWidget.GetNormalToYAxis ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual int Kitware.VTK.vtkPlaneWidget.GetNormalToZAxis ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

double [] Kitware.VTK.vtkPlaneWidget.GetOrigin ( )

Set/Get the origin of the plane.

void Kitware.VTK.vtkPlaneWidget.GetOrigin ( IntPtr xyz )

Set/Get the origin of the plane.

void Kitware.VTK.vtkPlaneWidget.GetPlane ( vtkPlane plane )

Get the planes describing the implicit function defined by the plane widget. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

virtual vtkProperty Kitware.VTK.vtkPlaneWidget.GetPlaneProperty ( )

virtual

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

Here is the call graph for this function:

double [] Kitware.VTK.vtkPlaneWidget.GetPoint1 ( )

Set/Get the position of the point defining the first axis of the plane.

void Kitware.VTK.vtkPlaneWidget.GetPoint1 ( IntPtr xyz )

Set/Get the position of the point defining the first axis of the plane.

double [] Kitware.VTK.vtkPlaneWidget.GetPoint2 ( )

Set/Get the position of the point defining the second axis of the plane.

void Kitware.VTK.vtkPlaneWidget.GetPoint2 ( IntPtr xyz )

Set/Get the position of the point defining the second axis of the plane.

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

Grab the polydata (including points) that defines the plane. The polydata consists of (res+1)*(res+1) points, and res*res quadrilateral polygons, where res is the resolution of the plane. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyplane are added to it.

override vtkPolyDataAlgorithm Kitware.VTK.vtkPlaneWidget.GetPolyDataAlgorithm ( )

virtual

Satisfies superclass API. This returns a pointer to the underlying PolyData. Make changes to this before calling the initial PlaceWidget() to have the initial placement follow suit. Or, make changes after the widget has been initialised and call UpdatePlacement() to realise.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkPlaneWidget.GetRepresentation ( )

virtual

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

virtual int Kitware.VTK.vtkPlaneWidget.GetRepresentationMaxValue ( )

virtual

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

virtual int Kitware.VTK.vtkPlaneWidget.GetRepresentationMinValue ( )

virtual

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

int Kitware.VTK.vtkPlaneWidget.GetResolution ( )

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

virtual vtkProperty Kitware.VTK.vtkPlaneWidget.GetSelectedHandleProperty ( )

virtual

Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkPlaneWidget.GetSelectedPlaneProperty ( )

virtual

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

Here is the call graph for this function:

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

virtual

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

new vtkPlaneWidget Kitware.VTK.vtkPlaneWidget.NewInstance ( )

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToXAxisOff ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToXAxisOn ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToYAxisOff ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToYAxisOn ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToZAxisOff ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToZAxisOn ( )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

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

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

override void Kitware.VTK.vtkPlaneWidget.PlaceWidget ( )

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

void Kitware.VTK.vtkPlaneWidget.SetCenter	(	double	x,
		double	y,
		double	z
	)

Get the center of the plane.

void Kitware.VTK.vtkPlaneWidget.SetCenter ( IntPtr x )

Get the center of the plane.

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

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

void Kitware.VTK.vtkPlaneWidget.SetNormal	(	double	x,
		double	y,
		double	z
	)

Get the normal to the plane.

void Kitware.VTK.vtkPlaneWidget.SetNormal ( IntPtr x )

Get the normal to the plane.

virtual void Kitware.VTK.vtkPlaneWidget.SetNormalToXAxis ( int _arg )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.SetNormalToYAxis ( int _arg )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

virtual void Kitware.VTK.vtkPlaneWidget.SetNormalToZAxis ( int _arg )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is orginally not aligned.

void Kitware.VTK.vtkPlaneWidget.SetOrigin	(	double	x,
		double	y,
		double	z
	)

Set/Get the origin of the plane.

void Kitware.VTK.vtkPlaneWidget.SetOrigin ( IntPtr x )

Set/Get the origin of the plane.

virtual void Kitware.VTK.vtkPlaneWidget.SetPlaneProperty ( vtkProperty arg0 )

virtual

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

void Kitware.VTK.vtkPlaneWidget.SetPoint1	(	double	x,
		double	y,
		double	z
	)

Set/Get the position of the point defining the first axis of the plane.

void Kitware.VTK.vtkPlaneWidget.SetPoint1 ( IntPtr x )

Set/Get the position of the point defining the first axis of the plane.

void Kitware.VTK.vtkPlaneWidget.SetPoint2	(	double	x,
		double	y,
		double	z
	)

Set/Get the position of the point defining the second axis of the plane.

void Kitware.VTK.vtkPlaneWidget.SetPoint2 ( IntPtr x )

Set/Get the position of the point defining the second axis of the plane.

virtual void Kitware.VTK.vtkPlaneWidget.SetRepresentation ( int _arg )

virtual

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void Kitware.VTK.vtkPlaneWidget.SetRepresentationToOff ( )

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void Kitware.VTK.vtkPlaneWidget.SetRepresentationToOutline ( )

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void Kitware.VTK.vtkPlaneWidget.SetRepresentationToSurface ( )

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void Kitware.VTK.vtkPlaneWidget.SetRepresentationToWireframe ( )

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void Kitware.VTK.vtkPlaneWidget.SetResolution ( int r )

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

override void Kitware.VTK.vtkPlaneWidget.UpdatePlacement ( )

virtual

Satisfies superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.