VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | 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
 Standard macros implementing standard VTK methods. More...
 
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkParallelopipedWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEnabled (int) override
 Override the superclass method. More...
 
void SetRepresentation (vtkParallelopipedRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
vtkParallelopipedRepresentationGetParallelopipedRepresentation ()
 Return the representation as a vtkParallelopipedRepresentation. More...
 
virtual void SetEnableChairCreation (vtkTypeBool)
 Enable/disable the creation of a chair on this widget. More...
 
virtual vtkTypeBool GetEnableChairCreation ()
 
virtual void EnableChairCreationOn ()
 
virtual void EnableChairCreationOff ()
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
void SetProcessEvents (vtkTypeBool) override
 Methods to change the whether the widget responds to interaction. More...
 
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
 
virtual vtkTypeBool GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. More...
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets. More...
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor. More...
 
virtual vtkTypeBool GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 
virtual void OnChar ()
 Sets up the keypress-i event. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkParallelopipedWidgetNew ()
 Instantiate the object. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParallelopipedWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

enum  WidgetEventIds { RequestResizeEvent = 10000, RequestResizeAlongAnAxisEvent, RequestChairModeEvent }
 Events invoked by this widget. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkParallelopipedWidget ()
 
 ~vtkParallelopipedWidget () override
 
void BeginTranslateAction (vtkParallelopipedWidget *dispatcher)
 
void TranslateAction (vtkParallelopipedWidget *dispatcher)
 
void SetCursor (int state) override
 
void ReportReferences (vtkGarbageCollector *collector) override
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
 
int RequestCursorShape (int requestedShape)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 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)
 Handles the char widget activation event. More...
 

Protected Attributes

vtkTypeBool EnableChairCreation
 
vtkHandleWidget ** HandleWidgets
 
vtkWidgetSetWidgetSet
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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.
Tests:
vtkParallelopipedWidget (Tests)

Definition at line 54 of file vtkParallelopipedWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkParallelopipedWidget.h.

Member Enumeration Documentation

◆ WidgetEventIds

Events invoked by this widget.

Enumerator
RequestResizeEvent 
RequestResizeAlongAnAxisEvent 
RequestChairModeEvent 

Definition at line 144 of file vtkParallelopipedWidget.h.

Constructor & Destructor Documentation

◆ vtkParallelopipedWidget()

vtkParallelopipedWidget::vtkParallelopipedWidget ( )
protected

◆ ~vtkParallelopipedWidget()

vtkParallelopipedWidget::~vtkParallelopipedWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkParallelopipedWidget* vtkParallelopipedWidget::New ( )
static

Instantiate the object.

◆ IsTypeOf()

static vtkTypeBool vtkParallelopipedWidget::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkParallelopipedWidget::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkParallelopipedWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkParallelopipedWidget* vtkParallelopipedWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkParallelopipedWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

void vtkParallelopipedWidget::SetEnabled ( int  )
overridevirtual

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.

◆ SetRepresentation()

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 80 of file vtkParallelopipedWidget.h.

◆ GetParallelopipedRepresentation()

vtkParallelopipedRepresentation* vtkParallelopipedWidget::GetParallelopipedRepresentation ( )
inline

Return the representation as a vtkParallelopipedRepresentation.

Definition at line 89 of file vtkParallelopipedWidget.h.

◆ SetEnableChairCreation()

virtual void vtkParallelopipedWidget::SetEnableChairCreation ( vtkTypeBool  )
virtual

Enable/disable the creation of a chair on this widget.

If off, chairs cannot be created.

◆ GetEnableChairCreation()

virtual vtkTypeBool vtkParallelopipedWidget::GetEnableChairCreation ( )
virtual

◆ EnableChairCreationOn()

virtual void vtkParallelopipedWidget::EnableChairCreationOn ( )
virtual

◆ EnableChairCreationOff()

virtual void vtkParallelopipedWidget::EnableChairCreationOff ( )
virtual

◆ CreateDefaultRepresentation()

void vtkParallelopipedWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SetProcessEvents()

void vtkParallelopipedWidget::SetProcessEvents ( vtkTypeBool  )
overridevirtual

Methods to change the whether the widget responds to interaction.

Overridden to pass the state to component widgets.

Reimplemented from vtkAbstractWidget.

◆ RequestResizeCallback()

static void vtkParallelopipedWidget::RequestResizeCallback ( vtkAbstractWidget )
staticprotected

◆ RequestResizeAlongAnAxisCallback()

static void vtkParallelopipedWidget::RequestResizeAlongAnAxisCallback ( vtkAbstractWidget )
staticprotected

◆ RequestChairModeCallback()

static void vtkParallelopipedWidget::RequestChairModeCallback ( vtkAbstractWidget )
staticprotected

◆ TranslateCallback()

static void vtkParallelopipedWidget::TranslateCallback ( vtkAbstractWidget )
staticprotected

◆ OnMouseMoveCallback()

static void vtkParallelopipedWidget::OnMouseMoveCallback ( vtkAbstractWidget )
staticprotected

◆ OnLeftButtonUpCallback()

static void vtkParallelopipedWidget::OnLeftButtonUpCallback ( vtkAbstractWidget )
staticprotected

◆ BeginTranslateAction()

void vtkParallelopipedWidget::BeginTranslateAction ( vtkParallelopipedWidget dispatcher)
protected

◆ TranslateAction()

void vtkParallelopipedWidget::TranslateAction ( vtkParallelopipedWidget dispatcher)
protected

◆ SetCursor()

void vtkParallelopipedWidget::SetCursor ( int  state)
overrideprotected

◆ ReportReferences()

void vtkParallelopipedWidget::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Friends And Related Function Documentation

◆ vtkWidgetSet

friend class vtkWidgetSet
friend

Definition at line 57 of file vtkParallelopipedWidget.h.

Member Data Documentation

◆ EnableChairCreation

vtkTypeBool vtkParallelopipedWidget::EnableChairCreation
protected

Definition at line 125 of file vtkParallelopipedWidget.h.

◆ HandleWidgets

vtkHandleWidget** vtkParallelopipedWidget::HandleWidgets
protected

Definition at line 139 of file vtkParallelopipedWidget.h.

◆ WidgetSet

vtkWidgetSet* vtkParallelopipedWidget::WidgetSet
protected

Definition at line 151 of file vtkParallelopipedWidget.h.


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