vtkScalarBarWidget Class Reference

2D widget for manipulating a scalar bar More...

#include <vtkScalarBarWidget.h>

Inheritance diagram for vtkScalarBarWidget:

Collaboration diagram for vtkScalarBarWidget:

Public Types
typedef vtkBorderWidget	Superclass
Public Types inherited from vtkBorderWidget
typedef vtkAbstractWidget	Superclass
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkScalarBarWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetRepresentation (vtkScalarBarRepresentation *rep)
virtual void	CreateDefaultRepresentation ()
vtkScalarBarRepresentation *	GetScalarBarRepresentation ()
virtual void	SetScalarBarActor (vtkScalarBarActor *actor)
virtual vtkScalarBarActor *	GetScalarBarActor ()
virtual void	SetRepositionable (int)
virtual int	GetRepositionable ()
virtual void	RepositionableOn ()
virtual void	RepositionableOff ()
Public Member Functions inherited from vtkBorderWidget
virtual void	SetSelectable (int)
virtual int	GetSelectable ()
virtual void	SelectableOn ()
virtual void	SelectableOff ()
virtual void	SetResizable (int)
virtual int	GetResizable ()
virtual void	ResizableOn ()
virtual void	ResizableOff ()
void	SetRepresentation (vtkBorderRepresentation *r)
vtkBorderRepresentation *	GetBorderRepresentation ()
vtkBorderWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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
void	PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions
static vtkScalarBarWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkScalarBarWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkBorderWidget
static vtkBorderWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkBorderWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScalarBarWidget ()
	~vtkScalarBarWidget ()
virtual void	SetCursor (int State)
Protected Member Functions inherited from vtkBorderWidget
	vtkBorderWidget ()
	~vtkBorderWidget ()
virtual void	SelectRegion (double eventPos[2])
virtual int	SubclassSelectAction ()
virtual int	SubclassTranslateAction ()
virtual int	SubclassEndSelectAction ()
virtual int	SubclassMoveAction ()
Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()
	~vtkAbstractWidget ()
void	SetWidgetRepresentation (vtkWidgetRepresentation *r)
virtual void	SetCursor (int vtkNotUsed(state))

Static Protected Member Functions
static void	MoveAction (vtkAbstractWidget *)
Static Protected Member Functions inherited from vtkBorderWidget
static void	SelectAction (vtkAbstractWidget *)
static void	TranslateAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
Static Protected Member Functions inherited from vtkAbstractWidget
static void	ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes
int	Repositionable
Protected Attributes inherited from vtkBorderWidget
int	Selectable
int	Resizable
int	WidgetState
Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep
int	ManagesCursor
vtkWidgetEventTranslator *	EventTranslator
vtkWidgetCallbackMapper *	CallbackMapper
vtkAbstractWidget *	Parent
void *	CallData
int	ProcessEvents

Additional Inherited Members
Protected Types inherited from vtkBorderWidget
enum	_WidgetState { Start =0, Define, Manipulate, Selected }

Detailed Description

2D widget for manipulating a scalar bar

This class provides support for interactively manipulating the position, size, and orientation of a scalar bar. It listens to Left mouse events and mouse movement. It also listens to Right mouse events and notifies any observers of Right mouse events on this object when they occur. It will change the cursor shape based on its location. If the cursor is over an edge of the scalar bar it will change the cursor shape to a resize edge shape. If the position of a scalar bar is moved to be close to the center of one of the four edges of the viewport, then the scalar bar will change its orientation to align with that edge. This orientation is sticky in that it will stay that orientation until the position is moved close to another edge.

See Also

vtkInteractorObserver

Tests:

vtkScalarBarWidget (Tests)

Definition at line 46 of file vtkScalarBarWidget.h.

Member Typedef Documentation

typedef vtkBorderWidget vtkScalarBarWidget::Superclass

Definition at line 50 of file vtkScalarBarWidget.h.

Constructor & Destructor Documentation

vtkScalarBarWidget::vtkScalarBarWidget ( )

protected

vtkScalarBarWidget::~vtkScalarBarWidget ( )

protected

Member Function Documentation

static vtkScalarBarWidget* vtkScalarBarWidget::New ( )

static

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

static

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

virtual

Standard methods for class.

Reimplemented from vtkBorderWidget.

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

static

virtual vtkObjectBase* vtkScalarBarWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for class.

Reimplemented from vtkBorderWidget.

vtkScalarBarWidget* vtkScalarBarWidget::NewInstance

(

)

const

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

virtual void vtkScalarBarWidget::SetRepresentation ( vtkScalarBarRepresentation *  rep )

virtual

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.

vtkScalarBarRepresentation* vtkScalarBarWidget::GetScalarBarRepresentation ( )

inline

Return the representation as a vtkScalarBarRepresentation.

Definition at line 60 of file vtkScalarBarWidget.h.

virtual void vtkScalarBarWidget::SetScalarBarActor ( vtkScalarBarActor *  actor )

virtual

Get the ScalarBar used by this Widget. One is created automatically.

virtual vtkScalarBarActor* vtkScalarBarWidget::GetScalarBarActor ( )

virtual

Get the ScalarBar used by this Widget. One is created automatically.

virtual void vtkScalarBarWidget::SetRepositionable ( int  )

virtual

Can the widget be moved. On by default. If off, the widget cannot be moved around. TODO: This functionality should probably be moved to the superclass.

virtual int vtkScalarBarWidget::GetRepositionable ( )

virtual

Can the widget be moved. On by default. If off, the widget cannot be moved around. TODO: This functionality should probably be moved to the superclass.

virtual void vtkScalarBarWidget::RepositionableOn ( )

virtual

Can the widget be moved. On by default. If off, the widget cannot be moved around. TODO: This functionality should probably be moved to the superclass.

virtual void vtkScalarBarWidget::RepositionableOff ( )

virtual

Can the widget be moved. On by default. If off, the widget cannot be moved around. TODO: This functionality should probably be moved to the superclass.

virtual void vtkScalarBarWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Reimplemented from vtkBorderWidget.

static void vtkScalarBarWidget::MoveAction ( vtkAbstractWidget *  )

staticprotected

virtual void vtkScalarBarWidget::SetCursor ( int  State )

protectedvirtual

Reimplemented from vtkBorderWidget.

Member Data Documentation

int vtkScalarBarWidget::Repositionable

protected

Definition at line 86 of file vtkScalarBarWidget.h.

---

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

• dox/Interaction/Widgets/vtkScalarBarWidget.h