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

a widget to manipulate 3D parallelopipeds More...

#include <vtkParallelopipedWidget.h>

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

Public Types

typedef vtkAbstractWidget Superclass
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkParallelopipedWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetEnabled (int)
 
void CreateDefaultRepresentation ()
 
virtual void SetProcessEvents (int)
 
void SetRepresentation (vtkParallelopipedRepresentation *r)
 
vtkParallelopipedRepresentationGetParallelopipedRepresentation ()
 
virtual void SetEnableChairCreation (int)
 
virtual int GetEnableChairCreation ()
 
virtual void EnableChairCreationOn ()
 
virtual void EnableChairCreationOff ()
 
- Public Member Functions inherited from vtkAbstractWidget
void Render ()
 
virtual void SetPriority (float)
 
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 vtkParallelopipedWidgetNew ()
 
static int IsTypeOf (const char *type)
 
static vtkParallelopipedWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  WidgetEventIds { RequestResizeEvent = 10000, RequestResizeAlongAnAxisEvent, RequestChairModeEvent }
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkParallelopipedWidget ()
 
 ~vtkParallelopipedWidget ()
 
void SetCursor (int state)
 
virtual void ReportReferences (vtkGarbageCollector *collector)
 
void BeginTranslateAction (vtkParallelopipedWidget *dispatcher)
 
void TranslateAction (vtkParallelopipedWidget *dispatcher)
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 

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 *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

int EnableChairCreation
 
vtkHandleWidget ** HandleWidgets
 
vtkWidgetSetWidgetSet
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 

Friends

class vtkWidgetSet
 

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::InteractionEvent vtkCommand::EnableEvent vtkCommand::StartInteractionEvent vtkCommand::DisableEvent
Tests:
vtkParallelopipedWidget (Tests)

Definition at line 56 of file vtkParallelopipedWidget.h.

Member Typedef Documentation

Definition at line 65 of file vtkParallelopipedWidget.h.

Member Enumeration Documentation

Events invoked by this widget

Enumerator
RequestResizeEvent 
RequestResizeAlongAnAxisEvent 
RequestChairModeEvent 

Definition at line 137 of file vtkParallelopipedWidget.h.

Constructor & Destructor Documentation

vtkParallelopipedWidget::vtkParallelopipedWidget ( )
protected
vtkParallelopipedWidget::~vtkParallelopipedWidget ( )
protected

Member Function Documentation

static vtkParallelopipedWidget* vtkParallelopipedWidget::New ( )
static

Instantiate the object.

static int vtkParallelopipedWidget::IsTypeOf ( const char *  type)
static
virtual int vtkParallelopipedWidget::IsA ( const char *  type)
virtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

static vtkParallelopipedWidget* vtkParallelopipedWidget::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkParallelopipedWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

vtkParallelopipedWidget* vtkParallelopipedWidget::NewInstance ( ) const
void vtkParallelopipedWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 78 of file vtkParallelopipedWidget.h.

vtkParallelopipedRepresentation* vtkParallelopipedWidget::GetParallelopipedRepresentation ( )
inline

Return the representation as a vtkParallelopipedRepresentation.

Definition at line 87 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 )
staticprotected
static void vtkParallelopipedWidget::RequestResizeAlongAnAxisCallback ( vtkAbstractWidget )
staticprotected
static void vtkParallelopipedWidget::RequestChairModeCallback ( vtkAbstractWidget )
staticprotected
static void vtkParallelopipedWidget::TranslateCallback ( vtkAbstractWidget )
staticprotected
static void vtkParallelopipedWidget::OnMouseMoveCallback ( vtkAbstractWidget )
staticprotected
static void vtkParallelopipedWidget::OnLeftButtonUpCallback ( vtkAbstractWidget )
staticprotected
void vtkParallelopipedWidget::BeginTranslateAction ( vtkParallelopipedWidget dispatcher)
protected
void vtkParallelopipedWidget::TranslateAction ( vtkParallelopipedWidget dispatcher)
protected
void vtkParallelopipedWidget::SetCursor ( int  state)
protected
virtual void vtkParallelopipedWidget::ReportReferences ( vtkGarbageCollector *  collector)
protectedvirtual

Friends And Related Function Documentation

friend class vtkWidgetSet
friend

Definition at line 59 of file vtkParallelopipedWidget.h.

Member Data Documentation

int vtkParallelopipedWidget::EnableChairCreation
protected

Definition at line 118 of file vtkParallelopipedWidget.h.

vtkHandleWidget** vtkParallelopipedWidget::HandleWidgets
protected

Definition at line 132 of file vtkParallelopipedWidget.h.

vtkWidgetSet* vtkParallelopipedWidget::WidgetSet
protected

Definition at line 146 of file vtkParallelopipedWidget.h.


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