measure the angle between two rays (defined by three points) More...

#include <vtkAngleWidget.h>

Inheritance diagram for vtkAngleWidget:

Collaboration diagram for vtkAngleWidget:

Public Types
enum	{ Start =0, Define, Manipulate }
	Enum defining the state of the widget. 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 void	SetEnabled (int)
	The method for activating and deactivating this widget. More...

void	SetRepresentation (vtkAngleRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...

void	CreateDefaultRepresentation ()
	Create the default widget representation if one is not set. More...

vtkAngleRepresentation *	GetAngleRepresentation ()
	Return the representation as a vtkAngleRepresentation. More...

int	IsAngleValid ()
	A flag indicates whether the angle is valid. More...

virtual void	SetProcessEvents (int)
	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...

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

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

virtual int	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 (int)
	Turn on or off the management of the cursor. More...

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

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

void	PrintSelf (ostream &os, vtkIndent indent)
	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	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)
	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 (int)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual int	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=NULL)
	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...

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

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

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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 vtkAngleWidget *	New ()
	Instantiate this class. More...

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods. More...

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
	Standard macros implementing standard VTK methods. More...

Static Public Member Functions inherited from vtkInteractorObserver
static int	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 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 ()
	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 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
	vtkAngleWidget ()

	~vtkAngleWidget ()

void	StartAngleInteraction (int handleNum)

void	AngleInteraction (int handleNum)

void	EndAngleInteraction (int handleNum)

Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()

	~vtkAbstractWidget ()

void	SetWidgetRepresentation (vtkWidgetRepresentation *r)

virtual void	SetCursor (int vtkNotUsed(state))

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. 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...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 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 *	CenterWidget

vtkHandleWidget *	Point2Widget

vtkAngleWidgetCallback *	AngleWidgetCallback1

vtkAngleWidgetCallback *	AngleWidgetCenterCallback

vtkAngleWidgetCallback *	AngleWidgetCallback2

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

int	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

int	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkAngleWidgetCallback

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

static int	IsTypeOf (const char *type)
	Standard methods for a VTK class. More...

static vtkAngleWidget *	SafeDownCast (vtkObjectBase *o)
	Standard methods for a VTK class. More...

virtual int	IsA (const char *type)
	Standard methods for a VTK class. More...

vtkAngleWidget *	NewInstance () const
	Standard methods for a VTK class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for a VTK class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for a VTK class. More...

Detailed Description

measure the angle between two rays (defined by three points)

The vtkAngleWidget is used to measure the angle between two rays (defined by three points). The three points (two end points and a center) 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 three points) and then a manipulate mode (adjusting the position of the three points).

To use this widget, specify an instance of vtkAngleWidget and a representation (a subclass of vtkAngleRepresentation). The widget is implemented using three instances of vtkHandleWidget which are used to position the three points. The representations for these handle widgets are provided by the vtkAngleRepresentation.

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 or third point, or move a handle
  LeftButtonReleaseEvent - release the selected 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 vtkAngleWidget's widget events:

  vtkWidgetEvent::AddPoint -- add one point; depending on the state
                              it may the first, second or third point
                              added. Or, if near a handle, select the handle.
  vtkWidgetEvent::Move -- position the second or third point, or move the
                          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 a handle)
  vtkCommand::PlacePointEvent (after a point is positioned;
                               call data includes handle id (0,1,2))

See also: vtkHandleWidget vtkDistanceWidget

Examples:: vtkAngleWidget (Examples)

Tests:: vtkAngleWidget (Tests)

Definition at line 88 of file vtkAngleWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkAngleWidget::Superclass

Standard methods for a VTK class.

Definition at line 100 of file vtkAngleWidget.h.

Member Enumeration Documentation

anonymous enum

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 148 of file vtkAngleWidget.h.

Constructor & Destructor Documentation

vtkAngleWidget::vtkAngleWidget ( )

protected

vtkAngleWidget::~vtkAngleWidget ( )

protected

Member Function Documentation

static vtkAngleWidget* vtkAngleWidget::New ( )

static

Instantiate this class.

static int vtkAngleWidget::IsTypeOf ( const char * type )

static

Standard methods for a VTK class.

virtual int vtkAngleWidget::IsA ( const char * type )

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

static

Standard methods for a VTK class.

virtual vtkObjectBase* vtkAngleWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkAngleWidget* vtkAngleWidget::NewInstance ( ) const

Standard methods for a VTK class.

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

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkAngleWidget::SetEnabled ( int )

virtual

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.

void vtkAngleWidget::SetRepresentation ( vtkAngleRepresentation * 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 116 of file vtkAngleWidget.h.

void vtkAngleWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

vtkAngleRepresentation* vtkAngleWidget::GetAngleRepresentation ( )

inline

Return the representation as a vtkAngleRepresentation.

Definition at line 127 of file vtkAngleWidget.h.

int vtkAngleWidget::IsAngleValid ( )

A flag indicates whether the angle is valid.

The angle value only becomes valid after two of the three points are placed.

virtual void vtkAngleWidget::SetProcessEvents ( int )

virtual

Methods to change the whether the widget responds to interaction.

Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

virtual void vtkAngleWidget::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.

virtual void vtkAngleWidget::SetWidgetStateToManipulate ( )

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 int vtkAngleWidget::GetWidgetState ( )

inlinevirtual

Return the current widget state.

Definition at line 168 of file vtkAngleWidget.h.

static void vtkAngleWidget::AddPointAction ( vtkAbstractWidget * )

staticprotected

static void vtkAngleWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

static void vtkAngleWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

void vtkAngleWidget::StartAngleInteraction ( int handleNum )

protected

void vtkAngleWidget::AngleInteraction ( int handleNum )

protected

void vtkAngleWidget::EndAngleInteraction ( int handleNum )

protected

Friends And Related Function Documentation

friend class vtkAngleWidgetCallback

friend

Definition at line 199 of file vtkAngleWidget.h.

Member Data Documentation

int vtkAngleWidget::WidgetState

protected

Definition at line 176 of file vtkAngleWidget.h.

int vtkAngleWidget::CurrentHandle

protected

Definition at line 177 of file vtkAngleWidget.h.

vtkHandleWidget* vtkAngleWidget::Point1Widget

protected

Definition at line 186 of file vtkAngleWidget.h.

vtkHandleWidget* vtkAngleWidget::CenterWidget

protected

Definition at line 187 of file vtkAngleWidget.h.

vtkHandleWidget* vtkAngleWidget::Point2Widget

protected

Definition at line 188 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCallback1

protected

Definition at line 189 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCenterCallback

protected

Definition at line 190 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCallback2

protected

Definition at line 191 of file vtkAngleWidget.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Interaction/Widgets/vtkAngleWidget.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

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation