vtkParallelopipedWidget Class Reference

#include <vtkParallelopipedWidget.h>

Inheritance diagram for vtkParallelopipedWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkParallelopipedWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

a widget to manipulate 3D parallelopipeds

This widget was designed with the aim of visualizing / probing cuts on a skewed image data / structured grid.

Interaction:
The widget allows you to create a parallelopiped (defined by 8 handles). The widget is initially placed by using the "PlaceWidget" method in the representation class. After the widget has been created, the following interactions may be used to manipulate it : 1) Click on a handle and drag it around moves the handle in space, while keeping the same axis alignment of the parallelopiped 2) Dragging a handle with the shift button pressed resizes the piped along an axis. 3) Control-click on a handle creates a chair at that position. (A chair is a depression in the piped that allows you to visualize cuts in the volume). 4) Clicking on a chair and dragging it around moves the chair within the piped. 5) Shift-click on the piped enables you to translate it.
Events:
vtkCommand::DisableEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent
Tests:
vtkParallelopipedWidget (Tests)

Definition at line 55 of file vtkParallelopipedWidget.h.


Public Types

typedef vtkAbstractWidget Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetEnabled (int)
void CreateDefaultRepresentation ()
virtual void SetProcessEvents (int)
void SetRepresentation (vtkParallelopipedRepresentation *r)
virtual void SetEnableChairCreation (int)
virtual int GetEnableChairCreation ()
virtual void EnableChairCreationOn ()
virtual void EnableChairCreationOff ()

Static Public Member Functions

static vtkParallelopipedWidgetNew ()
static int IsTypeOf (const char *type)
static vtkParallelopipedWidgetSafeDownCast (vtkObject *o)

Protected Types

enum  WidgetEventIds { RequestResizeEvent = 10000, RequestResizeAlongAnAxisEvent, RequestChairModeEvent }

Protected Member Functions

 vtkParallelopipedWidget ()
 ~vtkParallelopipedWidget ()
void SetCursor (int state)
virtual void ReportReferences (vtkGarbageCollector *collector)
void BeginTranslateAction (vtkParallelopipedWidget *dispatcher)
void TranslateAction (vtkParallelopipedWidget *dispatcher)

Static Protected Member Functions

static void RequestResizeCallback (vtkAbstractWidget *)
static void RequestResizeAlongAnAxisCallback (vtkAbstractWidget *)
static void RequestChairModeCallback (vtkAbstractWidget *)
static void TranslateCallback (vtkAbstractWidget *)
static void OnMouseMoveCallback (vtkAbstractWidget *)
static void OnLeftButtonUpCallback (vtkAbstractWidget *)

Protected Attributes

int EnableChairCreation
vtkHandleWidget ** HandleWidgets
vtkWidgetSetWidgetSet

Friends

class vtkWidgetSet

Member Typedef Documentation

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

Definition at line 64 of file vtkParallelopipedWidget.h.


Member Enumeration Documentation

Events invoked by this widget

Enumerator:
RequestResizeEvent 
RequestResizeAlongAnAxisEvent 
RequestChairModeEvent 

Definition at line 130 of file vtkParallelopipedWidget.h.


Constructor & Destructor Documentation

vtkParallelopipedWidget::vtkParallelopipedWidget (  )  [protected]

vtkParallelopipedWidget::~vtkParallelopipedWidget (  )  [protected]


Member Function Documentation

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

Instantiate the object.

Reimplemented from vtkObject.

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

virtual void vtkParallelopipedWidget::SetEnabled ( int   )  [virtual]

Override the superclass method. This is a composite widget, (it internally consists of handle widgets). We will override the superclass method, so that we can pass the enabled state to the internal widgets as well.

Reimplemented from vtkAbstractWidget.

void vtkParallelopipedWidget::SetRepresentation ( vtkParallelopipedRepresentation 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 77 of file vtkParallelopipedWidget.h.

virtual void vtkParallelopipedWidget::SetEnableChairCreation ( int   )  [virtual]

Enable/disable the creation of a chair on this widget. If off, chairs cannot be created.

virtual int vtkParallelopipedWidget::GetEnableChairCreation (  )  [virtual]

Enable/disable the creation of a chair on this widget. If off, chairs cannot be created.

virtual void vtkParallelopipedWidget::EnableChairCreationOn (  )  [virtual]

Enable/disable the creation of a chair on this widget. If off, chairs cannot be created.

virtual void vtkParallelopipedWidget::EnableChairCreationOff (  )  [virtual]

Enable/disable the creation of a chair on this widget. If off, chairs cannot be created.

void vtkParallelopipedWidget::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkParallelopipedWidget::SetProcessEvents ( int   )  [virtual]

Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

static void vtkParallelopipedWidget::RequestResizeCallback ( vtkAbstractWidget  )  [static, protected]

static void vtkParallelopipedWidget::RequestResizeAlongAnAxisCallback ( vtkAbstractWidget  )  [static, protected]

static void vtkParallelopipedWidget::RequestChairModeCallback ( vtkAbstractWidget  )  [static, protected]

static void vtkParallelopipedWidget::TranslateCallback ( vtkAbstractWidget  )  [static, protected]

static void vtkParallelopipedWidget::OnMouseMoveCallback ( vtkAbstractWidget  )  [static, protected]

static void vtkParallelopipedWidget::OnLeftButtonUpCallback ( vtkAbstractWidget  )  [static, protected]

void vtkParallelopipedWidget::BeginTranslateAction ( vtkParallelopipedWidget dispatcher  )  [protected]

void vtkParallelopipedWidget::TranslateAction ( vtkParallelopipedWidget dispatcher  )  [protected]

void vtkParallelopipedWidget::SetCursor ( int  state  )  [protected]

virtual void vtkParallelopipedWidget::ReportReferences ( vtkGarbageCollector collector  )  [protected, virtual]

Reimplemented from vtkObjectBase.


Friends And Related Function Documentation

friend class vtkWidgetSet [friend]

Definition at line 58 of file vtkParallelopipedWidget.h.


Member Data Documentation

Definition at line 111 of file vtkParallelopipedWidget.h.

Definition at line 125 of file vtkParallelopipedWidget.h.

Definition at line 139 of file vtkParallelopipedWidget.h.


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

Generated on Sat Dec 27 13:40:56 2008 for VTK by  doxygen 1.5.6