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.vtkPointWidget Class Reference

vtkPointWidget - position a point in 3D space More...

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

List of all members.

Public Member Functions

 vtkPointWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPointWidget ()
 Instantiate this widget.
void AllOff ()
 Convenience methods to turn outline and shadows on and off.
void AllOn ()
 Convenience methods to turn outline and shadows on and off.
virtual double GetHotSpotSize ()
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.
virtual double GetHotSpotSizeMaxValue ()
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.
virtual double GetHotSpotSizeMinValue ()
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.
int GetOutline ()
 Turn on/off the wireframe bounding box.
void GetPolyData (vtkPolyData pd)
 Grab the polydata (including points) that defines the point. A single point and a vertex compose the vtkPolyData.
double[] GetPosition ()
 Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.
void GetPosition (IntPtr xyz)
 Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.
virtual vtkProperty GetProperty ()
 Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be set.
virtual vtkProperty GetSelectedProperty ()
 Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be set.
int GetTranslationMode ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.
int GetXShadows ()
 Turn on/off the wireframe x-shadows.
int GetYShadows ()
 Turn on/off the wireframe y-shadows.
int GetZShadows ()
 Turn on/off the wireframe z-shadows.
override int IsA (string type)
 Instantiate this widget.
new vtkPointWidget NewInstance ()
 Instantiate this widget.
void OutlineOff ()
 Turn on/off the wireframe bounding box.
void OutlineOn ()
 Turn on/off the wireframe bounding box.
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.
override void SetEnabled (int arg0)
 Methods that satisfy the superclass' API.
virtual void SetHotSpotSize (double _arg)
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.
void SetOutline (int o)
 Turn on/off the wireframe bounding box.
void SetPosition (double x, double y, double z)
 Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.
void SetPosition (IntPtr x)
 Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.
void SetTranslationMode (int mode)
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.
void SetXShadows (int o)
 Turn on/off the wireframe x-shadows.
void SetYShadows (int o)
 Turn on/off the wireframe y-shadows.
void SetZShadows (int o)
 Turn on/off the wireframe z-shadows.
void TranslationModeOff ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.
void TranslationModeOn ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.
void XShadowsOff ()
 Turn on/off the wireframe x-shadows.
void XShadowsOn ()
 Turn on/off the wireframe x-shadows.
void YShadowsOff ()
 Turn on/off the wireframe y-shadows.
void YShadowsOn ()
 Turn on/off the wireframe y-shadows.
void ZShadowsOff ()
 Turn on/off the wireframe z-shadows.
void ZShadowsOn ()
 Turn on/off the wireframe z-shadows.

Static Public Member Functions

static new vtkPointWidget New ()
 Instantiate this widget.
static new int IsTypeOf (string type)
 Instantiate this widget.
static new vtkPointWidget SafeDownCast (vtkObjectBase o)
 Instantiate this widget.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkPointWidget"
 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 vtkPointWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPointWidget_AllOff_01 (HandleRef pThis)
static internal void vtkPointWidget_AllOn_02 (HandleRef pThis)
static internal double vtkPointWidget_GetHotSpotSize_03 (HandleRef pThis)
static internal double vtkPointWidget_GetHotSpotSizeMaxValue_04 (HandleRef pThis)
static internal double vtkPointWidget_GetHotSpotSizeMinValue_05 (HandleRef pThis)
static internal int vtkPointWidget_GetOutline_06 (HandleRef pThis)
static internal void vtkPointWidget_GetPolyData_07 (HandleRef pThis, HandleRef pd)
static internal IntPtr vtkPointWidget_GetPosition_08 (HandleRef pThis)
static internal void vtkPointWidget_GetPosition_09 (HandleRef pThis, IntPtr xyz)
static internal IntPtr vtkPointWidget_GetProperty_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPointWidget_GetSelectedProperty_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPointWidget_GetTranslationMode_12 (HandleRef pThis)
static internal int vtkPointWidget_GetXShadows_13 (HandleRef pThis)
static internal int vtkPointWidget_GetYShadows_14 (HandleRef pThis)
static internal int vtkPointWidget_GetZShadows_15 (HandleRef pThis)
static internal int vtkPointWidget_IsA_16 (HandleRef pThis, string type)
static internal int vtkPointWidget_IsTypeOf_17 (string type)
static internal IntPtr vtkPointWidget_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPointWidget_OutlineOff_20 (HandleRef pThis)
static internal void vtkPointWidget_OutlineOn_21 (HandleRef pThis)
static internal void vtkPointWidget_PlaceWidget_22 (HandleRef pThis, IntPtr bounds)
static internal void vtkPointWidget_PlaceWidget_23 (HandleRef pThis)
static internal void vtkPointWidget_PlaceWidget_24 (HandleRef pThis, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
static internal IntPtr vtkPointWidget_SafeDownCast_25 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPointWidget_SetEnabled_26 (HandleRef pThis, int arg0)
static internal void vtkPointWidget_SetHotSpotSize_27 (HandleRef pThis, double _arg)
static internal void vtkPointWidget_SetOutline_28 (HandleRef pThis, int o)
static internal void vtkPointWidget_SetPosition_29 (HandleRef pThis, double x, double y, double z)
static internal void vtkPointWidget_SetPosition_30 (HandleRef pThis, IntPtr x)
static internal void vtkPointWidget_SetTranslationMode_31 (HandleRef pThis, int mode)
static internal void vtkPointWidget_SetXShadows_32 (HandleRef pThis, int o)
static internal void vtkPointWidget_SetYShadows_33 (HandleRef pThis, int o)
static internal void vtkPointWidget_SetZShadows_34 (HandleRef pThis, int o)
static internal void vtkPointWidget_TranslationModeOff_35 (HandleRef pThis)
static internal void vtkPointWidget_TranslationModeOn_36 (HandleRef pThis)
static internal void vtkPointWidget_XShadowsOff_37 (HandleRef pThis)
static internal void vtkPointWidget_XShadowsOn_38 (HandleRef pThis)
static internal void vtkPointWidget_YShadowsOff_39 (HandleRef pThis)
static internal void vtkPointWidget_YShadowsOn_40 (HandleRef pThis)
static internal void vtkPointWidget_ZShadowsOff_41 (HandleRef pThis)
static internal void vtkPointWidget_ZShadowsOn_42 (HandleRef pThis)

Static Private Member Functions

static vtkPointWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPointWidget - position a point in 3D space

Description This 3D widget allows the user to position a point in 3D space using a 3D cursor. The cursor has an outline bounding box, axes-aligned cross-hairs, and axes shadows. (The outline and shadows can be turned off.) Any of these can be turned off. A nice feature of the object is that the vtkPointWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPointWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPointWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. The interactor will act normally until the "i" key (for "interactor") is pressed, at which point the vtkPointWidget will appear. (See superclass documentation for information about changing this behavior.) To move the point, the user can grab (left mouse) on any widget line and "slide" the point into position. Scaling is achieved by using the right mouse button "up" the render window (makes the widget bigger) or "down" the render window (makes the widget smaller). To translate the widget use the middle mouse button. (Note: all of the translation interactions can be constrained to one of the x-y-z axes by using the "shift" key.) The vtkPointWidget produces as output a polydata with a single point and a vertex cell.

Some additional features of this class include the ability to control the rendered properties of the widget. You can set the properties of the selected and unselected representations of the parts of the widget. For example, you can set the property of the 3D cursor in its normal and selected states.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate this widget.


Member Function Documentation

Convenience methods to turn outline and shadows on and off.

Convenience methods to turn outline and shadows on and off.

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

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

Reimplemented from Kitware.VTK.vtk3DWidget.

virtual double Kitware.VTK.vtkPointWidget.GetHotSpotSize ( ) [virtual]

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

Turn on/off the wireframe bounding box.

Grab the polydata (including points) that defines the point. A single point and a vertex compose the vtkPolyData.

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

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

Here is the call graph for this function:

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

Here is the call graph for this function:

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Turn on/off the wireframe x-shadows.

Turn on/off the wireframe y-shadows.

Turn on/off the wireframe z-shadows.

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

Instantiate this widget.

Reimplemented from Kitware.VTK.vtk3DWidget.

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

Instantiate this widget.

Reimplemented from Kitware.VTK.vtk3DWidget.

Instantiate this widget.

Reimplemented from Kitware.VTK.vtkObject.

Instantiate this widget.

Reimplemented from Kitware.VTK.vtk3DWidget.

Turn on/off the wireframe bounding box.

Turn on/off the wireframe bounding box.

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

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

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

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

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

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtk3DWidget.

Instantiate this widget.

Reimplemented from Kitware.VTK.vtk3DWidget.

Here is the call graph for this function:

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

Methods that satisfy the superclass' API.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

virtual void Kitware.VTK.vtkPointWidget.SetHotSpotSize ( double  _arg) [virtual]

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

Turn on/off the wireframe bounding box.

void Kitware.VTK.vtkPointWidget.SetPosition ( double  x,
double  y,
double  z 
)

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

Set/Get the position of the point. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box.

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

Turn on/off the wireframe x-shadows.

Turn on/off the wireframe y-shadows.

Turn on/off the wireframe z-shadows.

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves.

static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_AllOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_AllOn_02 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointWidget.vtkPointWidget_GetHotSpotSize_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointWidget.vtkPointWidget_GetHotSpotSizeMaxValue_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkPointWidget.vtkPointWidget_GetHotSpotSizeMinValue_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_GetOutline_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_GetPolyData_07 ( HandleRef  pThis,
HandleRef  pd 
) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_GetPosition_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_GetPosition_09 ( HandleRef  pThis,
IntPtr  xyz 
) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_GetProperty_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_GetSelectedProperty_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_GetTranslationMode_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_GetXShadows_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_GetYShadows_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_GetZShadows_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPointWidget.vtkPointWidget_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_OutlineOff_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_OutlineOn_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_PlaceWidget_22 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_PlaceWidget_23 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_PlaceWidget_24 ( HandleRef  pThis,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [private]
static internal IntPtr Kitware.VTK.vtkPointWidget.vtkPointWidget_SafeDownCast_25 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetEnabled_26 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetHotSpotSize_27 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetOutline_28 ( HandleRef  pThis,
int  o 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetPosition_29 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetPosition_30 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetTranslationMode_31 ( HandleRef  pThis,
int  mode 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetXShadows_32 ( HandleRef  pThis,
int  o 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetYShadows_33 ( HandleRef  pThis,
int  o 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_SetZShadows_34 ( HandleRef  pThis,
int  o 
) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_TranslationModeOff_35 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_TranslationModeOn_36 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_XShadowsOff_37 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_XShadowsOn_38 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_YShadowsOff_39 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_YShadowsOn_40 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_ZShadowsOff_41 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPointWidget.vtkPointWidget_ZShadowsOn_42 ( HandleRef  pThis) [private]

Turn on/off the wireframe x-shadows.

Turn on/off the wireframe x-shadows.

Turn on/off the wireframe y-shadows.

Turn on/off the wireframe y-shadows.

Turn on/off the wireframe z-shadows.

Turn on/off the wireframe z-shadows.


Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtk3DWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtk3DWidget.


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