ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkImplicitPlaneWidget Class Reference

vtkImplicitPlaneWidget - 3D widget for manipulating an infinite plane More...

Inheritance diagram for Kitware.VTK.vtkImplicitPlaneWidget:
[legend]
Collaboration diagram for Kitware.VTK.vtkImplicitPlaneWidget:
[legend]

List of all members.

Public Member Functions

 vtkImplicitPlaneWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImplicitPlaneWidget ()
 Instantiate the object.
virtual void DrawPlaneOff ()
 Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)
virtual void DrawPlaneOn ()
 Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)
virtual double GetDiagonalRatio ()
 By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].
virtual double GetDiagonalRatioMaxValue ()
 By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].
virtual double GetDiagonalRatioMinValue ()
 By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].
virtual int GetDrawPlane ()
 Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)
virtual vtkProperty GetEdgesProperty ()
 Get the property of the intersection edges. (This property also applies to the edges when tubed.)
double[] GetNormal ()
 Get the normal to the plane.
void GetNormal (IntPtr xyz)
 Get the normal to the plane.
virtual vtkProperty GetNormalProperty ()
 Get the properties on the normal (line and cone).
virtual int GetNormalToXAxis ()
 Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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 ()
 Get the origin of the plane.
void GetOrigin (IntPtr xyz)
 Get the origin of the plane.
virtual int GetOriginTranslation ()
 Turn on/off the ability to translate the origin (sphere) with the left mouse button.
virtual vtkProperty GetOutlineProperty ()
 Get the property of the outline.
virtual int GetOutlineTranslation ()
 Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.
virtual int GetOutsideBounds ()
 Turn on/off the ability to move the widget outside of the input's bound.
void GetPlane (vtkPlane plane)
 Get the implicit function for the plane. 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.
void GetPolyData (vtkPolyData pd)
 Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box.
override vtkPolyDataAlgorithm GetPolyDataAlgorithm ()
 Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane).
virtual int GetScaleEnabled ()
 Turn on/off the ability to scale with the mouse.
virtual vtkProperty GetSelectedNormalProperty ()
 Get the properties on the normal (line and cone).
virtual vtkProperty GetSelectedOutlineProperty ()
 Get the property of the outline.
virtual vtkProperty GetSelectedPlaneProperty ()
 Get the plane properties. The properties of the plane when selected and unselected can be manipulated.
virtual int GetTubing ()
 Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.
override int IsA (string type)
 Instantiate the object.
new vtkImplicitPlaneWidget NewInstance ()
 Instantiate the object.
virtual void NormalToXAxisOff ()
 Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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. If one axis is set on, the other two will be set off. 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 OriginTranslationOff ()
 Turn on/off the ability to translate the origin (sphere) with the left mouse button.
virtual void OriginTranslationOn ()
 Turn on/off the ability to translate the origin (sphere) with the left mouse button.
virtual void OutlineTranslationOff ()
 Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.
virtual void OutlineTranslationOn ()
 Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.
virtual void OutsideBoundsOff ()
 Turn on/off the ability to move the widget outside of the input's bound.
virtual void OutsideBoundsOn ()
 Turn on/off the ability to move the widget outside of the input's bound.
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 ScaleEnabledOff ()
 Turn on/off the ability to scale with the mouse.
virtual void ScaleEnabledOn ()
 Turn on/off the ability to scale with the mouse.
virtual void SetDiagonalRatio (double _arg)
 By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].
void SetDrawPlane (int plane)
 Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)
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.
void SetNormalToXAxis (int arg0)
 Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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 SetNormalToYAxis (int arg0)
 Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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 SetNormalToZAxis (int arg0)
 Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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 SetOrigin (double x, double y, double z)
 Get the origin of the plane.
virtual void SetOrigin (IntPtr x)
 Get the origin of the plane.
virtual void SetOriginTranslation (int _arg)
 Turn on/off the ability to translate the origin (sphere) with the left mouse button.
virtual void SetOutlineTranslation (int _arg)
 Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.
virtual void SetOutsideBounds (int _arg)
 Turn on/off the ability to move the widget outside of the input's bound.
virtual void SetScaleEnabled (int _arg)
 Turn on/off the ability to scale with the mouse.
virtual void SetTubing (int _arg)
 Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.
virtual void SizeHandles ()
 Control widget appearance.
virtual void TubingOff ()
 Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.
virtual void TubingOn ()
 Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.
override void UpdatePlacement ()
 Satisfies the 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 vtkImplicitPlaneWidget New ()
 Instantiate the object.
static new int IsTypeOf (string type)
 Instantiate the object.
static new vtkImplicitPlaneWidget SafeDownCast (vtkObjectBase o)
 Instantiate the object.

Public Attributes

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

Detailed Description

vtkImplicitPlaneWidget - 3D widget for manipulating an infinite plane

Description This 3D widget defines an infinite plane that can be interactively placed in a scene. The widget is represented by a plane with a normal vector; the plane is contained by a bounding box, and where the plane intersects the bounding box the edges are shown (possibly tubed). The normal can be selected and moved to rotate the plane; the plane itself can be selected and translated in various directions. As the plane is moved, the implicit plane function and polygon (representing the plane cut against the bounding box) is updated.

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 vtkImplicitPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) If you select the normal vector, the plane can be arbitrarily rotated. The plane can be translated along the normal by selecting the plane and moving it. The plane (the plane origin) can also be arbitrary moved by selecting the plane with the middle mouse button. The right mouse button can be used to uniformly scale the bounding box (moving "up" the box scales larger; moving "down" the box scales 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 vtkImplicitPlaneWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get a polygonal representation (the single polygon clipped by the bounding box). 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). (Note: there is also a PlaceWidgetEvent that is invoked when the widget is placed with PlaceWidget().)

Some additional features of this class include the ability to control the properties of the widget. You do this by setting property values on the normal vector (selected and unselected properties); the plane (selected and unselected properties); the outline (selected and unselected properties); and the edges. The edges may also be tubed or not.


Constructor & Destructor Documentation

static Kitware.VTK.vtkImplicitPlaneWidget.vtkImplicitPlaneWidget ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkImplicitPlaneWidget.vtkImplicitPlaneWidget ( )

Instantiate the object.


Member Function Documentation

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

virtual void Kitware.VTK.vtkImplicitPlaneWidget.DrawPlaneOff ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void Kitware.VTK.vtkImplicitPlaneWidget.DrawPlaneOn ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual double Kitware.VTK.vtkImplicitPlaneWidget.GetDiagonalRatio ( )
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].

virtual double Kitware.VTK.vtkImplicitPlaneWidget.GetDiagonalRatioMaxValue ( )
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].

virtual double Kitware.VTK.vtkImplicitPlaneWidget.GetDiagonalRatioMinValue ( )
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetDrawPlane ( )
virtual

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.GetEdgesProperty ( )
virtual

Get the property of the intersection edges. (This property also applies to the edges when tubed.)

Here is the call graph for this function:

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

Get the normal to the plane.

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

Get the normal to the plane.

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.GetNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetNormalToXAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.GetNormalToYAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.GetNormalToZAxis ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.GetOrigin ( )

Get the origin of the plane.

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

Get the origin of the plane.

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetOriginTranslation ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.GetOutlineProperty ( )
virtual

Get the property of the outline.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetOutlineTranslation ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetOutsideBounds ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound.

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

Get the implicit function for the plane. 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.vtkImplicitPlaneWidget.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:

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

Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box.

override vtkPolyDataAlgorithm Kitware.VTK.vtkImplicitPlaneWidget.GetPolyDataAlgorithm ( )
virtual

Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane).

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetScaleEnabled ( )
virtual

Turn on/off the ability to scale with the mouse.

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.GetSelectedNormalProperty ( )
virtual

Get the properties on the normal (line and cone).

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.GetSelectedOutlineProperty ( )
virtual

Get the property of the outline.

Here is the call graph for this function:

virtual vtkProperty Kitware.VTK.vtkImplicitPlaneWidget.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:

virtual int Kitware.VTK.vtkImplicitPlaneWidget.GetTubing ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

override int Kitware.VTK.vtkImplicitPlaneWidget.IsA ( string  type)
virtual

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

new vtkImplicitPlaneWidget Kitware.VTK.vtkImplicitPlaneWidget.NewInstance ( )

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.NormalToXAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.NormalToXAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.NormalToYAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.NormalToYAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.NormalToZAxisOff ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.NormalToZAxisOn ( )
virtual

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.OriginTranslationOff ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.OriginTranslationOn ( )
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.OutlineTranslationOff ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.OutlineTranslationOn ( )
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.OutsideBoundsOff ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.OutsideBoundsOn ( )
virtual

Turn on/off the ability to move the widget outside of the input's bound.

override void Kitware.VTK.vtkImplicitPlaneWidget.PlaceWidget ( IntPtr  bounds)
virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

override void Kitware.VTK.vtkImplicitPlaneWidget.PlaceWidget ( )
virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

override void Kitware.VTK.vtkImplicitPlaneWidget.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 vtkImplicitPlaneWidget Kitware.VTK.vtkImplicitPlaneWidget.SafeDownCast ( vtkObjectBase  o)
static

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkImplicitPlaneWidget.ScaleEnabledOff ( )
virtual

Turn on/off the ability to scale with the mouse.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.ScaleEnabledOn ( )
virtual

Turn on/off the ability to scale with the mouse.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetDiagonalRatio ( double  _arg)
virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2].

void Kitware.VTK.vtkImplicitPlaneWidget.SetDrawPlane ( int  plane)

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

override void Kitware.VTK.vtkImplicitPlaneWidget.SetEnabled ( int  arg0)
virtual

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

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

Get the normal to the plane.

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

Get the normal to the plane.

void Kitware.VTK.vtkImplicitPlaneWidget.SetNormalToXAxis ( int  arg0)

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.SetNormalToYAxis ( int  arg0)

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.SetNormalToZAxis ( int  arg0)

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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.vtkImplicitPlaneWidget.SetOrigin ( double  x,
double  y,
double  z 
)
virtual

Get the origin of the plane.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetOrigin ( IntPtr  x)
virtual

Get the origin of the plane.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetOriginTranslation ( int  _arg)
virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetOutlineTranslation ( int  _arg)
virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetOutsideBounds ( int  _arg)
virtual

Turn on/off the ability to move the widget outside of the input's bound.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetScaleEnabled ( int  _arg)
virtual

Turn on/off the ability to scale with the mouse.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SetTubing ( int  _arg)
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.SizeHandles ( )
virtual

Control widget appearance.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.TubingOff ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void Kitware.VTK.vtkImplicitPlaneWidget.TubingOn ( )
virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

override void Kitware.VTK.vtkImplicitPlaneWidget.UpdatePlacement ( )
virtual

Satisfies the 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.


Member Data Documentation

new readonly string Kitware.VTK.vtkImplicitPlaneWidget.MRClassNameKey = "22vtkImplicitPlaneWidget"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.


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