VTK
9.1.0
|
measure the distance between two points More...
#include <vtkDistanceWidget.h>
Public Types | |
enum | { Start = 0 , Define , Manipulate } |
Description: Enum defining the state of the widget. More... | |
![]() | |
typedef vtkInteractorObserver | Superclass |
Standard macros implementing standard VTK methods. More... | |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
void | SetEnabled (int) override |
The method for activating and deactivating this widget. More... | |
void | SetRepresentation (vtkDistanceRepresentation *r) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More... | |
vtkDistanceRepresentation * | GetDistanceRepresentation () |
Return the representation as a vtkDistanceRepresentation. More... | |
void | CreateDefaultRepresentation () override |
Create the default widget representation if one is not set. More... | |
void | SetProcessEvents (vtkTypeBool) override |
Methods to change the whether the widget responds to interaction. More... | |
virtual int | GetWidgetState () |
Return the current widget state. More... | |
virtual void | SetWidgetStateToStart () |
Set the state of the widget. More... | |
virtual void | SetWidgetStateToManipulate () |
Set the state of the widget. More... | |
![]() | |
void | SetEnabled (int) override |
Methods for activating this widget. More... | |
vtkWidgetEventTranslator * | GetEventTranslator () |
Get the event translator. More... | |
virtual void | CreateDefaultRepresentation ()=0 |
Create the default widget representation if one is not set. More... | |
void | Render () |
This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More... | |
void | SetParent (vtkAbstractWidget *parent) |
Specifying a parent to this widget is used when creating composite widgets. More... | |
virtual vtkAbstractWidget * | GetParent () |
void | SetPriority (float) override |
Override the superclass method. More... | |
virtual vtkTypeBool | GetProcessEvents () |
Methods to change whether the widget responds to interaction. More... | |
virtual void | ProcessEventsOn () |
Methods to change whether the widget responds to interaction. More... | |
virtual void | ProcessEventsOff () |
Methods to change whether the widget responds to interaction. More... | |
vtkWidgetRepresentation * | GetRepresentation () |
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More... | |
virtual void | SetManagesCursor (vtkTypeBool) |
Turn on or off the management of the cursor. More... | |
virtual vtkTypeBool | GetManagesCursor () |
Turn on or off the management of the cursor. More... | |
virtual void | ManagesCursorOn () |
Turn on or off the management of the cursor. More... | |
virtual void | ManagesCursorOff () |
Turn on or off the management of the cursor. More... | |
vtkAbstractWidget * | NewInstance () const |
Standard macros implementing standard VTK methods. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkInteractorObserver * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | SetEnabled (int) |
Methods for turning the interactor observer on and off, and determining its state. More... | |
int | GetEnabled () |
void | EnabledOn () |
void | EnabledOff () |
void | On () |
void | Off () |
virtual void | OnChar () |
Sets up the keypress-i event. More... | |
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
This method is used to associate the widget with the render window interactor. More... | |
virtual vtkRenderWindowInteractor * | GetInteractor () |
This method is used to associate the widget with the render window interactor. More... | |
virtual float | GetPriority () |
Set/Get the priority at which events are processed. More... | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | PickingManagedOff () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | SetPickingManaged (bool managed) |
Enable/Disable the use of a manager to process the picking. More... | |
virtual bool | GetPickingManaged () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | SetKeyPressActivation (vtkTypeBool) |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual vtkTypeBool | GetKeyPressActivation () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual void | KeyPressActivationOn () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual void | KeyPressActivationOff () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. More... | |
virtual void | SetKeyPressActivationValue (char) |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More... | |
virtual char | GetKeyPressActivationValue () |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More... | |
virtual vtkRenderer * | GetDefaultRenderer () |
Set/Get the default renderer to use when activating the interactor observer. More... | |
virtual void | SetDefaultRenderer (vtkRenderer *) |
Set/Get the default renderer to use when activating the interactor observer. More... | |
virtual vtkRenderer * | GetCurrentRenderer () |
Set/Get the current renderer. More... | |
virtual void | SetCurrentRenderer (vtkRenderer *) |
Set/Get the current renderer. More... | |
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More... | |
void | ReleaseFocus () |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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. More... | |
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. More... | |
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. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
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). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkDistanceWidget * | New () |
Instantiate this class. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard macros implementing standard VTK methods. More... | |
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
Standard macros implementing standard VTK methods. More... | |
![]() | |
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. More... | |
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
Convenience methods for outside classes. More... | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
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). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
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. More... | |
Protected Member Functions | |
vtkDistanceWidget () | |
~vtkDistanceWidget () override | |
void | StartDistanceInteraction (int handleNum) |
void | DistanceInteraction (int handleNum) |
void | EndDistanceInteraction (int handleNum) |
![]() | |
vtkAbstractWidget () | |
~vtkAbstractWidget () override | |
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
virtual void | SetCursor (int vtkNotUsed(state)) |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkInteractorObserver () | |
~vtkInteractorObserver () override | |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. More... | |
void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. More... | |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the observer currently belong. More... | |
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. More... | |
int | RequestCursorShape (int requestedShape) |
virtual void | StartInteraction () |
Utility routines used to start and end interaction. More... | |
virtual void | EndInteraction () |
Utility routines used to start and end interaction. More... | |
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
Helper method for subclasses. More... | |
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
Helper method for subclasses. More... | |
![]() | |
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. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Static Protected Member Functions | |
static void | AddPointAction (vtkAbstractWidget *) |
static void | MoveAction (vtkAbstractWidget *) |
static void | EndSelectAction (vtkAbstractWidget *) |
static void | AddPointAction3D (vtkAbstractWidget *) |
static void | MoveAction3D (vtkAbstractWidget *) |
static void | EndSelectAction3D (vtkAbstractWidget *) |
![]() | |
static void | ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
![]() | |
static void | ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
Handles the char widget activation event. More... | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Friends | |
class | vtkDistanceWidgetCallback |
typedef vtkAbstractWidget | Superclass |
Standard methods for a VTK class. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for a VTK class. More... | |
static vtkDistanceWidget * | SafeDownCast (vtkObjectBase *o) |
Standard methods for a VTK class. More... | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methods for a VTK class. More... | |
vtkDistanceWidget * | NewInstance () const |
Standard methods for a VTK class. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for a VTK class. More... | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methods for a VTK class. More... | |
measure the distance between two points
The vtkDistanceWidget is used to measure the distance between two points. The two end points can be positioned independently, and when they are released, a special PlacePointEvent is invoked so that special operations may be take to reposition the point (snap to grid, etc.) The widget has two different modes of interaction: when initially defined (i.e., placing the two points) and then a manipulate mode (adjusting the position of the two points).
To use this widget, specify an instance of vtkDistanceWidget and a representation (a subclass of vtkDistanceRepresentation). The widget is implemented using two instances of vtkHandleWidget which are used to position the end points of the line. The representations for these two handle widgets are provided by the vtkDistanceRepresentation.
LeftButtonPressEvent - add a point or select a handle MouseMoveEvent - position the second point or move a handle LeftButtonReleaseEvent - release the handle
vtkWidgetEvent::AddPoint -- add one point; depending on the state it may the first or second point added. Or, if near a handle, select the handle. vtkWidgetEvent::Move -- move the second point or handle depending on the state. vtkWidgetEvent::EndSelect -- the handle manipulation process has completed.
vtkCommand::StartInteractionEvent (beginning to interact) vtkCommand::EndInteractionEvent (completing interaction) vtkCommand::InteractionEvent (moving after selecting something) vtkCommand::PlacePointEvent (after point is positioned; call data includes handle id (0,1))
Definition at line 98 of file vtkDistanceWidget.h.
Standard methods for a VTK class.
Definition at line 110 of file vtkDistanceWidget.h.
anonymous enum |
Description: Enum defining the state of the widget.
By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state.
Enumerator | |
---|---|
Start | |
Define | |
Manipulate |
Definition at line 157 of file vtkDistanceWidget.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate this class.
|
static |
Standard methods for a VTK class.
|
virtual |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
|
static |
Standard methods for a VTK class.
|
protectedvirtual |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
vtkDistanceWidget * vtkDistanceWidget::NewInstance | ( | ) | const |
Standard methods for a VTK class.
|
overridevirtual |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
|
overridevirtual |
The method for activating and deactivating this widget.
This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.
Reimplemented from vtkAbstractWidget.
|
inline |
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.
Definition at line 126 of file vtkDistanceWidget.h.
|
inline |
Return the representation as a vtkDistanceRepresentation.
Definition at line 134 of file vtkDistanceWidget.h.
|
overridevirtual |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.
|
overridevirtual |
Methods to change the whether the widget responds to interaction.
Overridden to pass the state to component widgets.
Reimplemented from vtkAbstractWidget.
|
virtual |
Set the state of the widget.
If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.
|
virtual |
Set the state of the widget.
If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.
|
inlinevirtual |
Return the current widget state.
Definition at line 182 of file vtkDistanceWidget.h.
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
friend |
Definition at line 213 of file vtkDistanceWidget.h.
|
protected |
Definition at line 189 of file vtkDistanceWidget.h.
|
protected |
Definition at line 190 of file vtkDistanceWidget.h.
|
protected |
Definition at line 202 of file vtkDistanceWidget.h.
|
protected |
Definition at line 203 of file vtkDistanceWidget.h.
|
protected |
Definition at line 204 of file vtkDistanceWidget.h.
|
protected |
Definition at line 205 of file vtkDistanceWidget.h.