|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkLineWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | SetResolution (int r) |
| Set/Get the resolution (number of subdivisions) of the line.
|
|
int | GetResolution () |
|
void | SetPoint1 (double x, double y, double z) |
| Set/Get the position of first end point.
|
|
void | SetPoint1 (double x[3]) |
|
double * | GetPoint1 () |
|
void | GetPoint1 (double xyz[3]) |
|
void | SetPoint2 (double x, double y, double z) |
| Set position of other end point.
|
|
void | SetPoint2 (double x[3]) |
|
double * | GetPoint2 () |
|
void | GetPoint2 (double xyz[3]) |
|
void | GetPolyData (vtkPolyData *pd) |
| Grab the polydata (including points) that defines the line.
|
|
|
void | SetEnabled (int) override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget (double bounds[6]) override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget () override |
| Methods that satisfy the superclass' API.
|
|
void | PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override |
| Methods that satisfy the superclass' API.
|
|
|
virtual void | SetAlign (int) |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
virtual int | GetAlign () |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
void | SetAlignToXAxis () |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
void | SetAlignToYAxis () |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
void | SetAlignToZAxis () |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
void | SetAlignToNone () |
| Force the line widget to be aligned with one of the x-y-z axes.
|
|
|
virtual void | SetClampToBounds (vtkTypeBool) |
| Enable/disable clamping of the point end points to the bounding box of the data.
|
|
virtual vtkTypeBool | GetClampToBounds () |
| Enable/disable clamping of the point end points to the bounding box of the data.
|
|
virtual void | ClampToBoundsOn () |
| Enable/disable clamping of the point end points to the bounding box of the data.
|
|
virtual void | ClampToBoundsOff () |
| Enable/disable clamping of the point end points to the bounding box of the data.
|
|
|
virtual vtkProperty * | GetHandleProperty () |
| Get the handle properties (the little balls are the handles).
|
|
virtual vtkProperty * | GetSelectedHandleProperty () |
| Get the handle properties (the little balls are the handles).
|
|
|
virtual vtkProperty * | GetLineProperty () |
| Get the line properties.
|
|
virtual vtkProperty * | GetSelectedLineProperty () |
| Get the line properties.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtk3DWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetProp3D (vtkProp3D *) |
| Specify a vtkProp3D around which to place the widget.
|
|
virtual vtkProp3D * | GetProp3D () |
| Specify a vtkProp3D around which to place the widget.
|
|
virtual void | SetInputData (vtkDataSet *) |
| Specify the input dataset.
|
|
virtual void | SetInputConnection (vtkAlgorithmOutput *) |
| Specify the input dataset.
|
|
virtual vtkDataSet * | GetInput () |
| Specify the input dataset.
|
|
virtual void | SetPlaceFactor (double) |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
|
|
virtual double | GetPlaceFactor () |
| Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
|
|
virtual void | SetHandleSize (double) |
| Set/Get the factor that controls the size of the handles that appear as part of the widget.
|
|
virtual double | GetHandleSize () |
| Set/Get the factor that controls the size of the handles that appear as part of the widget.
|
|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
vtkInteractorObserver * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | SetEnabled (int) |
| Methods for turning the interactor observer on and off, and determining its state.
|
|
int | GetEnabled () |
|
void | EnabledOn () |
|
void | EnabledOff () |
|
void | On () |
|
void | Off () |
|
virtual void | OnChar () |
| Sets up the keypress-i event.
|
|
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor.
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
| This method is used to associate the widget with the render window interactor.
|
|
virtual void | SetPriority (float) |
| Set/Get the priority at which events are processed.
|
|
virtual float | GetPriority () |
| Set/Get the priority at which events are processed.
|
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | PickingManagedOff () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetPickingManaged (bool managed) |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual bool | GetPickingManaged () |
| Enable/Disable the use of a manager to process the picking.
|
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOn () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | KeyPressActivationOff () |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer.
|
|
virtual void | SetKeyPressActivationValue (char) |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual char | GetKeyPressActivationValue () |
| Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
|
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
| Set/Get the default renderer to use when activating the interactor observer.
|
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer.
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
| Set/Get the current renderer.
|
|
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
void | ReleaseFocus () |
| These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
|
|
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
|
virtual void | DebugOn () |
| Turn debugging output on.
|
|
virtual void | DebugOff () |
| Turn debugging output off.
|
|
bool | GetDebug () |
| Get the value of the debug flag.
|
|
void | SetDebug (bool debugFlag) |
| Set the value of the debug flag.
|
|
virtual void | Modified () |
| Update the modification time for this object.
|
|
virtual vtkMTimeType | GetMTime () |
| Return this object's modified time.
|
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses.
|
|
void | RemoveObserver (unsigned long tag) |
|
void | RemoveObservers (unsigned long event) |
|
void | RemoveObservers (const char *event) |
|
void | RemoveAllObservers () |
|
vtkTypeBool | HasObserver (unsigned long event) |
|
vtkTypeBool | HasObserver (const char *event) |
|
vtkTypeBool | InvokeEvent (unsigned long event) |
|
vtkTypeBool | InvokeEvent (const char *event) |
|
std::string | GetObjectDescription () const override |
| The object description printed in messages and PrintSelf output.
|
|
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
|
template<class U , class T > |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method.
|
|
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not.
|
|
virtual void | SetObjectName (const std::string &objectName) |
| Set/get the name of this object for reporting purposes.
|
|
virtual std::string | GetObjectName () const |
| Set/get the name of this object for reporting purposes.
|
|
const char * | GetClassName () const |
| Return the class name as a string.
|
|
virtual std::string | GetObjectDescription () const |
| The object description printed in messages and PrintSelf output.
|
|
virtual vtkTypeBool | IsA (const char *name) |
| Return 1 if this class is the same type of (or a subclass of) the named class.
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
virtual void | Delete () |
| Delete a VTK object.
|
|
virtual void | FastDelete () |
| Delete a reference to this object.
|
|
void | InitializeObjectBase () |
|
void | Print (ostream &os) |
| Print an object to an ostream.
|
|
void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object).
|
|
virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object).
|
|
int | GetReferenceCount () |
| Return the current reference count of this object.
|
|
void | SetReferenceCount (int) |
| Sets the reference count.
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space.
|
|
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses.
|
|
virtual bool | UsesGarbageCollector () const |
| Indicate whether the class uses vtkGarbageCollector or not.
|
|
|
static vtkLineWidget * | New () |
| Instantiate the object.
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkLineWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtk3DWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkInteractorObserver * | SafeDownCast (vtkObjectBase *o) |
|
static void | ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4]) |
| Convenience methods for outside classes.
|
|
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
| Convenience methods for outside classes.
|
|
static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | BreakOnError () |
| This method is called when vtkErrorMacro executes.
|
|
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed.
|
|
static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class.
|
|
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
|
static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
|
static void | SetMemkindDirectory (const char *directoryname) |
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
|
static bool | GetUsingMemkind () |
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkLineWidget () |
|
| ~vtkLineWidget () override |
|
void | OnLeftButtonDown () |
|
void | OnLeftButtonUp () |
|
void | OnMiddleButtonDown () |
|
void | OnMiddleButtonUp () |
|
void | OnRightButtonDown () |
|
void | OnRightButtonUp () |
|
virtual void | OnMouseMove () |
|
void | HighlightLine (int highlight) |
|
void | BuildRepresentation () |
|
void | SizeHandles () override |
|
void | HandlesOn (double length) |
|
void | HandlesOff () |
|
int | HighlightHandle (vtkProp *prop) |
|
void | HighlightHandles (int highlight) |
|
void | SetLinePosition (double x[3]) |
|
void | RegisterPickers () override |
| Register internal Pickers in the Picking Manager.
|
|
void | Scale (double *p1, double *p2, int X, int Y) |
|
void | ClampPosition (double x[3]) |
|
int | InBounds (double x[3]) |
|
void | CreateDefaultProperties () |
|
void | GenerateLine () |
|
void | EnablePointWidget () |
|
void | DisablePointWidget () |
|
int | ForwardEvent (unsigned long event) |
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtk3DWidget () |
|
| ~vtk3DWidget () override |
|
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
|
double | SizeHandles (double factor) |
|
virtual void | SizeHandles () |
|
void | UpdateInput () |
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkInteractorObserver () |
|
| ~vtkInteractorObserver () override |
|
virtual void | RegisterPickers () |
| Register internal Pickers in the Picking Manager.
|
|
void | UnRegisterPickers () |
| Unregister internal pickers from the Picking Manager.
|
|
vtkPickingManager * | GetPickingManager () |
| Return the picking manager associated on the context on which the observer currently belong.
|
|
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
| Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.
|
|
int | RequestCursorShape (int requestedShape) |
|
virtual void | StartInteraction () |
| Utility routines used to start and end interaction.
|
|
virtual void | EndInteraction () |
| Utility routines used to start and end interaction.
|
|
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| Helper method for subclasses.
|
|
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
| Helper method for subclasses.
|
|
| vtkObject () |
|
| ~vtkObject () override |
|
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
|
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events.
|
|
void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events.
|
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
|
virtual void | ReportReferences (vtkGarbageCollector *) |
|
virtual void | ObjectFinalize () |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
3D widget for manipulating a line
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.
- See also
- vtk3DWidget vtkBoxWidget vtkPlaneWidget
- Events:
- vtkCommand::DisableEvent vtkCommand::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
- Online Examples:
- Tests:
- vtkLineWidget (Tests)
Definition at line 101 of file vtkLineWidget.h.