VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkSphereWidget2 Class Reference

3D widget for manipulating a point on a sphere More...

#include <vtkSphereWidget2.h>

Inheritance diagram for vtkSphereWidget2:
[legend]
Collaboration diagram for vtkSphereWidget2:
[legend]

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 ()
 
- Public Member Functions inherited from vtkAbstractWidget
virtual void SetEnabled (int)
 
void Render ()
 
virtual void SetPriority (float)
 
virtual void SetProcessEvents (int)
 
virtual int GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 
void SetParent (vtkAbstractWidget *parent)
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 
virtual void SetManagesCursor (int)
 
virtual int GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
vtkAbstractWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSphereWidget2New ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  _WidgetState { Start =0, Active }
 

Protected Member Functions

 vtkSphereWidget2 ()
 
 ~vtkSphereWidget2 ()
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void ScaleAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

int WidgetState
 
int TranslationEnabled
 
int ScalingEnabled
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
typedef vtkAbstractWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkSphereWidget2SafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkSphereWidget2NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

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)
Event Bindings:
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::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkSphereWidget2 (Tests)

Definition at line 102 of file vtkSphereWidget2.h.

Member Typedef Documentation

Standard class methods for type information and printing.

Definition at line 110 of file vtkSphereWidget2.h.

Member Enumeration Documentation

Enumerator
Start 
Active 

Definition at line 143 of file vtkSphereWidget2.h.

Constructor & Destructor Documentation

vtkSphereWidget2::vtkSphereWidget2 ( )
protected
vtkSphereWidget2::~vtkSphereWidget2 ( )
protected

Member Function Documentation

static vtkSphereWidget2* vtkSphereWidget2::New ( )
static

Instantiate the object.

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

Standard class methods for type information and printing.

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

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

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

Standard class methods for type information and printing.

virtual vtkObjectBase* vtkSphereWidget2::NewInstanceInternal ( ) const
protectedvirtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

vtkSphereWidget2* vtkSphereWidget2::NewInstance ( ) const

Standard class methods for type information and printing.

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

Standard class methods for type information and printing.

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 118 of file vtkSphereWidget2.h.

virtual void vtkSphereWidget2::SetTranslationEnabled ( int  )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual int vtkSphereWidget2::GetTranslationEnabled ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::TranslationEnabledOn ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::TranslationEnabledOff ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::SetScalingEnabled ( int  )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual int vtkSphereWidget2::GetScalingEnabled ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::ScalingEnabledOn ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::ScalingEnabledOff ( )
virtual

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

void vtkSphereWidget2::CreateDefaultRepresentation ( )
virtual

Create the default widget representation if one is not set. By default, this is an instance of the vtkSphereRepresentation class.

Implements vtkAbstractWidget.

static void vtkSphereWidget2::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::TranslateAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::ScaleAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::MoveAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

int vtkSphereWidget2::WidgetState
protected

Definition at line 142 of file vtkSphereWidget2.h.

int vtkSphereWidget2::TranslationEnabled
protected

Definition at line 154 of file vtkSphereWidget2.h.

int vtkSphereWidget2::ScalingEnabled
protected

Definition at line 155 of file vtkSphereWidget2.h.


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