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
vtkCompassWidget Class Reference

set a value by manipulating something More...

#include <vtkCompassWidget.h>

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

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)
 
- 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 vtkCompassWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

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

Protected Member Functions

 vtkCompassWidget ()
 
 ~vtkCompassWidget ()
 
- 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 MoveAction (vtkAbstractWidget *)
 
static void TimerAction (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 TimerId
 
int TimerDuration
 
double StartTime
 
- 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 vtkCompassWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCompassWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

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::StartInteractionEvent vtkCommand::InteractionEvent

Definition at line 76 of file vtkCompassWidget.h.

Member Typedef Documentation

Standard macros.

Definition at line 84 of file vtkCompassWidget.h.

Member Enumeration Documentation

Enumerator
Start 
Highlighting 
Adjusting 
TiltAdjusting 
DistanceAdjusting 

Definition at line 122 of file vtkCompassWidget.h.

Constructor & Destructor Documentation

vtkCompassWidget::vtkCompassWidget ( )
protected
vtkCompassWidget::~vtkCompassWidget ( )
inlineprotected

Definition at line 112 of file vtkCompassWidget.h.

Member Function Documentation

static vtkCompassWidget* vtkCompassWidget::New ( )
static

Instantiate the class.

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

Standard macros.

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

Standard macros.

Reimplemented from vtkAbstractWidget.

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

Standard macros.

virtual vtkObjectBase* vtkCompassWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkCompassWidget* vtkCompassWidget::NewInstance ( ) const

Standard macros.

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

Standard macros.

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 92 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 )
staticprotected
static void vtkCompassWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkCompassWidget::MoveAction ( vtkAbstractWidget )
staticprotected
static void vtkCompassWidget::TimerAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

int vtkCompassWidget::WidgetState
protected

Definition at line 121 of file vtkCompassWidget.h.

int vtkCompassWidget::TimerId
protected

Definition at line 132 of file vtkCompassWidget.h.

int vtkCompassWidget::TimerDuration
protected

Definition at line 133 of file vtkCompassWidget.h.

double vtkCompassWidget::StartTime
protected

Definition at line 134 of file vtkCompassWidget.h.


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