Public Member Functions |
| vtkLineWidget2 (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
| vtkLineWidget2 () |
| Instantiate the object.
|
override void | CreateDefaultRepresentation () |
| Create the default widget representation if one is not set.
|
vtkLineRepresentation | GetLineRepresentation () |
| Return the representation as a vtkLineRepresentation.
|
override int | IsA (string type) |
| Standard vtkObject methods
|
new vtkLineWidget2 | NewInstance () |
| Standard vtkObject methods
|
override void | SetEnabled (int enabling) |
| Override superclasses' SetEnabled() method because the line widget must enable its internal handle widgets.
|
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 (vtkLineRepresentation 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.
|
| vtkAbstractWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
vtkWidgetEventTranslator | GetEventTranslator () |
| Get the event translator. Careful manipulation of this class enables the user to override the default event bindings.
|
virtual int | GetManagesCursor () |
| Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual vtkAbstractWidget | GetParent () |
| Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).
|
virtual int | GetProcessEvents () |
| Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
virtual int | GetProcessEventsMaxValue () |
| Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
virtual int | GetProcessEventsMinValue () |
| Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
vtkWidgetRepresentation | GetRepresentation () |
| Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresenation) so it can be added to the renderer independent of the widget.
|
virtual void | ManagesCursorOff () |
| Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual void | ManagesCursorOn () |
| Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
virtual void | ProcessEventsOff () |
| Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
virtual void | ProcessEventsOn () |
| Methods to change the whether the widget responds to interaction. Set this to Off to disable interaction. On by default. Subclasses must overide SetProcessEvents() to make sure that they pass on the flag to all component widgets.
|
void | Render () |
| This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.
|
virtual void | SetManagesCursor (int _arg) |
| Turn on or off the management of the cursor. Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.
|
void | SetParent (vtkAbstractWidget parent) |
| Specifying a parent to this widget is used when creating composite widgets. It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).
|
override void | SetPriority (float arg0) |
| Override the superclass method. This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary
|
| vtkInteractorObserver (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
void | EnabledOff () |
| Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
|
void | EnabledOn () |
| Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
|
virtual vtkRenderer | GetCurrentRenderer () |
| Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
|
virtual vtkRenderer | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
|
int | GetEnabled () |
| Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
|
virtual vtkRenderWindowInteractor | GetInteractor () |
| This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.
|
virtual int | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
|
virtual sbyte | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
|
virtual float | GetPriority () |
| Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
|
virtual float | GetPriorityMaxValue () |
| Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
|
virtual float | GetPriorityMinValue () |
| Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)
|
void | GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents) |
| Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
|
virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
|
virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
|
void | Off () |
| Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
|
void | On () |
| Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.
|
virtual void | OnChar () |
| Sets up the keypress-i event.
|
void | ReleaseFocus () |
| Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.
|
virtual void | SetCurrentRenderer (vtkRenderer arg0) |
| Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).
|
virtual void | SetDefaultRenderer (vtkRenderer arg0) |
| Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.
|
virtual void | SetInteractor (vtkRenderWindowInteractor iren) |
| This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.
|
virtual void | SetKeyPressActivation (int _arg) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)
|
virtual void | SetKeyPressActivationValue (sbyte _arg) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.
|
| vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
| vtkObject () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
uint | AddObserver (uint arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
uint | AddObserver (string arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
virtual void | DebugOff () |
| Turn debugging output off.
|
virtual void | DebugOn () |
| Turn debugging output on.
|
vtkCommand | GetCommand (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
byte | GetDebug () |
| Get the value of the debug flag.
|
virtual uint | GetMTime () |
| Return this object's modified time.
|
int | HasObserver (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | HasObserver (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | HasObserver (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | HasObserver (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | InvokeEvent (uint arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | InvokeEvent (string arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | InvokeEvent (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
int | InvokeEvent (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
virtual void | Modified () |
| Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
|
void | RemoveAllObservers () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObserver (vtkCommand arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObserver (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObservers (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObservers (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObservers (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | RemoveObservers (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
void | SetDebug (byte debugFlag) |
| Set the value of the debug flag. A non-zero value turns debugging on.
|
override string | ToString () |
| Returns the result of calling vtkObject::Print as a C# string.
|
delegate void | vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e) |
| Generic signature for all vtkObject events.
|
void | RemoveAllHandlersForAllEvents () |
| Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
|
| vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
| vtkObjectBase () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
virtual void | Register (vtkObjectBase o) |
| Increase the reference count (mark as used by another object).
|
virtual void | FastDelete () |
| Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
|
string | GetClassName () |
| Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
void | SetReferenceCount (int arg0) |
| Sets the reference count. (This is very dangerous, use with care.)
|
Public Attributes |
new const string | MRFullTypeName = "Kitware.VTK.vtkLineWidget2" |
| Automatically generated type registration mechanics.
|
new const string | MRFullTypeName = "Kitware.VTK.vtkAbstractWidget" |
| Automatically generated type registration mechanics.
|
new const string | MRFullTypeName = "Kitware.VTK.vtkInteractorObserver" |
| Automatically generated type registration mechanics.
|
new const string | MRFullTypeName = "Kitware.VTK.vtkObject" |
| Automatically generated type registration mechanics.
|
new const string | MRFullTypeName = "Kitware.VTK.vtkObjectBase" |
| Automatically generated type registration mechanics.
|
const string | vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so" |
| Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
|
const string | vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so" |
| Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
|
const string | vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so" |
| Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
|
const string | vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so" |
| Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
|
const string | vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so" |
| Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
|
const string | vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so" |
| Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
|
const string | vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so" |
| Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
|
const string | vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so" |
| Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
|
const string | vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so" |
| Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
|
const string | vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so" |
| Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
|
const string | vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so" |
| Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
|
const string | vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so" |
| Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
|
const string | vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so" |
| Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
|
const string | vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so" |
| Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
|
const string | vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so" |
| Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.
|
vtkLineWidget2 - 3D widget for manipulating a finite, straight line
Description This 3D widget defines a straight line that can be interactively placed in a scene. The widget is assumed to consist of two parts: 1) two end points and 2) a straight line connecting the two points. (The representation paired with this widget determines the actual geometry of the widget.) The positioning of the two end points is facilitated by using vtkHandleWidgets to position the points.
To use this widget, you generally pair it with a vtkLineRepresentation (or a subclass). Variuos options are available in the representation for controlling how the widget appears, and how the widget functions.
Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> If one of the two end points are selected: LeftButtonPressEvent - activate the associated handle widget LeftButtonReleaseEvent - release the handle widget associated with the point MouseMoveEvent - move the point If the line is selected: LeftButtonPressEvent - activate a handle widget accociated with the line LeftButtonReleaseEvent - release the handle widget associated with the line MouseMoveEvent - translate the line In all the cases, independent of what is picked, the widget responds to the following VTK events: MiddleButtonPressEvent - translate the widget MiddleButtonReleaseEvent - release the widget RightButtonPressEvent - scale the widget's representation RightButtonReleaseEvent - stop scaling the widget MouseMoveEvent - scale (if right button) or move (if middle button) the widget </pre>
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkLineWidget2's widget events: <pre> vtkWidgetEvent::Select – some part of the widget has been selected vtkWidgetEvent::EndSelect – the selection process has completed vtkWidgetEvent::Move – a request for slider motion has been invoked </pre>
In turn, when these widget events are processed, the vtkLineWidget2 invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move) </pre>