interactively control an instance of vtkImageRectilinearWipe filter More...

#include <vtkRectilinearWipeWidget.h>

Inheritance diagram for vtkRectilinearWipeWidget:

Collaboration diagram for vtkRectilinearWipeWidget:

Public Member Functions
virtual void	CreateDefaultRepresentation ()


void	SetRepresentation (vtkRectilinearWipeRepresentation *r)


vtkRectilinearWipeRepresentation *	GetRectilinearWipeRepresentation ()

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 ()

vtkWidgetEventTranslator *	GetEventTranslator ()

void	SetParent (vtkAbstractWidget *parent)

virtual vtkAbstractWidget *	GetParent ()

vtkWidgetRepresentation *	GetRepresentation ()

virtual void	SetManagesCursor (int)

virtual int	GetManagesCursor ()

virtual void	ManagesCursorOn ()

virtual void	ManagesCursorOff ()

vtkAbstractWidget *	NewInstance () const

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	OnChar ()

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual float	GetPriority ()

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (int)

virtual int	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()

virtual void	SetCurrentRenderer (vtkRenderer *)

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkRectilinearWipeWidget *	New ()

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

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 int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Types
enum	_WidgetState { Start =0, Selected }

Protected Member Functions
	vtkRectilinearWipeWidget ()

	~vtkRectilinearWipeWidget ()

void	SetCursor (int state)

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 ()

virtual void	RegisterPickers ()

void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

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])

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

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 &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	SelectAction (vtkAbstractWidget *)

static void	MoveAction (vtkAbstractWidget *)

static void	EndSelectAction (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	WidgetState

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

int	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

int	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkAbstractWidget	Superclass

static int	IsTypeOf (const char *type)

static vtkRectilinearWipeWidget *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkRectilinearWipeWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Detailed Description

interactively control an instance of vtkImageRectilinearWipe filter

The vtkRectilinearWipeWidget is used to interactively control an instance of vtkImageRectilinearWipe (and an associated vtkImageActor used to display the rectilinear wipe). A rectilinear wipe is a 2x2 checkerboard pattern created by combining two separate images, where various combinations of the checker squares are possible. Using this widget, the user can adjust the layout of the checker pattern, such as moving the center point, moving the horizontal separator, or moving the vertical separator. These capabilities are particularly useful for comparing two images.

To use this widget, specify its representation (by default the representation is an instance of vtkRectilinearWipeProp). The representation generally requires that you specify an instance of vtkImageRectilinearWipe and an instance of vtkImageActor. Other instance variables may also be required to be set – see the documentation for vtkRectilinearWipeProp (or appropriate subclass).

By default, the widget responds to the following events:

Selecting the center point, horizontal separator, and verticel separator:
  LeftButtonPressEvent - move the separators
  LeftButtonReleaseEvent - release the separators
  MouseMoveEvent - move the separators

Selecting the center point allows you to move the horizontal and vertical separators simultaneously. Otherwise only horizontal or vertical motion is possible/

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkRectilinearWipeWidget'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 motion has been invoked

In turn, when these widget events are processed, the vtkRectilinearWipeWidget invokes the following VTK events (which observers can listen for):

  vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
  vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
  vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)

Warning: The appearance of this widget is defined by its representation, including any properties associated with the representation. The widget representation is a type of vtkProp that defines a particular API that works with this widget. If desired, the vtkProp may be subclassed to create new looks for the widget.

See also: vtkRectilinearWipeProp vtkImageRectilinearWipe vtkImageActor vtkCheckerboardWidget

Events:: vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent

Tests:: vtkRectilinearWipeWidget (Tests)

Definition at line 91 of file vtkRectilinearWipeWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkRectilinearWipeWidget::Superclass

Standard macros.

Definition at line 99 of file vtkRectilinearWipeWidget.h.

Member Enumeration Documentation

enum vtkRectilinearWipeWidget::_WidgetState

protected

Enumerator
Start
Selected

Definition at line 134 of file vtkRectilinearWipeWidget.h.

Constructor & Destructor Documentation

vtkRectilinearWipeWidget::vtkRectilinearWipeWidget ( )

protected

vtkRectilinearWipeWidget::~vtkRectilinearWipeWidget ( )

protected

Member Function Documentation

static vtkRectilinearWipeWidget* vtkRectilinearWipeWidget::New ( )

static

Instantiate the class.

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

static

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkAbstractWidget.

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

static

Standard macros.

virtual vtkObjectBase* vtkRectilinearWipeWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkRectilinearWipeWidget* vtkRectilinearWipeWidget::NewInstance ( ) const

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkRectilinearWipeWidget::SetRepresentation ( vtkRectilinearWipeRepresentation * 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 107 of file vtkRectilinearWipeWidget.h.

vtkRectilinearWipeRepresentation* vtkRectilinearWipeWidget::GetRectilinearWipeRepresentation ( )

inline

Return the representation as a vtkRectilinearWipeRepresentation.

Definition at line 113 of file vtkRectilinearWipeWidget.h.

virtual void vtkRectilinearWipeWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

static void vtkRectilinearWipeWidget::SelectAction ( vtkAbstractWidget * )

staticprotected

static void vtkRectilinearWipeWidget::MoveAction ( vtkAbstractWidget * )