Public Member Functions |
| | vtk3DWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| | Automatically generated constructor - called from generated code. DO NOT call directly.
|
| virtual double | GetHandleSize () |
| | Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
|
| virtual double | GetHandleSizeMaxValue () |
| | Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
|
| virtual double | GetHandleSizeMinValue () |
| | Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
|
| virtual vtkDataSet | GetInput () |
| | Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.
|
| virtual double | GetPlaceFactor () |
| | Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
|
| virtual double | GetPlaceFactorMaxValue () |
| | Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
|
| virtual double | GetPlaceFactorMinValue () |
| | Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
|
| virtual vtkProp3D | GetProp3D () |
| | Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.
|
| override int | IsA (string type) |
| | *Undocumented Block
|
| new vtk3DWidget | NewInstance () |
| | *Undocumented Block
|
| virtual void | PlaceWidget (IntPtr bounds) |
| | This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
|
| virtual void | PlaceWidget () |
| | This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
|
| virtual void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
| | This method is used to initially place the widget. The placement of the widget depends on whether a Prop3D or input dataset is provided. If one of these two is provided, they will be used to obtain a bounding box, around which the widget is placed. Otherwise, you can manually specify a bounds with the PlaceWidget(bounds) method. Note: PlaceWidget(bounds) is required by all subclasses; the other methods are provided as convenience methods.
|
| virtual void | SetHandleSize (double _arg) |
| | Set/Get the factor that controls the size of the handles that appear as part of the widget. These handles (like spheres, etc.) are used to manipulate the widget, and are sized as a fraction of the screen diagonal.
|
| virtual void | SetInput (vtkDataSet arg0) |
| | Specify the input dataset. This is not required, but if supplied, and no vtkProp3D is specified, it is used to initially position the widget.
|
| virtual void | SetPlaceFactor (double _arg) |
| | Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
|
| virtual void | SetProp3D (vtkProp3D arg0) |
| | Specify a vtkProp3D around which to place the widget. This is not required, but if supplied, it is used to initially position the widget.
|
| | 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 | SetEnabled (int arg0) |
| | 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 | 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.)
|
vtk3DWidget - an abstract superclass for 3D widgets
Description vtk3DWidget is an abstract superclass for 3D interactor observers. These 3D widgets represent themselves in the scene, and have special callbacks associated with them that allows interactive manipulation of the widget. Inparticular, the difference between a vtk3DWidget and its abstract superclass vtkInteractorObserver is that vtk3DWidgets are "placed" in 3D space. vtkInteractorObservers have no notion of where they are placed, and may not exist in 3D space at all. 3D widgets also provide auxiliary functions like producing a transformation, creating polydata (for seeding streamlines, probes, etc.) or creating implicit functions. See the concrete subclasses for particulars.
Typically the widget is used by specifying a vtkProp3D or VTK dataset as input, and then invoking the "On" method to activate it. (You can also specify a bounding box to help position the widget.) Prior to invoking the On() method, the user may also wish to use the PlaceWidget() to initially position it. The 'i' (for "interactor") keypresses also can be used to turn the widgets on and off (methods exist to change the key value and enable keypress activiation).
To support interactive manipulation of objects, this class (and subclasses) invoke the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent. These events are invoked when the vtk3DWidget enters a state where rapid response is desired: mouse motion, etc. The events can be used, for example, to set the desired update frame rate (StartInteractionEvent), operate on the vtkProp3D or other object (InteractionEvent), and set the desired frame rate back to normal values (EndInteractionEvent).
Note that the Priority attribute inherited from vtkInteractorObserver has a new default value which is now 0.5 so that all 3D widgets have a higher priority than the usual interactor styles.
vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImplicitPlaneWidget
Public Member Functions inherited from Kitware.VTK.vtkInteractorObserver