VTK
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkBorderWidget Class Reference

place a border around a 2D rectangular region More...

#include <vtkBorderWidget.h>

Inheritance diagram for vtkBorderWidget:
[legend]
Collaboration diagram for vtkBorderWidget:
[legend]

List of all members.

- Public Types inherited from vtkInteractorObserver - Public Types inherited from vtkObject

Public Member Functions

virtual void CreateDefaultRepresentation ()
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)
vtkBorderRepresentationGetBorderRepresentation ()
- 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 ()
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 vtkBorderWidgetNew ()
- 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 Types

enum  _WidgetState { Start = 0, Define, Manipulate, Selected }

Protected Member Functions

 vtkBorderWidget ()
 ~vtkBorderWidget ()
virtual void SelectRegion (double eventPos[2])
virtual int SubclassSelectAction ()
virtual int SubclassTranslateAction ()
virtual int SubclassEndSelectAction ()
virtual int SubclassMoveAction ()
virtual void SetCursor (int State)
- 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 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)
- Static Protected Member Functions inherited from vtkInteractorObserver
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes

int Selectable
int Resizable
int WidgetState
- 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
typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkBorderWidgetSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Additional Inherited Members


Detailed Description

place a border around a 2D rectangular region

This class is a superclass for 2D widgets that may require a rectangular border. Besides drawing a border, the widget provides methods for resizing and moving the rectangular region (and associated border). The widget provides methods and internal data members so that subclasses can take advantage of this widgets capabilities, requiring only that the subclass defines a "representation", i.e., some combination of props or actors that can be managed in the 2D rectangular region.

The class defines basic positioning functionality, including the ability to size the widget with locked x/y proportions. The area within the border may be made "selectable" as well, meaning that a selection event interior to the widget invokes a virtual SelectRegion() method, which can be used to pick objects or otherwise manipulate data interior to the widget.

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
 On the boundary of the widget:
   LeftButtonPressEvent - select boundary
   LeftButtonReleaseEvent - deselect boundary
   MouseMoveEvent - move/resize widget depending on which portion of the
                    boundary was selected.
 On the interior of the widget:
   LeftButtonPressEvent - invoke SelectButton() callback (if the ivar
                          Selectable is on)
 Anywhere on the widget:
   MiddleButtonPressEvent - move the widget
 
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBorderWidget's widget events:
   vtkWidgetEvent::Select – some part of the widget has been selected
   vtkWidgetEvent::EndSelect – the selection process has completed
   vtkWidgetEvent::Translate – the widget is to be translated
   vtkWidgetEvent::Move – a request for slider motion has been invoked
 
Event Bindings:
In turn, when these widget events are processed, this widget invokes the following VTK events on itself (which observers can listen for):
   vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
   vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
   vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
 
See also:
vtkInteractorObserver vtkCameraInterpolator
Events:
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::WidgetActivateEvent
Tests:
vtkBorderWidget (Tests)

Definition at line 86 of file vtkBorderWidget.h.


Member Typedef Documentation

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

Definition at line 94 of file vtkBorderWidget.h.


Member Enumeration Documentation

Enumerator:
Start 
Define 
Manipulate 
Selected 

Definition at line 168 of file vtkBorderWidget.h.


Constructor & Destructor Documentation

vtkBorderWidget::vtkBorderWidget ( )
protected
vtkBorderWidget::~vtkBorderWidget ( )
protected

Member Function Documentation

static vtkBorderWidget* vtkBorderWidget::New ( )
static

Method to instantiate class.

Reimplemented from vtkObject.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

virtual const char* vtkBorderWidget::GetClassName ( )
virtual

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkCameraWidget, vtkScalarBarWidget, vtkTextWidget, vtkLogoWidget, and vtkPlaybackWidget.

virtual void vtkBorderWidget::SetSelectable ( int  )
virtual

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

virtual int vtkBorderWidget::GetSelectable ( )
virtual

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

virtual void vtkBorderWidget::SelectableOn ( )
virtual

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

virtual void vtkBorderWidget::SelectableOff ( )
virtual

Indicate whether the interior region of the widget can be selected or not. If not, then events (such as left mouse down) allow the user to "move" the widget, and no selection is possible. Otherwise the SelectRegion() method is invoked.

virtual void vtkBorderWidget::SetResizable ( int  )
virtual

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual int vtkBorderWidget::GetResizable ( )
virtual

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual void vtkBorderWidget::ResizableOn ( )
virtual

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

virtual void vtkBorderWidget::ResizableOff ( )
virtual

Indicate whether the boundary of the widget can be resized. If not, the cursor will not change to "resize" type when mouse over the boundary.

void vtkBorderWidget::SetRepresentation ( vtkBorderRepresentation 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 123 of file vtkBorderWidget.h.

vtkBorderRepresentation* vtkBorderWidget::GetBorderRepresentation ( )
inline

Return the representation as a vtkBorderRepresentation.

Definition at line 129 of file vtkBorderWidget.h.

virtual void vtkBorderWidget::CreateDefaultRepresentation ( )
virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

Reimplemented in vtkCaptionWidget, vtkScalarBarWidget, vtkTextWidget, vtkCameraWidget, vtkLogoWidget, and vtkPlaybackWidget.

virtual void vtkBorderWidget::SelectRegion ( double  eventPos[2])
protectedvirtual

Subclasses generally implement this method. The SelectRegion() method offers a subclass the chance to do something special if the interior of the widget is selected.

Reimplemented in vtkCameraWidget, and vtkPlaybackWidget.

static void vtkBorderWidget::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkBorderWidget::TranslateAction ( vtkAbstractWidget )
staticprotected
static void vtkBorderWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkBorderWidget::MoveAction ( vtkAbstractWidget )
staticprotected

Reimplemented in vtkScalarBarWidget.

virtual int vtkBorderWidget::SubclassSelectAction ( )
inlineprotectedvirtual

Definition at line 157 of file vtkBorderWidget.h.

virtual int vtkBorderWidget::SubclassTranslateAction ( )
inlineprotectedvirtual

Definition at line 158 of file vtkBorderWidget.h.

virtual int vtkBorderWidget::SubclassEndSelectAction ( )
inlineprotectedvirtual

Definition at line 159 of file vtkBorderWidget.h.

virtual int vtkBorderWidget::SubclassMoveAction ( )
inlineprotectedvirtual

Definition at line 160 of file vtkBorderWidget.h.

virtual void vtkBorderWidget::SetCursor ( int  State)
protectedvirtual

Reimplemented in vtkScalarBarWidget.


Member Data Documentation

int vtkBorderWidget::Selectable
protected

Definition at line 146 of file vtkBorderWidget.h.

int vtkBorderWidget::Resizable
protected

Definition at line 147 of file vtkBorderWidget.h.

int vtkBorderWidget::WidgetState
protected

Definition at line 167 of file vtkBorderWidget.h.


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