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

interactively set the number of divisions in 2D image checkerboard More...

#include <vtkCheckerboardWidget.h>

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

Public Member Functions

virtual void SetEnabled (int)
 
void CreateDefaultRepresentation ()
 
void SetRepresentation (vtkCheckerboardRepresentation *r)
 
vtkCheckerboardRepresentationGetCheckerboardRepresentation ()
 
- Public Member Functions inherited from vtkAbstractWidget
void Render ()
 
virtual void SetPriority (float)
 
virtual void SetProcessEvents (int)
 
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 vtkCheckerboardWidgetNew ()
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkCheckerboardWidget ()
 
 ~vtkCheckerboardWidget ()
 
void StartCheckerboardInteraction ()
 
void CheckerboardInteraction (int sliderNum)
 
void EndCheckerboardInteraction ()
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 

Protected Attributes

vtkSliderWidgetTopSlider
 
vtkSliderWidgetRightSlider
 
vtkSliderWidgetBottomSlider
 
vtkSliderWidgetLeftSlider
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 

Friends

class vtkCWCallback
 
typedef vtkAbstractWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkCheckerboardWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCheckerboardWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Additional Inherited Members

- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Detailed Description

interactively set the number of divisions in 2D image checkerboard

The vtkCheckerboardWidget is used to interactively control an instance of vtkImageCheckerboard (and an associated vtkImageActor used to display the checkerboard). The user can adjust the number of divisions in each of the i-j directions in a 2D image. A frame appears around the vtkImageActor with sliders along each side of the frame. The user can interactively adjust the sliders to the desired number of checkerboard subdivisions.

To use this widget, specify an instance of vtkImageCheckerboard and an instance of vtkImageActor. By default, the widget responds to the following events:

If the slider bead is selected:
  LeftButtonPressEvent - select slider (if on slider)
  LeftButtonReleaseEvent - release slider
  MouseMoveEvent - move slider
If the end caps or slider tube of a slider are selected:
  LeftButtonPressEvent - jump (or animate) to cap or point on tube;

It is possible to change these event bindings. Please refer to the documentation for vtkSliderWidget for more information. Advanced users may directly access and manipulate the sliders by obtaining the instances of vtkSliderWidget composing the vtkCheckerboard widget.

See Also
vtkImageCheckerboard vtkImageActor vtkSliderWidget vtkRectilinearWipeWidget
Events:
vtkCommand::DisableEvent vtkCommand::EnableEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkCheckerboardWidget (Tests)

Definition at line 61 of file vtkCheckerboardWidget.h.

Member Typedef Documentation

Standard methods for a VTK class.

Definition at line 69 of file vtkCheckerboardWidget.h.

Constructor & Destructor Documentation

vtkCheckerboardWidget::vtkCheckerboardWidget ( )
protected
vtkCheckerboardWidget::~vtkCheckerboardWidget ( )
protected

Member Function Documentation

static vtkCheckerboardWidget* vtkCheckerboardWidget::New ( )
static

Instantiate this class.

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

Standard methods for a VTK class.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

virtual vtkObjectBase* vtkCheckerboardWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkCheckerboardWidget* vtkCheckerboardWidget::NewInstance ( ) const

Standard methods for a VTK class.

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

Standard methods for a VTK class.

virtual void vtkCheckerboardWidget::SetEnabled ( int  )
virtual

The method for activating and deactivating this widget. This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.

Reimplemented from vtkAbstractWidget.

void vtkCheckerboardWidget::SetRepresentation ( vtkCheckerboardRepresentation 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 82 of file vtkCheckerboardWidget.h.

vtkCheckerboardRepresentation* vtkCheckerboardWidget::GetCheckerboardRepresentation ( )
inline

Return the representation as a vtkCheckerboardRepresentation.

Definition at line 88 of file vtkCheckerboardWidget.h.

void vtkCheckerboardWidget::CreateDefaultRepresentation ( )
virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

void vtkCheckerboardWidget::StartCheckerboardInteraction ( )
protected
void vtkCheckerboardWidget::CheckerboardInteraction ( int  sliderNum)
protected
void vtkCheckerboardWidget::EndCheckerboardInteraction ( )
protected

Friends And Related Function Documentation

friend class vtkCWCallback
friend

Definition at line 111 of file vtkCheckerboardWidget.h.

Member Data Documentation

vtkSliderWidget* vtkCheckerboardWidget::TopSlider
protected

Definition at line 100 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::RightSlider
protected

Definition at line 101 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::BottomSlider
protected

Definition at line 102 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::LeftSlider
protected

Definition at line 103 of file vtkCheckerboardWidget.h.


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