ActiViz .NET
5.8.0
|
vtkBiDimensionalWidget - measure the bi-dimensional lengths of an object More...
Public Types | |
enum | EndWidgetSelectEvent_WrapperEnum { EndWidgetSelectEvent = 10050 } |
A flag indicates whether the bi-dimensional measure is valid. The widget becomes valid after two of the four points are placed. More... | |
enum | Define_WrapperEnum { Define = 1, Manipulate = 2, Start = 0 } |
Enum defining the state of the widget. By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state. More... | |
Public Member Functions | |
vtkBiDimensionalWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
Automatically generated constructor - called from generated code. DO NOT call directly. | |
vtkBiDimensionalWidget () | |
Instantiate this class. | |
override void | CreateDefaultRepresentation () |
Create the default widget representation if one is not set. | |
vtkBiDimensionalRepresentation | GetBiDimensionalRepresentation () |
Return the representation as a vtkBiDimensionalRepresentation. | |
virtual int | GetWidgetState () |
Return the current widget state. | |
override int | IsA (string type) |
Standard methods for a VTK class. | |
int | IsMeasureValid () |
A flag indicates whether the bi-dimensional measure is valid. The widget becomes valid after two of the four points are placed. | |
new vtkBiDimensionalWidget | NewInstance () |
Standard methods for a VTK class. | |
override void | SetEnabled (int arg0) |
The method for activiating and deactiviating this widget. This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method. | |
override void | SetProcessEvents (int arg0) |
Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets. | |
void | SetRepresentation (vtkBiDimensionalRepresentation r) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget. | |
virtual void | SetWidgetStateToManipulate () |
Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect. | |
virtual void | SetWidgetStateToStart () |
Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect. | |
Static Public Member Functions | |
static new vtkBiDimensionalWidget | New () |
Instantiate this class. | |
static new int | IsTypeOf (string type) |
Standard methods for a VTK class. | |
static new vtkBiDimensionalWidget | SafeDownCast (vtkObjectBase o) |
Standard methods for a VTK class. | |
Public Attributes | |
new const string | MRFullTypeName = "Kitware.VTK.vtkBiDimensionalWidget" |
Automatically generated type registration mechanics. | |
Static Public Attributes | |
static new readonly string | MRClassNameKey = "22vtkBiDimensionalWidget" |
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 | vtkBiDimensionalWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkBiDimensionalWidget_CreateDefaultRepresentation_01 (HandleRef pThis) |
static internal IntPtr | vtkBiDimensionalWidget_GetBiDimensionalRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal int | vtkBiDimensionalWidget_GetWidgetState_03 (HandleRef pThis) |
static internal int | vtkBiDimensionalWidget_IsA_04 (HandleRef pThis, string type) |
static internal int | vtkBiDimensionalWidget_IsMeasureValid_05 (HandleRef pThis) |
static internal int | vtkBiDimensionalWidget_IsTypeOf_06 (string type) |
static internal IntPtr | vtkBiDimensionalWidget_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal IntPtr | vtkBiDimensionalWidget_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkBiDimensionalWidget_SetEnabled_10 (HandleRef pThis, int arg0) |
static internal void | vtkBiDimensionalWidget_SetProcessEvents_11 (HandleRef pThis, int arg0) |
static internal void | vtkBiDimensionalWidget_SetRepresentation_12 (HandleRef pThis, HandleRef r) |
static internal void | vtkBiDimensionalWidget_SetWidgetStateToManipulate_13 (HandleRef pThis) |
static internal void | vtkBiDimensionalWidget_SetWidgetStateToStart_14 (HandleRef pThis) |
Static Private Member Functions | |
static | vtkBiDimensionalWidget () |
Automatically generated type registration mechanics. |
vtkBiDimensionalWidget - measure the bi-dimensional lengths of an object
Description The vtkBiDimensionalWidget is used to measure the bi-dimensional length of an object. The bi-dimensional measure is defined by two finite, orthogonal lines that intersect within the finite extent of both lines. The lengths of these two lines gives the bi-dimensional measure. Each line is defined by two handle widgets at the end points of each line.
The orthognal constraint on the two lines limits how the four end points can be positioned. The first two points can be placed arbitrarily to define the first line (similar to vtkDistanceWidget). The placement of the third point is limited by the finite extent of the first line. As the third point is placed, the fourth point is placed on the opposite side of the first line. Once the third point is placed, the second line is defined since the fourth point is defined at the same time, but the fourth point can be moved along the second line (i.e., maintaining the orthogonal relationship between the two lines). Onced defined, any of the four points can be moved along their constraint lines. Also, each line can be translated along the other line (in an orthogonal direction), and the whole bi-dimensional widget can be rotated about its center point (see the description of the event bindings). Finally, selecting the point where the two orthogonal axes intersect, the entire widget can be translated in any direction.
Placement of any point results in a special PlacePointEvent invocation so that special operations may be performed to reposition the point. Motion of any point, moving the lines, or rotating the widget cause InteractionEvents to be invoked. Note that the widget has two fundamental modes: a define mode (when initially placing the points) and a manipulate mode (after the points are placed). Line translation and rotation are only possible in manipulate mode.
To use this widget, specify an instance of vtkBiDimensionalWidget and a representation (e.g., vtkBiDimensionalRepresentation2D). The widget is implemented using four instances of vtkHandleWidget which are used to position the end points of the two intersecting lines. The representations for these handle widgets are provided by the vtkBiDimensionalRepresentation class.
Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> LeftButtonPressEvent - define a point or manipulate a handle, line, perform rotation or translate the widget. MouseMoveEvent - position the points, move a line, rotate or translate the widget LeftButtonReleaseEvent - release the selected handle and end interaction </pre>
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBiDimensionalWidget's widget events: <pre> vtkWidgetEvent::AddPoint -- (In Define mode:) Add one point; depending on the state it may the first, second, third or fourth point added. (In Manipulate mode:) If near a handle, select the handle. Or if near a line, select the line. vtkWidgetEvent::Move -- (In Define mode:) Position the second, third or fourth point. (In Manipulate mode:) Move the handle, line or widget. vtkWidgetEvent::EndSelect -- the manipulation process has completed. </pre>
This widget invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (beginning to interact) vtkCommand::EndInteractionEvent (completing interaction) vtkCommand::InteractionEvent (moving a handle, line or performing rotation) vtkCommand::PlacePointEvent (after a point is positioned; call data includes handle id (0,1,2,4)) </pre>
Enum defining the state of the widget. By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state.
static Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget | ( | ) | [static, private] |
Automatically generated type registration mechanics.
Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget | ( | IntPtr | rawCppThis, |
bool | callDisposalMethod, | ||
bool | strong | ||
) |
Automatically generated constructor - called from generated code. DO NOT call directly.
Instantiate this class.
override void Kitware.VTK.vtkBiDimensionalWidget.CreateDefaultRepresentation | ( | ) | [virtual] |
Create the default widget representation if one is not set.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
override void Kitware.VTK.vtkBiDimensionalWidget.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.vtkAbstractWidget.
vtkBiDimensionalRepresentation Kitware.VTK.vtkBiDimensionalWidget.GetBiDimensionalRepresentation | ( | ) |
Return the representation as a vtkBiDimensionalRepresentation.
virtual int Kitware.VTK.vtkBiDimensionalWidget.GetWidgetState | ( | ) | [virtual] |
Return the current widget state.
override int Kitware.VTK.vtkBiDimensionalWidget.IsA | ( | string | type | ) | [virtual] |
Standard methods for a VTK class.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
A flag indicates whether the bi-dimensional measure is valid. The widget becomes valid after two of the four points are placed.
static new int Kitware.VTK.vtkBiDimensionalWidget.IsTypeOf | ( | string | type | ) | [static] |
Standard methods for a VTK class.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
static new vtkBiDimensionalWidget Kitware.VTK.vtkBiDimensionalWidget.New | ( | ) | [static] |
Instantiate this class.
Reimplemented from Kitware.VTK.vtkObject.
Standard methods for a VTK class.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
static new vtkBiDimensionalWidget Kitware.VTK.vtkBiDimensionalWidget.SafeDownCast | ( | vtkObjectBase | o | ) | [static] |
Standard methods for a VTK class.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
override void Kitware.VTK.vtkBiDimensionalWidget.SetEnabled | ( | int | arg0 | ) | [virtual] |
The method for activiating and deactiviating this widget. This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
override void Kitware.VTK.vtkBiDimensionalWidget.SetProcessEvents | ( | int | arg0 | ) | [virtual] |
Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.
virtual void Kitware.VTK.vtkBiDimensionalWidget.SetWidgetStateToManipulate | ( | ) | [virtual] |
Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.
virtual void Kitware.VTK.vtkBiDimensionalWidget.SetWidgetStateToStart | ( | ) | [virtual] |
Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_CreateDefaultRepresentation_01 | ( | HandleRef | pThis | ) | [private] |
static internal IntPtr Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_GetBiDimensionalRepresentation_02 | ( | HandleRef | pThis, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal int Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_GetWidgetState_03 | ( | HandleRef | pThis | ) | [private] |
static internal int Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_IsA_04 | ( | HandleRef | pThis, |
string | type | ||
) | [private] |
static internal int Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_IsMeasureValid_05 | ( | HandleRef | pThis | ) | [private] |
static internal int Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_IsTypeOf_06 | ( | string | type | ) | [private] |
static internal IntPtr Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_New | ( | ref uint | mteStatus, |
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal IntPtr Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_NewInstance_08 | ( | HandleRef | pThis, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal IntPtr Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SafeDownCast_09 | ( | HandleRef | o, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SetEnabled_10 | ( | HandleRef | pThis, |
int | arg0 | ||
) | [private] |
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SetProcessEvents_11 | ( | HandleRef | pThis, |
int | arg0 | ||
) | [private] |
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SetRepresentation_12 | ( | HandleRef | pThis, |
HandleRef | r | ||
) | [private] |
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SetWidgetStateToManipulate_13 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkBiDimensionalWidget.vtkBiDimensionalWidget_SetWidgetStateToStart_14 | ( | HandleRef | pThis | ) | [private] |
new readonly string Kitware.VTK.vtkBiDimensionalWidget.MRClassNameKey = "22vtkBiDimensionalWidget" [static] |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkAbstractWidget.
new const string Kitware.VTK.vtkBiDimensionalWidget.MRFullTypeName = "Kitware.VTK.vtkBiDimensionalWidget" |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkAbstractWidget.