vtkScalarBarWidget Class Reference

#include <vtkScalarBarWidget.h>

Inheritance diagram for vtkScalarBarWidget:

[legend]

Collaboration diagram for vtkScalarBarWidget:

[legend]

List of all members.

---

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 45 of file vtkScalarBarWidget.h.

Public Types
typedef vtkBorderWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetRepresentation (vtkScalarBarRepresentation *rep)
vtkScalarBarRepresentation *	GetScalarBarRepresentation ()
virtual void	CreateDefaultRepresentation ()
virtual void	SetScalarBarActor (vtkScalarBarActor *actor)
virtual vtkScalarBarActor *	GetScalarBarActor ()
virtual void	SetRepositionable (int)
virtual int	GetRepositionable ()
virtual void	RepositionableOn ()
virtual void	RepositionableOff ()
Static Public Member Functions
static vtkScalarBarWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkScalarBarWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkScalarBarWidget ()
	~vtkScalarBarWidget ()
virtual void	SetCursor (int State)
Static Protected Member Functions
static void	MoveAction (vtkAbstractWidget *)
Protected Attributes
int	Repositionable

---

Member Typedef Documentation

typedef vtkBorderWidget vtkScalarBarWidget::Superclass

Standard methods for class.

Reimplemented from vtkBorderWidget.

Definition at line 49 of file vtkScalarBarWidget.h.

---

Constructor & Destructor Documentation

vtkScalarBarWidget::vtkScalarBarWidget

(

)

[protected]

vtkScalarBarWidget::~vtkScalarBarWidget

(

)

[protected]

---

Member Function Documentation

static vtkScalarBarWidget* vtkScalarBarWidget::New

(

)

[static]

Method to instantiate class.

Reimplemented from vtkBorderWidget.

virtual const char* vtkScalarBarWidget::GetClassName

(

)

[virtual]

Standard methods for class.

Reimplemented from vtkBorderWidget.

static int vtkScalarBarWidget::IsTypeOf

(

const char *

type

)

[static]

Standard methods for class.

Reimplemented from vtkBorderWidget.

virtual int vtkScalarBarWidget::IsA

(

const char *

type

)

[virtual]

Standard methods for class.

Reimplemented from vtkBorderWidget.

static vtkScalarBarWidget* vtkScalarBarWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Standard methods for class.

Reimplemented from vtkBorderWidget.

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

Standard methods for class.

Reimplemented from vtkBorderWidget.

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]

Definition at line 57 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 *

)

[static, protected]

Reimplemented from vtkBorderWidget.

virtual void vtkScalarBarWidget::SetCursor

(

int

State

)

[protected, virtual]

Reimplemented from vtkBorderWidget.

---

Member Data Documentation

int vtkScalarBarWidget::Repositionable [protected]

Definition at line 82 of file vtkScalarBarWidget.h.

---

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

• dox/Widgets/vtkScalarBarWidget.h