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

vtk3DWidget - an abstract superclass for 3D widgets More...

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

List of all members.

Public Member Functions

 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.
override int IsA (string type)
 Undocumented Block.
new vtk3DWidget NewInstance ()
 Undocumented Block.
virtual void PlaceWidget (IntPtr bounds)
 This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
virtual void PlaceWidget ()
 This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
virtual void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
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.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtk3DWidget SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "11vtk3DWidget"
 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 double vtk3DWidget_GetHandleSize_01 (HandleRef pThis)
static internal double vtk3DWidget_GetHandleSizeMaxValue_02 (HandleRef pThis)
static internal double vtk3DWidget_GetHandleSizeMinValue_03 (HandleRef pThis)
static internal IntPtr vtk3DWidget_GetInput_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtk3DWidget_GetPlaceFactor_05 (HandleRef pThis)
static internal double vtk3DWidget_GetPlaceFactorMaxValue_06 (HandleRef pThis)
static internal double vtk3DWidget_GetPlaceFactorMinValue_07 (HandleRef pThis)
static internal IntPtr vtk3DWidget_GetProp3D_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtk3DWidget_IsA_09 (HandleRef pThis, string type)
static internal int vtk3DWidget_IsTypeOf_10 (string type)
static internal IntPtr vtk3DWidget_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtk3DWidget_PlaceWidget_12 (HandleRef pThis, IntPtr bounds)
static internal void vtk3DWidget_PlaceWidget_13 (HandleRef pThis)
static internal void vtk3DWidget_PlaceWidget_14 (HandleRef pThis, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
static internal IntPtr vtk3DWidget_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtk3DWidget_SetHandleSize_16 (HandleRef pThis, double _arg)
static internal void vtk3DWidget_SetInput_17 (HandleRef pThis, HandleRef arg0)
static internal void vtk3DWidget_SetPlaceFactor_18 (HandleRef pThis, double _arg)
static internal void vtk3DWidget_SetProp3D_19 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtk3DWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtk3DWidget - an abstract superclass for 3D widgets

Description vtk3DWidget is an abstract superclass for 3D interactor observers. These 3D widgets represent themselves in the scene, and have special callbacks associated with them that allows interactive manipulation of the widget. Inparticular, the difference between a vtk3DWidget and its abstract superclass vtkInteractorObserver is that vtk3DWidgets are "placed" in 3D space. vtkInteractorObservers have no notion of where they are placed, and may not exist in 3D space at all. 3D widgets also provide auxiliary functions like producing a transformation, creating polydata (for seeding streamlines, probes, etc.) or creating implicit functions. See the concrete subclasses for particulars.

Typically the widget is used by specifying a vtkProp3D or VTK dataset as input, and then invoking the "On" method to activate it. (You can also specify a bounding box to help position the widget.) Prior to invoking the On() method, the user may also wish to use the PlaceWidget() to initially position it. The 'i' (for "interactor") keypresses also can be used to turn the widgets on and off (methods exist to change the key value and enable keypress activiation).

To support interactive manipulation of objects, this class (and subclasses) invoke the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent. These events are invoked when the vtk3DWidget enters a state where rapid response is desired: mouse motion, etc. The events can be used, for example, to set the desired update frame rate (StartInteractionEvent), operate on the vtkProp3D or other object (InteractionEvent), and set the desired frame rate back to normal values (EndInteractionEvent).

Note that the Priority attribute inherited from vtkInteractorObserver has a new default value which is now 0.5 so that all 3D widgets have a higher priority than the usual interactor styles.

vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImplicitPlaneWidget


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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


Member Function Documentation

override void Kitware.VTK.vtk3DWidget.Dispose ( bool  disposing) [protected]
virtual double Kitware.VTK.vtk3DWidget.GetHandleSize ( ) [virtual]

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 Kitware.VTK.vtk3DWidget.GetHandleSizeMaxValue ( ) [virtual]

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 Kitware.VTK.vtk3DWidget.GetHandleSizeMinValue ( ) [virtual]

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.

Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.

Here is the call graph for this function:

virtual double Kitware.VTK.vtk3DWidget.GetPlaceFactor ( ) [virtual]

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 Kitware.VTK.vtk3DWidget.GetPlaceFactorMaxValue ( ) [virtual]

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 Kitware.VTK.vtk3DWidget.GetPlaceFactorMinValue ( ) [virtual]

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.

Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.

Here is the call graph for this function:

override int Kitware.VTK.vtk3DWidget.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtk3DWidget.IsTypeOf ( string  type) [static]
virtual void Kitware.VTK.vtk3DWidget.PlaceWidget ( IntPtr  bounds) [virtual]

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Reimplemented in Kitware.VTK.vtkImagePlaneWidget, Kitware.VTK.vtkImplicitPlaneWidget, Kitware.VTK.vtkImageTracerWidget, Kitware.VTK.vtkPlaneWidget, Kitware.VTK.vtkSplineWidget, Kitware.VTK.vtkBoxWidget, Kitware.VTK.vtkSphereWidget, Kitware.VTK.vtkLineWidget, Kitware.VTK.vtkPointWidget, and Kitware.VTK.vtkPolyDataSourceWidget.

virtual void Kitware.VTK.vtk3DWidget.PlaceWidget ( ) [virtual]

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Reimplemented in Kitware.VTK.vtkImagePlaneWidget, Kitware.VTK.vtkImplicitPlaneWidget, Kitware.VTK.vtkImageTracerWidget, Kitware.VTK.vtkPlaneWidget, Kitware.VTK.vtkSplineWidget, Kitware.VTK.vtkBoxWidget, Kitware.VTK.vtkSphereWidget, Kitware.VTK.vtkLineWidget, Kitware.VTK.vtkPointWidget, and Kitware.VTK.vtkPolyDataSourceWidget.

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

This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.

Reimplemented in Kitware.VTK.vtkImagePlaneWidget, Kitware.VTK.vtkImplicitPlaneWidget, Kitware.VTK.vtkImageTracerWidget, Kitware.VTK.vtkPlaneWidget, Kitware.VTK.vtkSplineWidget, Kitware.VTK.vtkBoxWidget, Kitware.VTK.vtkSphereWidget, Kitware.VTK.vtkLineWidget, Kitware.VTK.vtkPointWidget, and Kitware.VTK.vtkPolyDataSourceWidget.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Reimplemented in Kitware.VTK.vtkImagePlaneWidget, Kitware.VTK.vtkImplicitPlaneWidget, Kitware.VTK.vtkImageTracerWidget, Kitware.VTK.vtkPlaneWidget, Kitware.VTK.vtkSplineWidget, Kitware.VTK.vtkBoxWidget, Kitware.VTK.vtkSphereWidget, Kitware.VTK.vtkLineWidget, Kitware.VTK.vtkPointWidget, and Kitware.VTK.vtkPolyDataSourceWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtk3DWidget.SetHandleSize ( double  _arg) [virtual]

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 Kitware.VTK.vtk3DWidget.SetInput ( vtkDataSet  arg0) [virtual]

Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.

Reimplemented in Kitware.VTK.vtkImagePlaneWidget.

virtual void Kitware.VTK.vtk3DWidget.SetPlaceFactor ( double  _arg) [virtual]

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 Kitware.VTK.vtk3DWidget.SetProp3D ( vtkProp3D  arg0) [virtual]

Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.

static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetHandleSize_01 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetHandleSizeMaxValue_02 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetHandleSizeMinValue_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtk3DWidget.vtk3DWidget_GetInput_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetPlaceFactor_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetPlaceFactorMaxValue_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtk3DWidget.vtk3DWidget_GetPlaceFactorMinValue_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtk3DWidget.vtk3DWidget_GetProp3D_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtk3DWidget.vtk3DWidget_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtk3DWidget.vtk3DWidget_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtk3DWidget.vtk3DWidget_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_PlaceWidget_12 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_PlaceWidget_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_PlaceWidget_14 ( HandleRef  pThis,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [private]
static internal IntPtr Kitware.VTK.vtk3DWidget.vtk3DWidget_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_SetHandleSize_16 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_SetInput_17 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_SetPlaceFactor_18 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtk3DWidget.vtk3DWidget_SetProp3D_19 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtk3DWidget.MRClassNameKey = "11vtk3DWidget" [static]
new const string Kitware.VTK.vtk3DWidget.MRFullTypeName = "Kitware.VTK.vtk3DWidget"

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