measure the distance between two points More...

#include <vtkDistanceWidget.h>

Inheritance diagram for vtkDistanceWidget:

Collaboration diagram for vtkDistanceWidget:

Public Types
enum	{ Start = 0, Define, Manipulate }
	Description: Enum defining the state of the widget. More...

typedef vtkAbstractWidget	Superclass
	Standard methods for a VTK class. More...

Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods. More...

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkDistanceWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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 void	SetWidgetStateToStart ()
	Set the state of the widget. More...

virtual void	SetWidgetStateToManipulate ()

virtual int	GetWidgetState ()
	Return the current widget state. More...

Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidget *	NewInstance () const

virtual vtkTypeBool	GetProcessEvents ()

virtual void	ProcessEventsOn ()

virtual void	ProcessEventsOff ()

vtkWidgetEventTranslator *	GetEventTranslator ()
	Get the event translator. 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 ()

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 ()

virtual void	ManagesCursorOn ()

virtual void	ManagesCursorOff ()

void	SetPriority (float) override
	Override the superclass method. More...

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor. More...

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual float	GetPriority ()

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool managed)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual vtkTypeBool	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

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 ()

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...

virtual void	SetCurrentRenderer (vtkRenderer *)

virtual void	OnChar ()
	Sets up the keypress-i event. 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 ()

Public Member Functions inherited from vtkObject
	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...

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)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

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)

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)

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkDistanceWidget *	New ()
	Instantiate this class. More...

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDistanceWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
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])

Static Public Member Functions inherited from vtkObject
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 ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDistanceWidget ()

	~vtkDistanceWidget () override

void	StartDistanceInteraction (int handleNum)

void	DistanceInteraction (int handleNum)

void	EndDistanceInteraction (int handleNum)

Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()

	~vtkAbstractWidget () override

void	SetWidgetRepresentation (vtkWidgetRepresentation *r)

virtual void	SetCursor (int vtkNotUsed(state))

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...

virtual void	EndInteraction ()

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])

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)

Protected Member Functions inherited from vtkObject
	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 ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

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 Protected Member Functions inherited from vtkAbstractWidget
static void	ProcessEventsHandler (vtkObject object, unsigned long event, void clientdata, void *calldata)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event. More...

Protected Attributes
int	WidgetState

int	CurrentHandle

vtkHandleWidget *	Point1Widget

vtkHandleWidget *	Point2Widget

vtkDistanceWidgetCallback *	DistanceWidgetCallback1

vtkDistanceWidgetCallback *	DistanceWidgetCallback2

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

vtkTypeBool	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

vtkTypeBool	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDistanceWidgetCallback

Detailed Description

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.

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

  LeftButtonPressEvent - add a point or select a handle
  MouseMoveEvent - position the second point or move a handle
  LeftButtonReleaseEvent - release the handle

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkDistanceWidget's widget events:

  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.

Event Bindings:

This widget invokes the following VTK events on itself (which observers can listen for):

  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))

See also: vtkHandleWidget

Definition at line 79 of file vtkDistanceWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractWidget vtkDistanceWidget::Superclass

Standard methods for a VTK class.

Definition at line 91 of file vtkDistanceWidget.h.

Member Enumeration Documentation

◆ anonymous enum

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 138 of file vtkDistanceWidget.h.

Constructor & Destructor Documentation

◆ vtkDistanceWidget()

vtkDistanceWidget::vtkDistanceWidget ( )

protected

◆ ~vtkDistanceWidget()

vtkDistanceWidget::~vtkDistanceWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDistanceWidget* vtkDistanceWidget::New ( )

static

Instantiate this class.

◆ IsTypeOf()

static vtkTypeBool vtkDistanceWidget::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkDistanceWidget::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

static vtkDistanceWidget* vtkDistanceWidget::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDistanceWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkDistanceWidget* vtkDistanceWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkDistanceWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

void vtkDistanceWidget::SetEnabled ( int )

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.

◆ SetRepresentation()

void vtkDistanceWidget::SetRepresentation ( vtkDistanceRepresentation * r )

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 107 of file vtkDistanceWidget.h.

◆ GetDistanceRepresentation()

vtkDistanceRepresentation* vtkDistanceWidget::GetDistanceRepresentation ( )

inline

Return the representation as a vtkDistanceRepresentation.

Definition at line 115 of file vtkDistanceWidget.h.

◆ CreateDefaultRepresentation()

void vtkDistanceWidget::CreateDefaultRepresentation ( )

overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SetProcessEvents()

void vtkDistanceWidget::SetProcessEvents ( vtkTypeBool )

overridevirtual

Methods to change the whether the widget responds to interaction.

Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

◆ SetWidgetStateToStart()

virtual void vtkDistanceWidget::SetWidgetStateToStart ( )

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.

◆ SetWidgetStateToManipulate()

virtual void vtkDistanceWidget::SetWidgetStateToManipulate ( )

virtual

◆ GetWidgetState()

virtual int vtkDistanceWidget::GetWidgetState ( )

inlinevirtual

Return the current widget state.

Definition at line 163 of file vtkDistanceWidget.h.

◆ AddPointAction()

static void vtkDistanceWidget::AddPointAction ( vtkAbstractWidget * )

staticprotected

◆ MoveAction()

static void vtkDistanceWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

◆ EndSelectAction()

static void vtkDistanceWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

◆ AddPointAction3D()

static void vtkDistanceWidget::AddPointAction3D ( vtkAbstractWidget * )

staticprotected

◆ MoveAction3D()

static void vtkDistanceWidget::MoveAction3D ( vtkAbstractWidget * )

staticprotected

◆ EndSelectAction3D()

static void vtkDistanceWidget::EndSelectAction3D ( vtkAbstractWidget * )

staticprotected

◆ StartDistanceInteraction()

void vtkDistanceWidget::StartDistanceInteraction ( int handleNum )

protected

◆ DistanceInteraction()

void vtkDistanceWidget::DistanceInteraction ( int handleNum )

protected

◆ EndDistanceInteraction()

void vtkDistanceWidget::EndDistanceInteraction ( int handleNum )

protected

Friends And Related Function Documentation

◆ vtkDistanceWidgetCallback

friend class vtkDistanceWidgetCallback

friend

Definition at line 194 of file vtkDistanceWidget.h.

Member Data Documentation

◆ WidgetState

int vtkDistanceWidget::WidgetState

protected

Definition at line 170 of file vtkDistanceWidget.h.

◆ CurrentHandle

int vtkDistanceWidget::CurrentHandle

protected

Definition at line 171 of file vtkDistanceWidget.h.

◆ Point1Widget

vtkHandleWidget* vtkDistanceWidget::Point1Widget

protected

Definition at line 183 of file vtkDistanceWidget.h.

◆ Point2Widget

vtkHandleWidget* vtkDistanceWidget::Point2Widget

protected

Definition at line 184 of file vtkDistanceWidget.h.

◆ DistanceWidgetCallback1

vtkDistanceWidgetCallback* vtkDistanceWidget::DistanceWidgetCallback1

protected

Definition at line 185 of file vtkDistanceWidget.h.

◆ DistanceWidgetCallback2

vtkDistanceWidgetCallback* vtkDistanceWidget::DistanceWidgetCallback2

protected

Definition at line 186 of file vtkDistanceWidget.h.

The documentation for this class was generated from the following file:

dox/Interaction/Widgets/vtkDistanceWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkDistanceWidget()

◆ ~vtkDistanceWidget()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetEnabled()

◆ SetRepresentation()

◆ GetDistanceRepresentation()

◆ CreateDefaultRepresentation()

◆ SetProcessEvents()

◆ SetWidgetStateToStart()

◆ SetWidgetStateToManipulate()

◆ GetWidgetState()

◆ AddPointAction()

◆ MoveAction()

◆ EndSelectAction()

◆ AddPointAction3D()

◆ MoveAction3D()

◆ EndSelectAction3D()

◆ StartDistanceInteraction()

◆ DistanceInteraction()

◆ EndDistanceInteraction()

Friends And Related Function Documentation

◆ vtkDistanceWidgetCallback

Member Data Documentation

◆ WidgetState

◆ CurrentHandle

◆ Point1Widget

◆ Point2Widget

◆ DistanceWidgetCallback1

◆ DistanceWidgetCallback2