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

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

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

List of all members.

Public Member Functions

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

Static Public Member Functions

static new vtkPlaneWidget New ()
 Instantiate the object.
static new int IsTypeOf (string type)
 Instantiate the object.
static new vtkPlaneWidget SafeDownCast (vtkObjectBase o)
 Instantiate the object.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkPlaneWidget"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkPlaneWidget"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkPlaneWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPlaneWidget_GetCenter_01 (HandleRef pThis)
static internal void vtkPlaneWidget_GetCenter_02 (HandleRef pThis, IntPtr xyz)
static internal IntPtr vtkPlaneWidget_GetHandleProperty_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPlaneWidget_GetNormal_04 (HandleRef pThis)
static internal void vtkPlaneWidget_GetNormal_05 (HandleRef pThis, IntPtr xyz)
static internal int vtkPlaneWidget_GetNormalToXAxis_06 (HandleRef pThis)
static internal int vtkPlaneWidget_GetNormalToYAxis_07 (HandleRef pThis)
static internal int vtkPlaneWidget_GetNormalToZAxis_08 (HandleRef pThis)
static internal IntPtr vtkPlaneWidget_GetOrigin_09 (HandleRef pThis)
static internal void vtkPlaneWidget_GetOrigin_10 (HandleRef pThis, IntPtr xyz)
static internal void vtkPlaneWidget_GetPlane_11 (HandleRef pThis, HandleRef plane)
static internal IntPtr vtkPlaneWidget_GetPlaneProperty_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPlaneWidget_GetPoint1_13 (HandleRef pThis)
static internal void vtkPlaneWidget_GetPoint1_14 (HandleRef pThis, IntPtr xyz)
static internal IntPtr vtkPlaneWidget_GetPoint2_15 (HandleRef pThis)
static internal void vtkPlaneWidget_GetPoint2_16 (HandleRef pThis, IntPtr xyz)
static internal void vtkPlaneWidget_GetPolyData_17 (HandleRef pThis, HandleRef pd)
static internal IntPtr vtkPlaneWidget_GetPolyDataAlgorithm_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPlaneWidget_GetRepresentation_19 (HandleRef pThis)
static internal int vtkPlaneWidget_GetRepresentationMaxValue_20 (HandleRef pThis)
static internal int vtkPlaneWidget_GetRepresentationMinValue_21 (HandleRef pThis)
static internal int vtkPlaneWidget_GetResolution_22 (HandleRef pThis)
static internal IntPtr vtkPlaneWidget_GetSelectedHandleProperty_23 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPlaneWidget_GetSelectedPlaneProperty_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPlaneWidget_IsA_25 (HandleRef pThis, string type)
static internal int vtkPlaneWidget_IsTypeOf_26 (string type)
static internal IntPtr vtkPlaneWidget_NewInstance_28 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlaneWidget_NormalToXAxisOff_29 (HandleRef pThis)
static internal void vtkPlaneWidget_NormalToXAxisOn_30 (HandleRef pThis)
static internal void vtkPlaneWidget_NormalToYAxisOff_31 (HandleRef pThis)
static internal void vtkPlaneWidget_NormalToYAxisOn_32 (HandleRef pThis)
static internal void vtkPlaneWidget_NormalToZAxisOff_33 (HandleRef pThis)
static internal void vtkPlaneWidget_NormalToZAxisOn_34 (HandleRef pThis)
static internal void vtkPlaneWidget_PlaceWidget_35 (HandleRef pThis, IntPtr bounds)
static internal void vtkPlaneWidget_PlaceWidget_36 (HandleRef pThis)
static internal void vtkPlaneWidget_PlaceWidget_37 (HandleRef pThis, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
static internal IntPtr vtkPlaneWidget_SafeDownCast_38 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlaneWidget_SetCenter_39 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlaneWidget_SetCenter_40 (HandleRef pThis, IntPtr x)
static internal void vtkPlaneWidget_SetEnabled_41 (HandleRef pThis, int arg0)
static internal void vtkPlaneWidget_SetNormal_42 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlaneWidget_SetNormal_43 (HandleRef pThis, IntPtr x)
static internal void vtkPlaneWidget_SetNormalToXAxis_44 (HandleRef pThis, int _arg)
static internal void vtkPlaneWidget_SetNormalToYAxis_45 (HandleRef pThis, int _arg)
static internal void vtkPlaneWidget_SetNormalToZAxis_46 (HandleRef pThis, int _arg)
static internal void vtkPlaneWidget_SetOrigin_47 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlaneWidget_SetOrigin_48 (HandleRef pThis, IntPtr x)
static internal void vtkPlaneWidget_SetPlaneProperty_49 (HandleRef pThis, HandleRef arg0)
static internal void vtkPlaneWidget_SetPoint1_50 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlaneWidget_SetPoint1_51 (HandleRef pThis, IntPtr x)
static internal void vtkPlaneWidget_SetPoint2_52 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlaneWidget_SetPoint2_53 (HandleRef pThis, IntPtr x)
static internal void vtkPlaneWidget_SetRepresentation_54 (HandleRef pThis, int _arg)
static internal void vtkPlaneWidget_SetRepresentationToOff_55 (HandleRef pThis)
static internal void vtkPlaneWidget_SetRepresentationToOutline_56 (HandleRef pThis)
static internal void vtkPlaneWidget_SetRepresentationToSurface_57 (HandleRef pThis)
static internal void vtkPlaneWidget_SetRepresentationToWireframe_58 (HandleRef pThis)
static internal void vtkPlaneWidget_SetResolution_59 (HandleRef pThis, int r)
static internal void vtkPlaneWidget_UpdatePlacement_60 (HandleRef pThis)

Static Private Member Functions

static vtkPlaneWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPlaneWidget - 3D widget for manipulating a finite plane

Description This 3D widget defines a finite (bounded) plane that can be interactively placed in a scene. The plane has four handles (at its corner vertices), a normal vector, and the plane itself. The handles are used to resize the plane; the normal vector to rotate it, and the plane can be picked and translated. Selecting the plane while pressing CTRL makes it spin around the normal. A nice feature of the object is that the vtkPlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPlaneWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. If the "i" key (for "interactor") is pressed, the vtkPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the one of the four handles (use the left mouse button), the plane can be resized. By grabbing the plane itself, the entire plane can be arbitrarily translated. Pressing CTRL while grabbing the plane will spin the plane around the normal. If you select the normal vector, the plane can be arbitrarily rotated. Selecting any part of the widget with the middle mouse button enables translation of the plane along its normal. (Once selected using middle mouse, moving the mouse in the direction of the normal translates the plane in the direction of the normal; moving in the direction opposite the normal translates the plane in the direction opposite the normal.) Scaling (about the center of the plane) is achieved by using the right mouse button. By moving the mouse "up" the render window the plane will be made bigger; by moving "down" the render window the widget will be made smaller. Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method).

The vtkPlaneWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the plane; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding stream lines. GetPlane() can be used to update a vtkPlane implicit function. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button).

Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the plane. For example, you can set the property for the handles and plane. In addition there are methods to constrain the plane so that it is perpendicular to the x-y-z axes.


Constructor & Destructor Documentation

static Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Instantiate the object.


Member Function Documentation

override void Kitware.VTK.vtkPlaneWidget.Dispose ( bool  disposing) [protected]

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

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Get the center of the plane.

Get the center of the plane.

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

Here is the call graph for this function:

Get the normal to the plane.

Get the normal to the plane.

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

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

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

Set/Get the origin of the plane.

Set/Get the origin of the plane.

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

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

Here is the call graph for this function:

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

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

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

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

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

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

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

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

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

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

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

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

Here is the call graph for this function:

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

Here is the call graph for this function:

override int Kitware.VTK.vtkPlaneWidget.IsA ( string  type) [virtual]

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

virtual void Kitware.VTK.vtkPlaneWidget.NormalToXAxisOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkPlaneWidget.NormalToXAxisOn ( ) [virtual]

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

virtual void Kitware.VTK.vtkPlaneWidget.NormalToYAxisOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkPlaneWidget.NormalToYAxisOn ( ) [virtual]

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

virtual void Kitware.VTK.vtkPlaneWidget.NormalToZAxisOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkPlaneWidget.NormalToZAxisOn ( ) [virtual]

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

override void Kitware.VTK.vtkPlaneWidget.PlaceWidget ( IntPtr  bounds) [virtual]

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

override void Kitware.VTK.vtkPlaneWidget.PlaceWidget ( ) [virtual]

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Instantiate the object.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

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

Get the center of the plane.

Get the center of the plane.

override void Kitware.VTK.vtkPlaneWidget.SetEnabled ( int  arg0) [virtual]

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

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

Get the normal to the plane.

Get the normal to the plane.

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

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

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

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

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

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

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

Set/Get the origin of the plane.

Set/Get the origin of the plane.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

override void Kitware.VTK.vtkPlaneWidget.UpdatePlacement ( ) [virtual]

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

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetCenter_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetCenter_02 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetHandleProperty_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetNormal_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetNormal_05 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetNormalToXAxis_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetNormalToYAxis_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetNormalToZAxis_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetOrigin_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetOrigin_10 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPlane_11 ( HandleRef  pThis,
HandleRef  plane 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPlaneProperty_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPoint1_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPoint1_14 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPoint2_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPoint2_16 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPolyData_17 ( HandleRef  pThis,
HandleRef  pd 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetPolyDataAlgorithm_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetRepresentation_19 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetRepresentationMaxValue_20 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetRepresentationMinValue_21 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetResolution_22 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetSelectedHandleProperty_23 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_GetSelectedPlaneProperty_24 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_IsA_25 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_IsTypeOf_26 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NewInstance_28 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToXAxisOff_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToXAxisOn_30 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToYAxisOff_31 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToYAxisOn_32 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToZAxisOff_33 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_NormalToZAxisOn_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_PlaceWidget_35 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_PlaceWidget_36 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_PlaceWidget_37 ( HandleRef  pThis,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [private]
static internal IntPtr Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SafeDownCast_38 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetCenter_39 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetCenter_40 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetEnabled_41 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetNormal_42 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetNormal_43 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetNormalToXAxis_44 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetNormalToYAxis_45 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetNormalToZAxis_46 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetOrigin_47 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetOrigin_48 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetPlaneProperty_49 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetPoint1_50 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetPoint1_51 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetPoint2_52 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetPoint2_53 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetRepresentation_54 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetRepresentationToOff_55 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetRepresentationToOutline_56 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetRepresentationToSurface_57 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetRepresentationToWireframe_58 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_SetResolution_59 ( HandleRef  pThis,
int  r 
) [private]
static internal void Kitware.VTK.vtkPlaneWidget.vtkPlaneWidget_UpdatePlacement_60 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPlaneWidget.MRClassNameKey = "14vtkPlaneWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataSourceWidget.


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