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 vtkInteractorObserver
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 ()
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 ()
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 vtkRenderWindowInteractor *	GetInteractor ()
virtual float	GetPriority ()
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
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)
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)
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 vtkScalarBarWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkScalarBarWidget *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkInteractorObserver
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 void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()

Protected Member Functions
	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))
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 &)

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 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	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
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

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

Return the representation as a vtkScalarBarRepresentation.

Definition at line 59 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

Reimplemented from vtkBorderWidget.

virtual void vtkScalarBarWidget::SetCursor ( int State )

protectedvirtual

Reimplemented from vtkBorderWidget.

Member Data Documentation

int vtkScalarBarWidget::Repositionable

protected

Definition at line 85 of file vtkScalarBarWidget.h.

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

dox/Widgets/vtkScalarBarWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation