vtkSphereWidget2 Class Reference

#include <vtkSphereWidget2.h>

Inheritance diagram for vtkSphereWidget2:

[legend]

Collaboration diagram for vtkSphereWidget2:

[legend]

List of all members.

Detailed Description

3D widget for manipulating a point on a sphere

This 3D widget interacts with a vtkSphereRepresentation class (i.e., it handles the events that drive its corresponding representation). It can be used to position a point on a sphere (for example, to place a light or camera), or to position a sphere in a scene, including translating and scaling the sphere.

A nice feature of vtkSphereWidget2, like any 3D widget, is that it will work in combination with the current interactor style (or any other interactor observer). That is, if vtkSphereWidget2 does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkSphereWidget2 will terminate the processing of the event that it handles.

To use this widget, you generally pair it with a vtkSphereRepresentation (or a subclass). Variuos options are available in the representation for controlling how the widget appears, and how the widget functions.

Event Bindings:

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

 If the handle or sphere are selected:
   LeftButtonPressEvent - select the handle or sphere
   LeftButtonReleaseEvent - release the handle ot sphere
   MouseMoveEvent - move the handle or translate the sphere
 In all the cases, independent of what is picked, the widget responds to the 
 following VTK events:
   MiddleButtonPressEvent - translate the representation
   MiddleButtonReleaseEvent - stop translating the representation
   RightButtonPressEvent - scale the widget's representation
   RightButtonReleaseEvent - stop scaling the representation
   MouseMoveEvent - scale (if right button) or move (if middle button) the widget

Event Bindings:

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

   vtkWidgetEvent::Select -- some part of the widget has been selected
   vtkWidgetEvent::EndSelect -- the selection process has completed
   vtkWidgetEvent::Scale -- some part of the widget has been selected
   vtkWidgetEvent::EndScale -- the selection process has completed
   vtkWidgetEvent::Translate -- some part of the widget has been selected
   vtkWidgetEvent::EndTranslate -- the selection process has completed
   vtkWidgetEvent::Move -- a request for motion has been invoked

Event Bindings:

In turn, when these widget events are processed, the vtkSphereWidget2 invokes the following VTK events on itself (which observers can listen for):

   vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
   vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
   vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)

Warning:: Note that in some cases the widget can be picked even when it is "behind" other actors. This is an intended feature and not a bug.
This class, and the affiliated vtkSphereRepresentation, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkSphereWidget.

See also:: vtkSphereRepresentation vtkSphereWidget

Events:: vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Tests:: vtkSphereWidget2 (Tests)

Definition at line 104 of file vtkSphereWidget2.h.


typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkSphereWidget2 *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions
void	CreateDefaultRepresentation ()

void	SetRepresentation (vtkSphereRepresentation *r)

virtual void	SetTranslationEnabled (int)
virtual int	GetTranslationEnabled ()
virtual void	TranslationEnabledOn ()
virtual void	TranslationEnabledOff ()
virtual void	SetScalingEnabled (int)
virtual int	GetScalingEnabled ()
virtual void	ScalingEnabledOn ()
virtual void	ScalingEnabledOff ()
Static Public Member Functions
static vtkSphereWidget2 *	New ()
Protected Types
enum	_WidgetState { Start = 0, Active }
Protected Member Functions
	vtkSphereWidget2 ()
	~vtkSphereWidget2 ()
Static Protected Member Functions
static void	SelectAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	TranslateAction (vtkAbstractWidget *)
static void	ScaleAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
Protected Attributes
int	WidgetState
int	TranslationEnabled
int	ScalingEnabled

Member Typedef Documentation

typedef vtkAbstractWidget vtkSphereWidget2::Superclass

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

Definition at line 112 of file vtkSphereWidget2.h.

Member Enumeration Documentation

enum vtkSphereWidget2::_WidgetState [protected]

Enumerator:

Start
Active

Definition at line 145 of file vtkSphereWidget2.h.

Constructor & Destructor Documentation

vtkSphereWidget2::vtkSphereWidget2 ( ) [protected]

vtkSphereWidget2::~vtkSphereWidget2 ( ) [protected]

Member Function Documentation

static vtkSphereWidget2* vtkSphereWidget2::New ( ) [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkSphereWidget2::GetClassName ( ) [virtual]

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

static int vtkSphereWidget2::IsTypeOf ( const char * type ) [static]

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

virtual int vtkSphereWidget2::IsA ( const char * type ) [virtual]

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

static vtkSphereWidget2* vtkSphereWidget2::SafeDownCast ( vtkObject * o ) [static]

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

void vtkSphereWidget2::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

void vtkSphereWidget2::SetRepresentation ( vtkSphereRepresentation * 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 120 of file vtkSphereWidget2.h.

virtual void vtkSphereWidget2::SetTranslationEnabled ( int ) [virtual]