Public Member Functions |
| | vtkLineWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| | Automatically generated constructor - called from generated code. DO NOT call directly.
|
| | vtkLineWidget () |
| | Instantiate the object.
|
| virtual void | ClampToBoundsOff () |
| | Enable/disable clamping of the point end points to the bounding box of the data. The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.
|
| virtual void | ClampToBoundsOn () |
| | Enable/disable clamping of the point end points to the bounding box of the data. The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.
|
| virtual int | GetAlign () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| virtual int | GetAlignMaxValue () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| virtual int | GetAlignMinValue () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| virtual int | GetClampToBounds () |
| | Enable/disable clamping of the point end points to the bounding box of the data. The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.
|
| virtual vtkProperty | GetHandleProperty () |
| | Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.
|
| virtual vtkProperty | GetLineProperty () |
| | Get the line properties. The properties of the line when selected and unselected can be manipulated.
|
| double[] | GetPoint1 () |
| | Set/Get the position of first end point.
|
| void | GetPoint1 (IntPtr xyz) |
| | Set/Get the position of first end point.
|
| double[] | GetPoint2 () |
| | Set position of other end point.
|
| void | GetPoint2 (IntPtr xyz) |
| | Set position of other end point.
|
| void | GetPolyData (vtkPolyData pd) |
| | Grab the polydata (including points) that defines the line. The polydata consists of n+1 points, where n is the resolution of the line. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyline are added to it.
|
| int | GetResolution () |
| | Set/Get the resolution (number of subdivisions) of the line.
|
| virtual vtkProperty | GetSelectedHandleProperty () |
| | Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.
|
| virtual vtkProperty | GetSelectedLineProperty () |
| | Get the line properties. The properties of the line when selected and unselected can be manipulated.
|
| override int | IsA (string type) |
| | Instantiate the object.
|
| new vtkLineWidget | NewInstance () |
| | Instantiate the object.
|
| 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.
|
| virtual void | SetAlign (int _arg) |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| void | SetAlignToNone () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| void | SetAlignToXAxis () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| void | SetAlignToYAxis () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| void | SetAlignToZAxis () |
| | Force the line widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the line to the axes if it is orginally not aligned.
|
| virtual void | SetClampToBounds (int _arg) |
| | Enable/disable clamping of the point end points to the bounding box of the data. The bounding box is defined from the last PlaceWidget() invocation, and includes the effect of the PlaceFactor which is used to gram/shrink the bounding box.
|
| override void | SetEnabled (int arg0) |
| | Methods that satisfy the superclass' API.
|
| void | SetPoint1 (double x, double y, double z) |
| | Set/Get the position of first end point.
|
| void | SetPoint1 (IntPtr x) |
| | Set/Get the position of first end point.
|
| void | SetPoint2 (double x, double y, double z) |
| | Set position of other end point.
|
| void | SetPoint2 (IntPtr x) |
| | Set position of other end point.
|
| void | SetResolution (int r) |
| | Set/Get the resolution (number of subdivisions) of the line.
|
| | 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.
|
| 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.
|
| | 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.
|
| virtual void | SetPriority (float _arg) |
| | 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.)
|
| | 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.)
|
vtkLineWidget - 3D widget for manipulating a line
Description This 3D widget defines a line that can be interactively placed in a scene. The line has two handles (at its endpoints), plus the line can be picked to translate it in the scene. A nice feature of the object is that the vtkLineWidget, like any 3D widget, will work with the current interactor style and any other widgets present in the scene. That is, if vtkLineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkLineWidget 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 vtkLineWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing one of the two end point handles (use the left mouse button), the line can be oriented and stretched (the other end point remains fixed). By grabbing the line itself, or using the middle mouse button, the entire line can be translated. Scaling (about the center of the line) is achieved by using the right mouse button. By moving the mouse "up" the render window the line will be made bigger; by moving "down" the render window the widget will be made smaller. Turn off the widget by pressing the "i" key again (or invoke the Off() method). (Note: picking the line or either one of the two end point handles causes a vtkPointWidget to appear. This widget has the ability to constrain motion to an axis by pressing the "shift" key while moving the mouse.)
The vtkLineWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the line; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button).
Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the line. For example, you can set the property for the handles and line. In addition there are methods to constrain the line so that it is aligned along the x-y-z axes.
Public Member Functions inherited from Kitware.VTK.vtk3DWidget