vtkCompassWidget Class Reference

#include <vtkCompassWidget.h>

Inheritance diagram for vtkCompassWidget:

[legend]

Collaboration diagram for vtkCompassWidget:

[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 vtkCompassWidget *	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 (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 vtkCompassWidget *	New ()
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

typedef vtkAbstractWidget vtkCompassWidget::Superclass

Standard macros.

Reimplemented from vtkAbstractWidget.

Definition at line 83 of file vtkCompassWidget.h.

Member Enumeration Documentation

enum vtkCompassWidget::_WidgetState [protected]

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