activate an n-state button More...

#include <vtkButtonWidget.h>

Inheritance diagram for vtkButtonWidget:

Collaboration diagram for vtkButtonWidget:

Public Member Functions
void	CreateDefaultRepresentation ()


void	SetRepresentation (vtkButtonRepresentation *r)


vtkButtonRepresentation *	GetSliderRepresentation ()

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 vtkButtonWidget *	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, Hovering, Selecting }

Protected Member Functions
	vtkButtonWidget ()

	~vtkButtonWidget ()

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 vtkButtonWidget *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkButtonWidget *	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

activate an n-state button

The vtkButtonWidget is used to interface with an n-state button. That is each selection moves to the next button state (e.g., moves from "on" to "off"). The widget uses modulo list traversal to transition through one or more states. (A single state is simply a "selection" event; traversal through the list can be in the forward or backward direction.)

Depending on the nature of the representation the appearance of the button can change dramatically, the specifics of appearance changes are a function of the associated vtkButtonRepresentation (or subclass).

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

  LeftButtonPressEvent - select button
  LeftButtonReleaseEvent - end the button selection process

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkButtonWidget's widget events:

  vtkWidgetEvent::Select -- some part of the widget has been selected
  vtkWidgetEvent::EndSelect -- the selection process has completed

Event Bindings:

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

  vtkCommand::StateChangedEvent (on vtkWidgetEvent::EndSelect)

Events:: vtkCommand::StateChangedEvent

Tests:: vtkButtonWidget (Tests)

Definition at line 69 of file vtkButtonWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkButtonWidget::Superclass

Standard macros.

Definition at line 77 of file vtkButtonWidget.h.

Member Enumeration Documentation

enum vtkButtonWidget::_WidgetState

protected

Enumerator
Start
Hovering
Selecting

Definition at line 109 of file vtkButtonWidget.h.

Constructor & Destructor Documentation

vtkButtonWidget::vtkButtonWidget ( )

protected

vtkButtonWidget::~vtkButtonWidget ( )

inlineprotected

Definition at line 100 of file vtkButtonWidget.h.

Member Function Documentation

static vtkButtonWidget* vtkButtonWidget::New ( )

static

Instantiate the class.

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

static

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkAbstractWidget.

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

static

Standard macros.

virtual vtkObjectBase* vtkButtonWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard macros.

Reimplemented from vtkAbstractWidget.

vtkButtonWidget* vtkButtonWidget::NewInstance ( ) const

Standard macros.

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

virtual

Standard macros.

Reimplemented from vtkAbstractWidget.

void vtkButtonWidget::SetRepresentation ( vtkButtonRepresentation * 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 85 of file vtkButtonWidget.h.

vtkButtonRepresentation* vtkButtonWidget::GetSliderRepresentation ( )

inline

Return the representation as a vtkButtonRepresentation.

Definition at line 91 of file vtkButtonWidget.h.

void vtkButtonWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

static void vtkButtonWidget::SelectAction ( vtkAbstractWidget * )

staticprotected

static void vtkButtonWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

static void vtkButtonWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

Member Data Documentation

int vtkButtonWidget::WidgetState

protected

Definition at line 108 of file vtkButtonWidget.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkButtonWidget.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation