VTK
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 ()
- 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 vtkCheckerboardWidgetNew ()
- Static Public Member Functions inherited from vtkAbstractWidget

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 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)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkSliderWidgetTopSlider
vtkSliderWidgetRightSlider
vtkSliderWidgetBottomSlider
vtkSliderWidgetLeftSlider
- 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 vtkCWCallback
typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkCheckerboardWidgetSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Additional Inherited Members

- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
- Public Types inherited from vtkInteractorObserver
typedef vtkObject 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::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent
Tests:
vtkCheckerboardWidget (Tests)

Definition at line 60 of file vtkCheckerboardWidget.h.

Member Typedef Documentation

Standard methods for a VTK class.

Definition at line 68 of file vtkCheckerboardWidget.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static vtkCheckerboardWidget* vtkCheckerboardWidget::New ( )
static

Instantiate this class.

Reimplemented from vtkObject.

virtual const char* vtkCheckerboardWidget::GetClassName ( )
virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkCheckerboardWidget::SetEnabled ( int  )
virtual

The method for activiating and deactiviating 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 81 of file vtkCheckerboardWidget.h.

vtkCheckerboardRepresentation* vtkCheckerboardWidget::GetCheckerboardRepresentation ( )
inline

Return the representation as a vtkCheckerboardRepresentation.

Definition at line 87 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 110 of file vtkCheckerboardWidget.h.

Member Data Documentation

vtkSliderWidget* vtkCheckerboardWidget::TopSlider
protected

Definition at line 99 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::RightSlider
protected

Definition at line 100 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::BottomSlider
protected

Definition at line 101 of file vtkCheckerboardWidget.h.

vtkSliderWidget* vtkCheckerboardWidget::LeftSlider
protected

Definition at line 102 of file vtkCheckerboardWidget.h.


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