vtkCompassWidget Class Reference

#include <vtkCompassWidget.h>

Inheritance diagram for vtkCompassWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkCompassWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

set a value by manipulating something

The vtkCompassWidget is used to adjust a scalar value in an application. Note that the actual appearance of the widget depends on the specific representation for the widget.

To use this widget, set the widget representation. (the details may vary depending on the particulars of the representation).

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
 If the slider bead is selected:
   LeftButtonPressEvent - select slider 
   LeftButtonReleaseEvent - release slider 
   MouseMoveEvent - move slider
 
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkCompassWidget's widget events:
   vtkWidgetEvent::Select -- some part of the widget has been selected
   vtkWidgetEvent::EndSelect -- the selection process has completed
   vtkWidgetEvent::Move -- a request for slider motion has been invoked
 
Event Bindings:
In turn, when these widget events are processed, the vtkCompassWidget 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)
 
Events:
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent

Definition at line 75 of file vtkCompassWidget.h.

typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkCompassWidgetSafeDownCast (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 (vtkCompassRepresentation *r)
double GetHeading ()
void SetHeading (double v)
double GetTilt ()
void SetTilt (double t)
double GetDistance ()
void SetDistance (double t)

Static Public Member Functions

static vtkCompassWidgetNew ()

Protected Types

enum  _WidgetState {
  Start = 0, Highlighting, Adjusting, TiltAdjusting,
  DistanceAdjusting
}

Protected Member Functions

 vtkCompassWidget ()
 ~vtkCompassWidget ()

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)
static void TimerAction (vtkAbstractWidget *)

Protected Attributes

int WidgetState
int TimerId
int TimerDuration
double StartTime

Member Typedef Documentation

Standard macros.

Reimplemented from vtkAbstractWidget.

Definition at line 83 of file vtkCompassWidget.h.


Member Enumeration Documentation

Enumerator:
Start 
Highlighting 
Adjusting 
TiltAdjusting 
DistanceAdjusting 

Definition at line 121 of file vtkCompassWidget.h.


Constructor & Destructor Documentation

vtkCompassWidget::vtkCompassWidget (  )  [protected]

vtkCompassWidget::~vtkCompassWidget (  )  [inline, protected]

Definition at line 111 of file vtkCompassWidget.h.


Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkCompassWidget::SetRepresentation ( vtkCompassRepresentation 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 91 of file vtkCompassWidget.h.

void vtkCompassWidget::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

double vtkCompassWidget::GetHeading (  ) 

Get the value for this widget.

void vtkCompassWidget::SetHeading ( double  v  ) 

Get the value for this widget.

double vtkCompassWidget::GetTilt (  ) 

Get the value for this widget.

void vtkCompassWidget::SetTilt ( double  t  ) 

Get the value for this widget.

double vtkCompassWidget::GetDistance (  ) 

Get the value for this widget.

void vtkCompassWidget::SetDistance ( double  t  ) 

Get the value for this widget.

static void vtkCompassWidget::SelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkCompassWidget::EndSelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkCompassWidget::MoveAction ( vtkAbstractWidget  )  [static, protected]

static void vtkCompassWidget::TimerAction ( vtkAbstractWidget  )  [static, protected]


Member Data Documentation

Definition at line 120 of file vtkCompassWidget.h.

int vtkCompassWidget::TimerId [protected]

Definition at line 131 of file vtkCompassWidget.h.

Definition at line 132 of file vtkCompassWidget.h.

double vtkCompassWidget::StartTime [protected]

Definition at line 133 of file vtkCompassWidget.h.


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

Generated on Wed Jun 3 18:57:34 2009 for VTK by  doxygen 1.5.6