VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
vtkParallelopipedWidget Class Reference

a widget to manipulate 3D parallelopipeds More...

#include <vtkParallelopipedWidget.h>

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

List of all members.

Public Types

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

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)
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 ()
- Public Member Functions inherited from vtkInteractorObserver
virtual void OnChar ()
int GetEnabled ()
void EnabledOn ()
void EnabledOff ()
void On ()
void Off ()
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractorGetInteractor ()
virtual float GetPriority ()
virtual void SetKeyPressActivation (int)
virtual int GetKeyPressActivation ()
virtual void KeyPressActivationOn ()
virtual void KeyPressActivationOff ()
virtual void SetKeyPressActivationValue (char)
virtual char GetKeyPressActivationValue ()
virtual vtkRendererGetDefaultRenderer ()
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
virtual void SetCurrentRenderer (vtkRenderer *)
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void ReleaseFocus ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkParallelopipedWidgetNew ()
static int IsTypeOf (const char *type)
static vtkParallelopipedWidgetSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkInteractorObserver
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

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)
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 ~vtkAbstractWidget ()
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
virtual void SetCursor (int vtkNotUsed(state))
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 ~vtkInteractorObserver ()
int RequestCursorShape (int requestedShape)
virtual void StartInteraction ()
virtual void EndInteraction ()
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

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)
- Static Protected Member Functions inherited from vtkInteractorObserver
static void ProcessEvents (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
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
vtkCallbackCommandEventCallbackCommand
vtkCallbackCommandKeyPressCallbackCommand
float Priority
int KeyPressActivation
char KeyPressActivationValue
vtkRenderWindowInteractorInteractor
vtkRendererCurrentRenderer
vtkRendererDefaultRenderer
unsigned long CharObserverTag
unsigned long DeleteObserverTag
vtkObserverMediatorObserverMediator
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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

Definition at line 55 of file vtkParallelopipedWidget.h.


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 136 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.

vtkParallelopipedRepresentation* vtkParallelopipedWidget::GetParallelopipedRepresentation ( )
inline

Return the representation as a vtkParallelopipedRepresentation.

Definition at line 86 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

Reimplemented from vtkObjectBase.


Friends And Related Function Documentation

friend class vtkWidgetSet
friend

Definition at line 58 of file vtkParallelopipedWidget.h.


Member Data Documentation

int vtkParallelopipedWidget::EnableChairCreation
protected

Definition at line 117 of file vtkParallelopipedWidget.h.

vtkHandleWidget** vtkParallelopipedWidget::HandleWidgets
protected

Definition at line 131 of file vtkParallelopipedWidget.h.

vtkWidgetSet* vtkParallelopipedWidget::WidgetSet
protected

Definition at line 145 of file vtkParallelopipedWidget.h.


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