VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkAbstractWidget Class Referenceabstract

define the API for widget / widget representation More...

#include <vtkAbstractWidget.h>

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

Public Types

typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
 
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAbstractWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEnabled (int) override
 Methods for activating this widget. More...
 
virtual void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction. More...
 
virtual vtkTypeBool GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. More...
 
virtual void CreateDefaultRepresentation ()=0
 Create the default widget representation if one is not set. More...
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets. More...
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor. More...
 
virtual vtkTypeBool GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 
virtual void OnChar ()
 Sets up the keypress-i event. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
 
int RequestCursorShape (int requestedShape)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 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)
 Handles the char widget activation event. More...
 

Protected Attributes

vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

define the API for widget / widget representation

The vtkAbstractWidget defines an API and implements methods common to all widgets using the interaction/representation design. In this design, the term interaction means that part of the widget that performs event handling, while the representation corresponds to a vtkProp (or the subclass vtkWidgetRepresentation) used to represent the widget. vtkAbstractWidget also implements some methods common to all subclasses.

Note that vtkAbstractWidget provides access to the vtkWidgetEventTranslator. This class is responsible for translating VTK events (defined in vtkCommand.h) into widget events (defined in vtkWidgetEvent.h). This class can be manipulated so that different VTK events can be mapped into widget events, thereby allowing the modification of event bindings. Each subclass of vtkAbstractWidget defines the events to which it responds.

Warning
Note that the pair ( vtkAbstractWidget / vtkWidgetRepresentation ) is an implementation of the second generation VTK Widgets design. In the first generation design, widgets were implemented in a single monolithic class. This design was problematic because in client-server application it was difficult to manage widgets properly. Also, new "representations" or look-and-feel, for a widget required a whole new class, with a lot of redundant code. The separation of the widget event handling and representation enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).
See also
vtkWidgetRepresentation vtkWidgetEventTranslator vtkWidgetCallbackMapper

Definition at line 62 of file vtkAbstractWidget.h.

Member Typedef Documentation

◆ Superclass

Standard macros implementing standard VTK methods.

Definition at line 69 of file vtkAbstractWidget.h.

Constructor & Destructor Documentation

◆ vtkAbstractWidget()

vtkAbstractWidget::vtkAbstractWidget ( )
protected

◆ ~vtkAbstractWidget()

vtkAbstractWidget::~vtkAbstractWidget ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkAbstractWidget::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkAbstractWidget::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractWidget::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractWidget* vtkAbstractWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ SetEnabled()

void vtkAbstractWidget::SetEnabled ( int  )
overridevirtual

Methods for activating this widget.

Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkContourWidget, vtkBiDimensionalWidget, vtkAffineWidget, vtkButtonWidget, vtkHoverWidget, vtkBalloonWidget, vtkAngleWidget, vtkSeedWidget, vtkDistanceWidget, vtkResliceCursorWidget, vtkCheckerboardWidget, vtkParallelopipedWidget, vtkHandleWidget, vtkBoxWidget2, vtkSphereWidget2, vtkImplicitPlaneWidget2, vtkLineWidget2, vtkAxesTransformWidget, vtkPolyLineWidget, vtkCaptionWidget, and vtkSplineWidget2.

◆ SetProcessEvents()

virtual void vtkAbstractWidget::SetProcessEvents ( vtkTypeBool  )
virtual

Methods to change whether the widget responds to interaction.

Set this to Off to disable interaction. On by default. Subclasses must override SetProcessEvents() to make sure that they pass on the flag to all component widgets.

Reimplemented in vtkBiDimensionalWidget, vtkSeedWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkAngleWidget, vtkDistanceWidget, and vtkParallelopipedWidget.

◆ GetProcessEvents()

virtual vtkTypeBool vtkAbstractWidget::GetProcessEvents ( )
virtual

◆ ProcessEventsOn()

virtual void vtkAbstractWidget::ProcessEventsOn ( )
virtual

◆ ProcessEventsOff()

virtual void vtkAbstractWidget::ProcessEventsOff ( )
virtual

◆ GetEventTranslator()

vtkWidgetEventTranslator* vtkAbstractWidget::GetEventTranslator ( )
inline

Get the event translator.

Careful manipulation of this class enables the user to override the default event bindings.

Definition at line 98 of file vtkAbstractWidget.h.

◆ CreateDefaultRepresentation()

virtual void vtkAbstractWidget::CreateDefaultRepresentation ( )
pure virtual

◆ Render()

void vtkAbstractWidget::Render ( )

This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.

This method should be called (instead of vtkRenderWindow::Render() because it has built into it optimizations for minimizing renders and/or speeding renders.

◆ SetParent()

void vtkAbstractWidget::SetParent ( vtkAbstractWidget parent)
inline

Specifying a parent to this widget is used when creating composite widgets.

It is an internal method not meant to be used by the public. When a widget has a parent, it defers the rendering to the parent. It may also defer managing the cursor (see ManagesCursor ivar).

Definition at line 122 of file vtkAbstractWidget.h.

◆ GetParent()

virtual vtkAbstractWidget* vtkAbstractWidget::GetParent ( )
virtual

◆ GetRepresentation()

vtkWidgetRepresentation* vtkAbstractWidget::GetRepresentation ( )
inline

Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.

Note that the representation is a subclass of vtkProp (typically a subclass of vtkWidgetRepresentation) so it can be added to the renderer independent of the widget.

Definition at line 132 of file vtkAbstractWidget.h.

◆ SetManagesCursor()

virtual void vtkAbstractWidget::SetManagesCursor ( vtkTypeBool  )
virtual

Turn on or off the management of the cursor.

Cursor management is typically disabled for subclasses when composite widgets are created. For example, vtkHandleWidgets are often used to create composite widgets, and the parent widget takes over the cursor management.

◆ GetManagesCursor()

virtual vtkTypeBool vtkAbstractWidget::GetManagesCursor ( )
virtual

◆ ManagesCursorOn()

virtual void vtkAbstractWidget::ManagesCursorOn ( )
virtual

◆ ManagesCursorOff()

virtual void vtkAbstractWidget::ManagesCursorOff ( )
virtual

◆ SetPriority()

void vtkAbstractWidget::SetPriority ( float  )
overridevirtual

Override the superclass method.

This will automatically change the priority of the widget. Unlike the superclass documentation, no methods such as SetInteractor to null and reset it etc. are necessary

Reimplemented from vtkInteractorObserver.

◆ ProcessEventsHandler()

static void vtkAbstractWidget::ProcessEventsHandler ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

◆ SetWidgetRepresentation()

void vtkAbstractWidget::SetWidgetRepresentation ( vtkWidgetRepresentation r)
protected

◆ SetCursor()

virtual void vtkAbstractWidget::SetCursor ( int   vtkNotUsedstate)
inlineprotectedvirtual

Definition at line 176 of file vtkAbstractWidget.h.

Member Data Documentation

◆ WidgetRep

vtkWidgetRepresentation* vtkAbstractWidget::WidgetRep
protected

Definition at line 172 of file vtkAbstractWidget.h.

◆ ManagesCursor

vtkTypeBool vtkAbstractWidget::ManagesCursor
protected

Definition at line 175 of file vtkAbstractWidget.h.

◆ EventTranslator

vtkWidgetEventTranslator* vtkAbstractWidget::EventTranslator
protected

Definition at line 179 of file vtkAbstractWidget.h.

◆ CallbackMapper

vtkWidgetCallbackMapper* vtkAbstractWidget::CallbackMapper
protected

Definition at line 180 of file vtkAbstractWidget.h.

◆ Parent

vtkAbstractWidget* vtkAbstractWidget::Parent
protected

Definition at line 183 of file vtkAbstractWidget.h.

◆ CallData

void* vtkAbstractWidget::CallData
protected

Definition at line 188 of file vtkAbstractWidget.h.

◆ ProcessEvents

vtkTypeBool vtkAbstractWidget::ProcessEvents
protected

Definition at line 192 of file vtkAbstractWidget.h.


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