Kitware.VTK.vtkImagePlaneWidget Class Reference

vtkImagePlaneWidget - 3D widget for reslicing image data More...

Inheritance diagram for Kitware.VTK.vtkImagePlaneWidget:

Collaboration diagram for Kitware.VTK.vtkImagePlaneWidget:

List of all members.

Public Types
enum	VTK_CURSOR_ACTION_WrapperEnum { VTK_CURSOR_ACTION = 0, VTK_SLICE_MOTION_ACTION = 1, VTK_WINDOW_LEVEL_ACTION = 2 }
	Enable/disable mouse interaction so the widget remains on display. More...
enum	VTK_CONTROL_MODIFIER_WrapperEnum { VTK_CONTROL_MODIFIER = 2, VTK_NO_MODIFIER = 0, VTK_SHIFT_MODIFIER = 1 }
	Enable/disable mouse interaction so the widget remains on display. More...

Public Member Functions
	vtkImagePlaneWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkImagePlaneWidget ()
	Instantiate the object.
virtual void	DisplayTextOff ()
	Enable/disable text display of window-level, image coordinates and scalar values in a render window.
virtual void	DisplayTextOn ()
	Enable/disable text display of window-level, image coordinates and scalar values in a render window.
void	GetCenter (IntPtr xyz)
	Get the center of the plane.
double[]	GetCenter ()
	Get the center of the plane.
virtual vtkImageMapToColors	GetColorMap ()
	Convenience method to get the vtkImageMapToColors filter used by this widget. The user can properly render other transparent actors in a scene by calling the filter's SetOutputFormatToRGB and PassAlphaToOutputOff.
virtual double[]	GetCurrentCursorPosition ()
	Get the current cursor position. To be used in conjunction with GetCursorDataStatus.
virtual void	GetCurrentCursorPosition (IntPtr data)
	Get the current cursor position. To be used in conjunction with GetCursorDataStatus.
virtual double	GetCurrentImageValue ()
	Get the current image value at the current cursor position. To be used in conjunction with GetCursorDataStatus. The value is VTK_DOUBLE_MAX when the data is invalid.
int	GetCursorData (IntPtr xyzv)
	Get the image coordinate position and voxel value. Currently only supports single component image data.
int	GetCursorDataStatus ()
	Get the status of the cursor data. If this returns 1 the CurrentCursorPosition and CurrentImageValue will have current data. If it returns 0, these values are invalid.
virtual vtkProperty	GetCursorProperty ()
	Set the properties of the cross-hair cursor.
virtual int	GetDisplayText ()
	Enable/disable text display of window-level, image coordinates and scalar values in a render window.
virtual int	GetInteraction ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonAction ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonActionMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonActionMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonAutoModifier ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonAutoModifierMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetLeftButtonAutoModifierMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
double	GetLevel ()
	Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.
virtual vtkLookupTable	GetLookupTable ()
	Set/Get the internal lookuptable (lut) to one defined by the user, or, alternatively, to the lut of another vtkImgePlaneWidget. In this way, a set of three orthogonal planes can share the same lut so that window-levelling is performed uniformly among planes. The default internal lut can be re- set/allocated by setting to 0 (NULL).
virtual vtkProperty	GetMarginProperty ()
	Set the properties of the margins.
virtual double	GetMarginSizeX ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual double	GetMarginSizeXMaxValue ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual double	GetMarginSizeXMinValue ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual double	GetMarginSizeY ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual double	GetMarginSizeYMaxValue ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual double	GetMarginSizeYMinValue ()
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual int	GetMiddleButtonAction ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetMiddleButtonActionMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetMiddleButtonActionMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetMiddleButtonAutoModifier ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetMiddleButtonAutoModifierMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetMiddleButtonAutoModifierMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
double[]	GetNormal ()
	Get the normal to the plane.
void	GetNormal (IntPtr xyz)
	Get the normal to the plane.
double[]	GetOrigin ()
	Set/Get the origin of the plane.
void	GetOrigin (IntPtr xyz)
	Set/Get the origin of the plane.
virtual int	GetPlaneOrientation ()
	Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).
virtual vtkProperty	GetPlaneProperty ()
	Set/Get the plane's outline properties. The properties of the plane's outline 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 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 polygons are added to it.
override vtkPolyDataAlgorithm	GetPolyDataAlgorithm ()
	Satisfies superclass API. This returns a pointer to the underlying vtkPolyData. 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 vtkImageReslice	GetReslice ()
	Get the current reslice class and reslice axes.
virtual vtkMatrix4x4	GetResliceAxes ()
	Get the current reslice class and reslice axes.
virtual int	GetResliceInterpolate ()
	Set the interpolation to use when texturing the plane.
vtkImageData	GetResliceOutput ()
	Convenience method to get the vtkImageReslice output.
virtual int	GetRestrictPlaneToVolume ()
	Make sure that the plane remains within the volume. Default is On.
virtual int	GetRightButtonAction ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetRightButtonActionMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetRightButtonActionMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetRightButtonAutoModifier ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetRightButtonAutoModifierMaxValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual int	GetRightButtonAutoModifierMinValue ()
	Enable/disable mouse interaction so the widget remains on display.
virtual vtkProperty	GetSelectedPlaneProperty ()
	Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.
int	GetSliceIndex ()
	Get the slice position in terms of the data extent.
double	GetSlicePosition ()
	Get the position of the slice along its normal.
vtkTextProperty	GetTextProperty ()
	Set/Get the text property for the image data and window-level annotation.
vtkTexture	GetTexture ()
	Convenience method to get the texture used by this widget. This can be used in external slice viewers.
virtual int	GetTextureInterpolate ()
	Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.
virtual vtkProperty	GetTexturePlaneProperty ()
	Set/Get the property for the resliced image.
virtual int	GetTextureVisibility ()
	Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.
virtual int	GetUseContinuousCursor ()
	Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.
virtual int	GetUserControlledLookupTable ()
	Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.
void	GetVector1 (IntPtr v1)
	Get the vector from the plane origin to point1.
void	GetVector2 (IntPtr v2)
	Get the vector from the plane origin to point2.
double	GetWindow ()
	Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.
void	GetWindowLevel (IntPtr wl)
	Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.
virtual void	InteractionOff ()
	Enable/disable mouse interaction so the widget remains on display.
virtual void	InteractionOn ()
	Enable/disable mouse interaction so the widget remains on display.
override int	IsA (string type)
	Instantiate the object.
new vtkImagePlaneWidget	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	RestrictPlaneToVolumeOff ()
	Make sure that the plane remains within the volume. Default is On.
virtual void	RestrictPlaneToVolumeOn ()
	Make sure that the plane remains within the volume. Default is On.
virtual void	SetColorMap (vtkImageMapToColors arg0)
	Convenience method to get the vtkImageMapToColors filter used by this widget. The user can properly render other transparent actors in a scene by calling the filter's SetOutputFormatToRGB and PassAlphaToOutputOff.
virtual void	SetCursorProperty (vtkProperty arg0)
	Set the properties of the cross-hair cursor.
virtual void	SetDisplayText (int _arg)
	Enable/disable text display of window-level, image coordinates and scalar values in a render window.
override void	SetEnabled (int arg0)
	Methods that satisfy the superclass' API.
override void	SetInput (vtkDataSet input)
	Set the vtkImageData* input for the vtkImageReslice.
void	SetInteraction (int interact)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetLeftButtonAction (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetLeftButtonAutoModifier (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetLookupTable (vtkLookupTable arg0)
	Set/Get the internal lookuptable (lut) to one defined by the user, or, alternatively, to the lut of another vtkImgePlaneWidget. In this way, a set of three orthogonal planes can share the same lut so that window-levelling is performed uniformly among planes. The default internal lut can be re- set/allocated by setting to 0 (NULL).
virtual void	SetMarginProperty (vtkProperty arg0)
	Set the properties of the margins.
virtual void	SetMarginSizeX (double _arg)
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual void	SetMarginSizeY (double _arg)
	Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.
virtual void	SetMiddleButtonAction (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetMiddleButtonAutoModifier (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the plane.
void	SetOrigin (IntPtr xyz)
	Set/Get the origin of the plane.
void	SetPicker (vtkAbstractPropPicker arg0)
	Set the internal picker to one defined by the user. In this way, a set of three orthogonal planes can share the same picker so that picking is performed correctly. The default internal picker can be re-set/allocated by setting to 0 (NULL).
void	SetPlaneOrientation (int arg0)
	Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).
void	SetPlaneOrientationToXAxes ()
	Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).
void	SetPlaneOrientationToYAxes ()
	Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).
void	SetPlaneOrientationToZAxes ()
	Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).
virtual void	SetPlaneProperty (vtkProperty arg0)
	Set/Get the plane's outline properties. The properties of the plane's outline 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 xyz)
	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 xyz)
	Set/Get the position of the point defining the second axis of the plane.
void	SetResliceInterpolate (int arg0)
	Set the interpolation to use when texturing the plane.
void	SetResliceInterpolateToCubic ()
	Set the interpolation to use when texturing the plane.
void	SetResliceInterpolateToLinear ()
	Set the interpolation to use when texturing the plane.
void	SetResliceInterpolateToNearestNeighbour ()
	Set the interpolation to use when texturing the plane.
virtual void	SetRestrictPlaneToVolume (int _arg)
	Make sure that the plane remains within the volume. Default is On.
virtual void	SetRightButtonAction (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetRightButtonAutoModifier (int _arg)
	Enable/disable mouse interaction so the widget remains on display.
virtual void	SetSelectedPlaneProperty (vtkProperty arg0)
	Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.
void	SetSliceIndex (int index)
	Set the slice position in terms of the data extent.
void	SetSlicePosition (double position)
	Set the position of the slice along its normal.
void	SetTextProperty (vtkTextProperty tprop)
	Set/Get the text property for the image data and window-level annotation.
virtual void	SetTextureInterpolate (int _arg)
	Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.
virtual void	SetTexturePlaneProperty (vtkProperty arg0)
	Set/Get the property for the resliced image.
virtual void	SetTextureVisibility (int arg0)
	Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.
virtual void	SetUseContinuousCursor (int _arg)
	Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.
virtual void	SetUserControlledLookupTable (int _arg)
	Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.
void	SetWindowLevel (double window, double level, int copy)
	Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.
virtual void	TextureInterpolateOff ()
	Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.
virtual void	TextureInterpolateOn ()
	Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.
virtual void	TextureVisibilityOff ()
	Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.
virtual void	TextureVisibilityOn ()
	Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.
override void	UpdatePlacement ()
	Satisfies superclass API. This will change the state of the widget to match changes that have been made to the underlying vtkPolyDataSource.
virtual void	UseContinuousCursorOff ()
	Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.
virtual void	UseContinuousCursorOn ()
	Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.
virtual void	UserControlledLookupTableOff ()
	Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.
virtual void	UserControlledLookupTableOn ()
	Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.
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	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 vtkImagePlaneWidget	New ()
	Instantiate the object.
static new int	IsTypeOf (string type)
	Instantiate the object.
static new vtkImagePlaneWidget	SafeDownCast (vtkObjectBase o)
	Instantiate the object.

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkImagePlaneWidget"
	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 = "19vtkImagePlaneWidget"
	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	vtkImagePlaneWidget ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkImagePlaneWidget - 3D widget for reslicing image data

Description This 3D widget defines a plane that can be interactively placed in an image volume. A nice feature of the object is that the vtkImagePlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkImagePlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkImagePlaneWidget will terminate the processing of the event that it handles.

The core functionality of the widget is provided by a vtkImageReslice object which passes its output onto a texture mapping pipeline for fast slicing through volumetric data. See the key methods: GenerateTexturePlane() and UpdatePlane() for implementation details.

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 vtkImagePlaneWidget will appear. (See superclass documentation for information about changing this behavior.)

Selecting the widget with the middle mouse button with and without holding the shift or control keys enables complex reslicing capablilites. To facilitate use, a set of 'margins' (left, right, top, bottom) are shown as a set of plane-axes aligned lines, the properties of which can be changed as a group. Without keyboard modifiers: selecting in the middle of the margins enables translation of the plane along its normal. Selecting one of the corners within the margins enables spinning around the plane's normal at its center. Selecting within a margin allows rotating about the center of the plane around an axis aligned with the margin (i.e., selecting left margin enables rotating around the plane's local y-prime axis). With control key modifier: margin selection enables edge translation (i.e., a constrained form of scaling). Selecting within the margins enables translation of the entire plane. With shift key modifier: uniform plane scaling is enabled. Moving the mouse up enlarges the plane while downward movement shrinks it.

Window-level is achieved by using the right mouse button. Window-level values can be reset by shift + 'r' or control + 'r' while regular reset camera is maintained with 'r' or 'R'. The left mouse button can be used to query the underlying image data with a snap-to cross-hair cursor. Currently, the nearest point in the input image data to the mouse cursor generates the cross-hairs. With oblique slicing, this behaviour may appear unsatisfactory. Text display of window-level and image coordinates/data values are provided by a text actor/mapper pair.

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). To support interactive manipulation of objects, this class invokes the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent as well as StartWindowLevelEvent, WindowLevelEvent, EndWindowLevelEvent and ResetWindowLevelEvent.

The vtkImagePlaneWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get the polygonal representation of the plane and can be used as input for other VTK objects. 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's outline; the text actor via its vtkTextProperty; the cross-hair cursor. In addition there are methods to constrain the plane so that it is aligned along the x-y-z axes. Finally, one can specify the degree of interpolation (vtkImageReslice): nearest neighbour, linear, and cubic.

---

Member Enumeration Documentation

enum Kitware.VTK.vtkImagePlaneWidget.VTK_CONTROL_MODIFIER_WrapperEnum

Enable/disable mouse interaction so the widget remains on display.

Enumerator:

VTK_CONTROL_MODIFIER	enum member
VTK_NO_MODIFIER	enum member
VTK_SHIFT_MODIFIER	enum member

enum Kitware.VTK.vtkImagePlaneWidget.VTK_CURSOR_ACTION_WrapperEnum

Enable/disable mouse interaction so the widget remains on display.

Enumerator:

VTK_CURSOR_ACTION	enum member
VTK_SLICE_MOTION_ACTION	enum member
VTK_WINDOW_LEVEL_ACTION	enum member

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkImagePlaneWidget.vtkImagePlaneWidget ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkImagePlaneWidget.vtkImagePlaneWidget

(

)

Instantiate the object.

---

Member Function Documentation

virtual void Kitware.VTK.vtkImagePlaneWidget.DisplayTextOff ( )

virtual

Enable/disable text display of window-level, image coordinates and scalar values in a render window.

virtual void Kitware.VTK.vtkImagePlaneWidget.DisplayTextOn ( )

virtual

Enable/disable text display of window-level, image coordinates and scalar values in a render window.

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

void Kitware.VTK.vtkImagePlaneWidget.GetCenter

(

IntPtr

xyz

)

Get the center of the plane.

double [] Kitware.VTK.vtkImagePlaneWidget.GetCenter

(

)

Get the center of the plane.

virtual vtkImageMapToColors Kitware.VTK.vtkImagePlaneWidget.GetColorMap ( )

virtual

Convenience method to get the vtkImageMapToColors filter used by this widget. The user can properly render other transparent actors in a scene by calling the filter's SetOutputFormatToRGB and PassAlphaToOutputOff.

Here is the call graph for this function:

virtual double [] Kitware.VTK.vtkImagePlaneWidget.GetCurrentCursorPosition ( )

virtual

Get the current cursor position. To be used in conjunction with GetCursorDataStatus.

virtual void Kitware.VTK.vtkImagePlaneWidget.GetCurrentCursorPosition ( IntPtr  data )

virtual

Get the current cursor position. To be used in conjunction with GetCursorDataStatus.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetCurrentImageValue ( )

virtual

Get the current image value at the current cursor position. To be used in conjunction with GetCursorDataStatus. The value is VTK_DOUBLE_MAX when the data is invalid.

int Kitware.VTK.vtkImagePlaneWidget.GetCursorData

(

IntPtr

xyzv

)

Get the image coordinate position and voxel value. Currently only supports single component image data.

int Kitware.VTK.vtkImagePlaneWidget.GetCursorDataStatus

(

)

Get the status of the cursor data. If this returns 1 the CurrentCursorPosition and CurrentImageValue will have current data. If it returns 0, these values are invalid.

virtual vtkProperty Kitware.VTK.vtkImagePlaneWidget.GetCursorProperty ( )

virtual

Set the properties of the cross-hair cursor.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImagePlaneWidget.GetDisplayText ( )

virtual

Enable/disable text display of window-level, image coordinates and scalar values in a render window.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetInteraction ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonAction ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonActionMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonActionMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonAutoModifier ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonAutoModifierMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetLeftButtonAutoModifierMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

double Kitware.VTK.vtkImagePlaneWidget.GetLevel

(

)

Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.

virtual vtkLookupTable Kitware.VTK.vtkImagePlaneWidget.GetLookupTable ( )

virtual

Set/Get the internal lookuptable (lut) to one defined by the user, or, alternatively, to the lut of another vtkImgePlaneWidget. In this way, a set of three orthogonal planes can share the same lut so that window-levelling is performed uniformly among planes. The default internal lut can be re- set/allocated by setting to 0 (NULL).

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkImagePlaneWidget.GetMarginProperty ( )

virtual

Set the properties of the margins.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeX ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeXMaxValue ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeXMinValue ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeY ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeYMaxValue ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual double Kitware.VTK.vtkImagePlaneWidget.GetMarginSizeYMinValue ( )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonAction ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonActionMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonActionMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonAutoModifier ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonAutoModifierMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetMiddleButtonAutoModifierMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

double [] Kitware.VTK.vtkImagePlaneWidget.GetNormal

(

)

Get the normal to the plane.

void Kitware.VTK.vtkImagePlaneWidget.GetNormal

(

IntPtr

xyz

)

Get the normal to the plane.

double [] Kitware.VTK.vtkImagePlaneWidget.GetOrigin

(

)

Set/Get the origin of the plane.

void Kitware.VTK.vtkImagePlaneWidget.GetOrigin

(

IntPtr

xyz

)

Set/Get the origin of the plane.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetPlaneOrientation ( )

virtual

Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).

virtual vtkProperty Kitware.VTK.vtkImagePlaneWidget.GetPlaneProperty ( )

virtual

Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.

Here is the call graph for this function:

double [] Kitware.VTK.vtkImagePlaneWidget.GetPoint1

(

)

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

void Kitware.VTK.vtkImagePlaneWidget.GetPoint1

(

IntPtr

xyz

)

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

double [] Kitware.VTK.vtkImagePlaneWidget.GetPoint2

(

)

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

void Kitware.VTK.vtkImagePlaneWidget.GetPoint2

(

IntPtr

xyz

)

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

void Kitware.VTK.vtkImagePlaneWidget.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 polygons are added to it.

override vtkPolyDataAlgorithm Kitware.VTK.vtkImagePlaneWidget.GetPolyDataAlgorithm ( )

virtual

Satisfies superclass API. This returns a pointer to the underlying vtkPolyData. 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 vtkImageReslice Kitware.VTK.vtkImagePlaneWidget.GetReslice ( )

virtual

Get the current reslice class and reslice axes.

Here is the call graph for this function:

virtual vtkMatrix4x4 Kitware.VTK.vtkImagePlaneWidget.GetResliceAxes ( )

virtual

Get the current reslice class and reslice axes.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImagePlaneWidget.GetResliceInterpolate ( )

virtual

Set the interpolation to use when texturing the plane.

vtkImageData Kitware.VTK.vtkImagePlaneWidget.GetResliceOutput

(

)

Convenience method to get the vtkImageReslice output.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRestrictPlaneToVolume ( )

virtual

Make sure that the plane remains within the volume. Default is On.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonAction ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonActionMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonActionMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonAutoModifier ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonAutoModifierMaxValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetRightButtonAutoModifierMinValue ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual vtkProperty Kitware.VTK.vtkImagePlaneWidget.GetSelectedPlaneProperty ( )

virtual

Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.

Here is the call graph for this function:

int Kitware.VTK.vtkImagePlaneWidget.GetSliceIndex

(

)

Get the slice position in terms of the data extent.

double Kitware.VTK.vtkImagePlaneWidget.GetSlicePosition

(

)

Get the position of the slice along its normal.

vtkTextProperty Kitware.VTK.vtkImagePlaneWidget.GetTextProperty

(

)

Set/Get the text property for the image data and window-level annotation.

Here is the call graph for this function:

vtkTexture Kitware.VTK.vtkImagePlaneWidget.GetTexture

(

)

Convenience method to get the texture used by this widget. This can be used in external slice viewers.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImagePlaneWidget.GetTextureInterpolate ( )

virtual

Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.

virtual vtkProperty Kitware.VTK.vtkImagePlaneWidget.GetTexturePlaneProperty ( )

virtual

Set/Get the property for the resliced image.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImagePlaneWidget.GetTextureVisibility ( )

virtual

Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetUseContinuousCursor ( )

virtual

Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.

virtual int Kitware.VTK.vtkImagePlaneWidget.GetUserControlledLookupTable ( )

virtual

Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.

void Kitware.VTK.vtkImagePlaneWidget.GetVector1

(

IntPtr

v1

)

Get the vector from the plane origin to point1.

void Kitware.VTK.vtkImagePlaneWidget.GetVector2

(

IntPtr

v2

)

Get the vector from the plane origin to point2.

double Kitware.VTK.vtkImagePlaneWidget.GetWindow

(

)

Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.

void Kitware.VTK.vtkImagePlaneWidget.GetWindowLevel

(

IntPtr

wl

)

Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.

virtual void Kitware.VTK.vtkImagePlaneWidget.InteractionOff ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.InteractionOn ( )

virtual

Enable/disable mouse interaction so the widget remains on display.

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

virtual

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

new vtkImagePlaneWidget Kitware.VTK.vtkImagePlaneWidget.NewInstance

(

)

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

override void Kitware.VTK.vtkImagePlaneWidget.PlaceWidget ( )

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

virtual void Kitware.VTK.vtkImagePlaneWidget.RestrictPlaneToVolumeOff ( )

virtual

Make sure that the plane remains within the volume. Default is On.

virtual void Kitware.VTK.vtkImagePlaneWidget.RestrictPlaneToVolumeOn ( )

virtual

Make sure that the plane remains within the volume. Default is On.

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

static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkImagePlaneWidget.SetColorMap ( vtkImageMapToColors  arg0 )

virtual

Convenience method to get the vtkImageMapToColors filter used by this widget. The user can properly render other transparent actors in a scene by calling the filter's SetOutputFormatToRGB and PassAlphaToOutputOff.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetCursorProperty ( vtkProperty  arg0 )

virtual

Set the properties of the cross-hair cursor.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetDisplayText ( int  _arg )

virtual

Enable/disable text display of window-level, image coordinates and scalar values in a render window.

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

virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

override void Kitware.VTK.vtkImagePlaneWidget.SetInput ( vtkDataSet  input )

virtual

Set the vtkImageData* input for the vtkImageReslice.

Reimplemented from Kitware.VTK.vtk3DWidget.

void Kitware.VTK.vtkImagePlaneWidget.SetInteraction

(

int

interact

)

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetLeftButtonAction ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetLeftButtonAutoModifier ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetLookupTable ( vtkLookupTable  arg0 )

virtual

Set/Get the internal lookuptable (lut) to one defined by the user, or, alternatively, to the lut of another vtkImgePlaneWidget. In this way, a set of three orthogonal planes can share the same lut so that window-levelling is performed uniformly among planes. The default internal lut can be re- set/allocated by setting to 0 (NULL).

virtual void Kitware.VTK.vtkImagePlaneWidget.SetMarginProperty ( vtkProperty  arg0 )

virtual

Set the properties of the margins.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetMarginSizeX ( double  _arg )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetMarginSizeY ( double  _arg )

virtual

Set the size of the margins based on a percentage of the plane's width and height, limited between 0 and 50%.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetMiddleButtonAction ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetMiddleButtonAutoModifier ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

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

Set/Get the origin of the plane.

void Kitware.VTK.vtkImagePlaneWidget.SetOrigin

(

IntPtr

xyz

)

Set/Get the origin of the plane.

void Kitware.VTK.vtkImagePlaneWidget.SetPicker

(

vtkAbstractPropPicker

arg0

)

Set the internal picker to one defined by the user. In this way, a set of three orthogonal planes can share the same picker so that picking is performed correctly. The default internal picker can be re-set/allocated by setting to 0 (NULL).

void Kitware.VTK.vtkImagePlaneWidget.SetPlaneOrientation

(

int

arg0

)

Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).

void Kitware.VTK.vtkImagePlaneWidget.SetPlaneOrientationToXAxes

(

)

Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).

void Kitware.VTK.vtkImagePlaneWidget.SetPlaneOrientationToYAxes

(

)

Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).

void Kitware.VTK.vtkImagePlaneWidget.SetPlaneOrientationToZAxes

(

)

Convenience method sets the plane orientation normal to the x, y, or z axes. Default is XAxes (0).

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

virtual

Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.

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

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

void Kitware.VTK.vtkImagePlaneWidget.SetPoint1

(

IntPtr

xyz

)

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

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

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

void Kitware.VTK.vtkImagePlaneWidget.SetPoint2

(

IntPtr

xyz

)

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

void Kitware.VTK.vtkImagePlaneWidget.SetResliceInterpolate

(

int

arg0

)

Set the interpolation to use when texturing the plane.

void Kitware.VTK.vtkImagePlaneWidget.SetResliceInterpolateToCubic

(

)

Set the interpolation to use when texturing the plane.

void Kitware.VTK.vtkImagePlaneWidget.SetResliceInterpolateToLinear

(

)

Set the interpolation to use when texturing the plane.

void Kitware.VTK.vtkImagePlaneWidget.SetResliceInterpolateToNearestNeighbour

(

)

Set the interpolation to use when texturing the plane.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetRestrictPlaneToVolume ( int  _arg )

virtual

Make sure that the plane remains within the volume. Default is On.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetRightButtonAction ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetRightButtonAutoModifier ( int  _arg )

virtual

Enable/disable mouse interaction so the widget remains on display.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetSelectedPlaneProperty ( vtkProperty  arg0 )

virtual

Set/Get the plane's outline properties. The properties of the plane's outline when selected and unselected can be manipulated.

void Kitware.VTK.vtkImagePlaneWidget.SetSliceIndex

(

int

index

)

Set the slice position in terms of the data extent.

void Kitware.VTK.vtkImagePlaneWidget.SetSlicePosition

(

double

position

)

Set the position of the slice along its normal.

void Kitware.VTK.vtkImagePlaneWidget.SetTextProperty

(

vtkTextProperty

tprop

)

Set/Get the text property for the image data and window-level annotation.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetTextureInterpolate ( int  _arg )

virtual

Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetTexturePlaneProperty ( vtkProperty  arg0 )

virtual

Set/Get the property for the resliced image.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetTextureVisibility ( int  arg0 )

virtual

Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetUseContinuousCursor ( int  _arg )

virtual

Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.

virtual void Kitware.VTK.vtkImagePlaneWidget.SetUserControlledLookupTable ( int  _arg )

virtual

Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.

void Kitware.VTK.vtkImagePlaneWidget.SetWindowLevel	(	double	window,
		double	level,
		int	copy
	)

Set/Get the current window and level values. SetWindowLevel should only be called after SetInput. If a shared lookup table is being used, a callback is required to update the window level values without having to update the lookup table again.

virtual void Kitware.VTK.vtkImagePlaneWidget.TextureInterpolateOff ( )

virtual

Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.

virtual void Kitware.VTK.vtkImagePlaneWidget.TextureInterpolateOn ( )

virtual

Specify whether to interpolate the texture or not. When off, the reslice interpolation is nearest neighbour regardless of how the interpolation is set through the API. Set before setting the vtkImageData input. Default is On.

virtual void Kitware.VTK.vtkImagePlaneWidget.TextureVisibilityOff ( )

virtual

Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.

virtual void Kitware.VTK.vtkImagePlaneWidget.TextureVisibilityOn ( )

virtual

Control the visibility of the actual texture mapped reformatted plane. in some cases you may only want the plane outline for example.

override void Kitware.VTK.vtkImagePlaneWidget.UpdatePlacement ( )

virtual

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

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

virtual void Kitware.VTK.vtkImagePlaneWidget.UseContinuousCursorOff ( )

virtual

Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.

virtual void Kitware.VTK.vtkImagePlaneWidget.UseContinuousCursorOn ( )

virtual

Choose between voxel centered or continuous cursor probing. With voxel centered probing, the cursor snaps to the nearest voxel and the reported cursor coordinates are extent based. With continuous probing, voxel data is interpolated using vtkDataSetAttributes' InterpolatePoint method and the reported coordinates are 3D spatial continuous.

virtual void Kitware.VTK.vtkImagePlaneWidget.UserControlledLookupTableOff ( )

virtual

Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.

virtual void Kitware.VTK.vtkImagePlaneWidget.UserControlledLookupTableOn ( )

virtual

Let the user control the lookup table. NOTE: apply this method BEFORE applying the SetLookupTable method. Default is Off.

---

Member Data Documentation

new readonly string Kitware.VTK.vtkImagePlaneWidget.MRClassNameKey = "19vtkImagePlaneWidget"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

---

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

• csharp/vtkImagePlaneWidget.cs