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

vtkContourWidget - create a contour with a set of points More...

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

List of all members.

Public Member Functions

 vtkContourWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkContourWidget ()
 Instantiate this class.
virtual void AllowNodePickingOff ()
 Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.
virtual void AllowNodePickingOn ()
 Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.
void CloseLoop ()
 Convenient method to close the contour loop.
virtual void ContinuousDrawOff ()
 Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.
virtual void ContinuousDrawOn ()
 Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
virtual void FollowCursorOff ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.
virtual void FollowCursorOn ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.
virtual int GetAllowNodePicking ()
 Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.
virtual int GetContinuousDraw ()
 Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.
vtkContourRepresentation GetContourRepresentation ()
 Return the representation as a vtkContourRepresentation.
virtual int GetFollowCursor ()
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.
virtual int GetWidgetState ()
 Convenient method to determine the state of the method.
virtual void Initialize (vtkPolyData poly, int state)
 Initialize the contour widget from a user supplied set of points. The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.
virtual void Initialize ()
 Initialize the contour widget from a user supplied set of points. The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.
override int IsA (string type)
 Standard methods for a VTK class.
new vtkContourWidget NewInstance ()
 Standard methods for a VTK class.
void SetAllowNodePicking (int arg0)
 Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.
virtual void SetContinuousDraw (int _arg)
 Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.
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.
virtual void SetFollowCursor (int _arg)
 Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.
void SetRepresentation (vtkContourRepresentation 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 SetWidgetState (int _arg)
 Convenient method to change what state the widget is in.

Static Public Member Functions

static new vtkContourWidget New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard methods for a VTK class.
static new vtkContourWidget SafeDownCast (vtkObjectBase o)
 Standard methods for a VTK class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkContourWidget"
 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 vtkContourWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkContourWidget_AllowNodePickingOff_01 (HandleRef pThis)
static internal void vtkContourWidget_AllowNodePickingOn_02 (HandleRef pThis)
static internal void vtkContourWidget_CloseLoop_03 (HandleRef pThis)
static internal void vtkContourWidget_ContinuousDrawOff_04 (HandleRef pThis)
static internal void vtkContourWidget_ContinuousDrawOn_05 (HandleRef pThis)
static internal void vtkContourWidget_CreateDefaultRepresentation_06 (HandleRef pThis)
static internal void vtkContourWidget_FollowCursorOff_07 (HandleRef pThis)
static internal void vtkContourWidget_FollowCursorOn_08 (HandleRef pThis)
static internal int vtkContourWidget_GetAllowNodePicking_09 (HandleRef pThis)
static internal int vtkContourWidget_GetContinuousDraw_10 (HandleRef pThis)
static internal IntPtr vtkContourWidget_GetContourRepresentation_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkContourWidget_GetFollowCursor_12 (HandleRef pThis)
static internal int vtkContourWidget_GetWidgetState_13 (HandleRef pThis)
static internal void vtkContourWidget_Initialize_14 (HandleRef pThis, HandleRef poly, int state)
static internal void vtkContourWidget_Initialize_15 (HandleRef pThis)
static internal int vtkContourWidget_IsA_16 (HandleRef pThis, string type)
static internal int vtkContourWidget_IsTypeOf_17 (string type)
static internal IntPtr vtkContourWidget_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkContourWidget_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkContourWidget_SetAllowNodePicking_21 (HandleRef pThis, int arg0)
static internal void vtkContourWidget_SetContinuousDraw_22 (HandleRef pThis, int _arg)
static internal void vtkContourWidget_SetEnabled_23 (HandleRef pThis, int arg0)
static internal void vtkContourWidget_SetFollowCursor_24 (HandleRef pThis, int _arg)
static internal void vtkContourWidget_SetRepresentation_25 (HandleRef pThis, HandleRef r)
static internal void vtkContourWidget_SetWidgetState_26 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkContourWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkContourWidget - create a contour with a set of points

Description The vtkContourWidget is used to select a set of points, and draw lines between these points. The contour may be opened or closed, depending on how the last point is added. The widget handles all processing of widget events (that are triggered by VTK events). The vtkContourRepresentation is responsible for all placement of the points, calculation of the lines, and contour manipulation. This is done through two main helper classes: vtkPointPlacer and vtkContourLineInterpolator. The representation is also responsible for drawing the points and lines.

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> LeftButtonPressEvent - triggers a Select event RightButtonPressEvent - triggers a AddFinalPoint event MouseMoveEvent - triggers a Move event LeftButtonReleaseEvent - triggers an EndSelect event Delete key event - triggers a Delete event Shift + Delete key event - triggers a Reset event </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkContourWidget's widget events: <pre> vtkWidgetEvent::Select widget state is: Start or Define: If we already have at least 2 nodes, test whether the current (X,Y) location is near an existing node. If so, close the contour and change to Manipulate state. Otherwise, attempt to add a node at this (X,Y) location. Manipulate: If this (X,Y) location activates a node, then set the current operation to Translate. Otherwise, if this location is near the contour, attempt to add a new node on the contour at this (X,Y) location.

vtkWidgetEvent::AddFinalPoint widget state is: Start: Do nothing. Define: If we already have at least 2 nodes, test whether the current (X,Y) location is near an existing node. If so, close the contour and change to Manipulate state. Otherwise, attempt to add a node at this (X,Y) location. If we do, then leave the contour open and change to Manipulate state. Manipulate: Do nothing.

vtkWidgetEvent::Move widget state is: Start or Define: Do nothing. Manipulate: If our operation is Translate, then invoke WidgetInteraction() on the representation. If our operation is Inactive, then just attempt to activate a node at this (X,Y) location.

vtkWidgetEvent::EndSelect widget state is: Start or Define: Do nothing. Manipulate: If our operation is not Inactive, set it to Inactive.

vtkWidgetEvent::Delete widget state is: Start: Do nothing. Define: Remove the last point on the contour. Manipulate: Attempt to activate a node at (X,Y). If we do activate a node, delete it. If we now have less than 3 nodes, go back to Define state.

vtkWidgetEvent::Reset widget state is: Start: Do nothing. Define: Remove all points and line segments of the contour. Essentially calls Intialize(NULL) Manipulate: Do nothing. </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 after selecting something) vtkCommand::PlacePointEvent (after point is positioned; call data includes handle id (0,1)) vtkCommand::WidgetValueChangedEvent (Invoked when the contour is closed for the first time. ) </pre>


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

Convenient method to close the contour loop.

Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

virtual void Kitware.VTK.vtkContourWidget.FollowCursorOn ( ) [virtual]

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

Return the representation as a vtkContourRepresentation.

Here is the call graph for this function:

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

Convenient method to determine the state of the method.

virtual void Kitware.VTK.vtkContourWidget.Initialize ( vtkPolyData  poly,
int  state 
) [virtual]

Initialize the contour widget from a user supplied set of points. The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.

virtual void Kitware.VTK.vtkContourWidget.Initialize ( ) [virtual]

Initialize the contour widget from a user supplied set of points. The state of the widget decides if you are still defining the widget, or if you've finished defining (added the last point) are manipulating it. Note that if the polydata supplied is closed, the state will be set to manipulate. State: Define = 0, Manipulate = 1.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkObject.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

Set / Get the AllowNodePicking value. This ivar indicates whether the nodes and points between nodes can be picked/un-picked by Ctrl+Click on the node.

virtual void Kitware.VTK.vtkContourWidget.SetContinuousDraw ( int  _arg) [virtual]

Define a contour by continuously drawing with the mouse cursor. Press and hold the left mouse button down to continuously draw. Releasing the left mouse button switches into a snap drawing mode. Terminate the contour by pressing the right mouse button. If you do not want to see the nodes as they are added to the contour, set the opacity to 0 of the representation's property. If you do not want to see the last active node as it is being added, set the opacity to 0 of the representation's active property.

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

virtual void Kitware.VTK.vtkContourWidget.SetFollowCursor ( int  _arg) [virtual]

Follow the cursor ? If this is ON, during definition, the last node of the contour will automatically follow the cursor, without waiting for the the point to be dropped. This may be useful for some interpolators, such as the live-wire interpolator to see the shape of the contour that will be placed as you move the mouse cursor.

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.vtkContourWidget.SetWidgetState ( int  _arg) [virtual]

Convenient method to change what state the widget is in.

static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_AllowNodePickingOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_AllowNodePickingOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_CloseLoop_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_ContinuousDrawOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_ContinuousDrawOn_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_CreateDefaultRepresentation_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_FollowCursorOff_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_FollowCursorOn_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_GetAllowNodePicking_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_GetContinuousDraw_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkContourWidget.vtkContourWidget_GetContourRepresentation_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_GetFollowCursor_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_GetWidgetState_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_Initialize_14 ( HandleRef  pThis,
HandleRef  poly,
int  state 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_Initialize_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkContourWidget.vtkContourWidget_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkContourWidget.vtkContourWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkContourWidget.vtkContourWidget_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkContourWidget.vtkContourWidget_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetAllowNodePicking_21 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetContinuousDraw_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetEnabled_23 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetFollowCursor_24 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetRepresentation_25 ( HandleRef  pThis,
HandleRef  r 
) [private]
static internal void Kitware.VTK.vtkContourWidget.vtkContourWidget_SetWidgetState_26 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkContourWidget.MRClassNameKey = "16vtkContourWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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