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

#include <vtkAbstractWidget.h>

Inheritance diagram for vtkAbstractWidget:

Collaboration diagram for vtkAbstractWidget:

Public Member Functions
void	SetEnabled (int) override
	Methods for activating this widget.

vtkWidgetEventTranslator *	GetEventTranslator ()
	Get the event translator.

virtual void	CreateDefaultRepresentation ()=0
	Create the default widget representation if one is not set.

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

void	SetParent (vtkAbstractWidget *parent)
	Specifying a parent to this widget is used when creating composite widgets.

virtual vtkAbstractWidget *	GetParent ()

void	SetPriority (float) override
	Override the superclass method.


virtual void	SetProcessEvents (vtkTypeBool)
	Methods to change whether the widget responds to interaction.

virtual vtkTypeBool	GetProcessEvents ()
	Methods to change whether the widget responds to interaction.

virtual void	ProcessEventsOn ()
	Methods to change whether the widget responds to interaction.

virtual void	ProcessEventsOff ()
	Methods to change whether the widget responds to interaction.


vtkWidgetRepresentation *	GetRepresentation ()
	Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.


virtual void	SetManagesCursor (vtkTypeBool)
	Turn on or off the management of the cursor.

virtual vtkTypeBool	GetManagesCursor ()
	Turn on or off the management of the cursor.

virtual void	ManagesCursorOn ()
	Turn on or off the management of the cursor.

virtual void	ManagesCursorOff ()
	Turn on or off the management of the cursor.

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Protected Member Functions
	vtkAbstractWidget ()

	~vtkAbstractWidget () override

void	SetWidgetRepresentation (vtkWidgetRepresentation *r)

virtual void	SetCursor (int vtkNotUsed(state))

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (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.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkWidgetRepresentation *	WidgetRep

vtkTypeBool	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

vtkTypeBool	ProcessEvents

int	LastDevice

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods.

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
	Standard macros implementing standard VTK methods.

virtual vtkTypeBool	IsA (const char *type)
	Standard macros implementing standard VTK methods.

vtkAbstractWidget *	NewInstance () const
	Standard macros implementing standard VTK methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard macros implementing standard VTK methods.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard macros implementing standard VTK methods.

Additional Inherited Members
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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

Events:: vtkCommand::DisableEvent vtkCommand::EnableEvent

Definition at line 65 of file vtkAbstractWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorObserver vtkAbstractWidget::Superclass

Standard macros implementing standard VTK methods.

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

Standard macros implementing standard VTK methods.

◆ IsA()

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

virtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkCompassWidget, vtkQWidgetWidget, vtkAffineWidget, vtkAngleWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkBorderWidget, vtkBoxWidget2, vtkButtonWidget, vtkCameraOrientationWidget, vtkCameraPathWidget, vtkCameraWidget, vtkCaptionWidget, vtkCenteredSliderWidget, vtkCheckerboardWidget, vtkContinuousValueWidget, vtkContourWidget, vtkDistanceWidget, vtkFinitePlaneWidget, vtkHandleWidget, vtkHoverWidget, vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2, vtkLightWidget, vtkLineWidget2, vtkLogoWidget, vtkMagnifierWidget, vtkParallelopipedWidget, vtkPlaybackWidget, vtkPointCloudWidget, vtkPolyLineWidget, vtkProgressBarWidget, vtkRectilinearWipeWidget, vtkResliceCursorWidget, vtkScalarBarWidget, vtkSeedWidget, vtkSliderWidget, vtkSphereWidget2, vtkSplineWidget2, vtkTensorProbeWidget, vtkTensorWidget, vtkTextWidget, vtkVRMenuWidget, and vtkVRPanelWidget.

◆ SafeDownCast()

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

static

Standard macros implementing standard VTK methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkInteractorObserver.

Reimplemented in vtkCompassWidget, vtkQWidgetWidget, vtkAffineWidget, vtkAngleWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkBorderWidget, vtkBoxWidget2, vtkButtonWidget, vtkCameraOrientationWidget, vtkCameraPathWidget, vtkCameraWidget, vtkCaptionWidget, vtkCenteredSliderWidget, vtkCheckerboardWidget, vtkContinuousValueWidget, vtkContourWidget, vtkDistanceWidget, vtkFinitePlaneWidget, vtkHandleWidget, vtkHoverWidget, vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2, vtkLightWidget, vtkLineWidget2, vtkLogoWidget, vtkMagnifierWidget, vtkParallelopipedWidget, vtkPlaybackWidget, vtkPointCloudWidget, vtkPolyLineWidget, vtkProgressBarWidget, vtkRectilinearWipeWidget, vtkResliceCursorWidget, vtkScalarBarWidget, vtkSeedWidget, vtkSliderWidget, vtkSphereWidget2, vtkSplineWidget2, vtkTensorProbeWidget, vtkTensorWidget, vtkTextWidget, vtkVRMenuWidget, and vtkVRPanelWidget.

◆ NewInstance()

vtkAbstractWidget * vtkAbstractWidget::NewInstance ( ) const

Standard macros implementing standard VTK methods.

◆ PrintSelf()

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

overridevirtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkObject.

Reimplemented in vtkAffineWidget, vtkAngleWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkBorderWidget, vtkBoxWidget2, vtkButtonWidget, vtkCameraOrientationWidget, vtkCameraPathWidget, vtkCameraWidget, vtkCaptionWidget, vtkCenteredSliderWidget, vtkCheckerboardWidget, vtkContinuousValueWidget, vtkContourWidget, vtkDistanceWidget, vtkFinitePlaneWidget, vtkHandleWidget, vtkHoverWidget, vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2, vtkLightWidget, vtkLineWidget2, vtkLogoWidget, vtkMagnifierWidget, vtkParallelopipedWidget, vtkPlaybackWidget, vtkPointCloudWidget, vtkPolyLineWidget, vtkProgressBarWidget, vtkRectilinearWipeWidget, vtkResliceCursorWidget, vtkScalarBarWidget, vtkSeedWidget, vtkSliderWidget, vtkSphereWidget2, vtkSplineWidget2, vtkTensorProbeWidget, vtkTensorWidget, vtkTextWidget, vtkVRMenuWidget, and vtkVRPanelWidget.

◆ 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 vtkAxesTransformWidget, vtkBoxWidget2, vtkCameraPathWidget, vtkCaptionWidget, vtkHandleWidget, vtkImplicitPlaneWidget2, vtkLineWidget2, vtkMagnifierWidget, vtkPointCloudWidget, vtkPolyLineWidget, vtkSphereWidget2, vtkSplineWidget2, vtkTensorWidget, vtkAffineWidget, vtkAngleWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkContourWidget, vtkDistanceWidget, vtkHoverWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, and vtkSeedWidget.

◆ 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 vtkAngleWidget, vtkAxesTransformWidget, vtkBiDimensionalWidget, vtkDistanceWidget, vtkLineWidget2, vtkParallelopipedWidget, and vtkSeedWidget.

◆ GetProcessEvents()

virtual vtkTypeBool vtkAbstractWidget::GetProcessEvents ( )

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 vtkTextWidget.

◆ ProcessEventsOn()

virtual void vtkAbstractWidget::ProcessEventsOn ( )

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.

◆ ProcessEventsOff()

virtual void vtkAbstractWidget::ProcessEventsOff ( )

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.

◆ 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 101 of file vtkAbstractWidget.h.

◆ CreateDefaultRepresentation()

virtual void vtkAbstractWidget::CreateDefaultRepresentation ( )

pure virtual

Create the default widget representation if one is not set.

The representation defines the geometry of the widget (i.e., how it appears) as well as providing special methods for manipulting the state and appearance of the widget.

Implemented in vtkCompassWidget, vtkQWidgetWidget, vtkAffineWidget, vtkAngleWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkBorderWidget, vtkBoxWidget2, vtkButtonWidget, vtkCameraOrientationWidget, vtkCameraPathWidget, vtkCameraWidget, vtkCaptionWidget, vtkCenteredSliderWidget, vtkCheckerboardWidget, vtkContourWidget, vtkDistanceWidget, vtkFinitePlaneWidget, vtkHandleWidget, vtkHoverWidget, vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2, vtkLightWidget, vtkLineWidget2, vtkLogoWidget, vtkMagnifierWidget, vtkParallelopipedWidget, vtkPlaybackWidget, vtkPointCloudWidget, vtkPolyLineWidget, vtkProgressBarWidget, vtkRectilinearWipeWidget, vtkResliceCursorWidget, vtkScalarBarWidget, vtkSeedWidget, vtkSliderWidget, vtkSphereWidget2, vtkSplineWidget2, vtkTensorProbeWidget, vtkTensorWidget, vtkTextWidget, vtkVRMenuWidget, and vtkVRPanelWidget.

◆ 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 125 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 135 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

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.

◆ ManagesCursorOn()

virtual void vtkAbstractWidget::ManagesCursorOn ( )

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.

◆ ManagesCursorOff()

virtual void vtkAbstractWidget::ManagesCursorOff ( )

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.

◆ 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 179 of file vtkAbstractWidget.h.

Member Data Documentation

◆ WidgetRep

vtkWidgetRepresentation* vtkAbstractWidget::WidgetRep

protected

Definition at line 175 of file vtkAbstractWidget.h.

◆ ManagesCursor

vtkTypeBool vtkAbstractWidget::ManagesCursor

protected

Definition at line 178 of file vtkAbstractWidget.h.

◆ EventTranslator

vtkWidgetEventTranslator* vtkAbstractWidget::EventTranslator

protected

Definition at line 182 of file vtkAbstractWidget.h.

◆ CallbackMapper

vtkWidgetCallbackMapper* vtkAbstractWidget::CallbackMapper

protected

Definition at line 183 of file vtkAbstractWidget.h.

◆ Parent

vtkAbstractWidget* vtkAbstractWidget::Parent

protected

Definition at line 186 of file vtkAbstractWidget.h.

◆ CallData

void* vtkAbstractWidget::CallData

protected

Definition at line 191 of file vtkAbstractWidget.h.

◆ ProcessEvents

vtkTypeBool vtkAbstractWidget::ProcessEvents

protected

Definition at line 195 of file vtkAbstractWidget.h.

◆ LastDevice

int vtkAbstractWidget::LastDevice

protected

Definition at line 200 of file vtkAbstractWidget.h.

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

Interaction/Widgets/vtkAbstractWidget.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractWidget()

◆ ~vtkAbstractWidget()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetEnabled()

◆ SetProcessEvents()

◆ GetProcessEvents()

◆ ProcessEventsOn()

◆ ProcessEventsOff()

◆ GetEventTranslator()

◆ CreateDefaultRepresentation()

◆ Render()

◆ SetParent()

◆ GetParent()

◆ GetRepresentation()

◆ SetManagesCursor()

◆ GetManagesCursor()

◆ ManagesCursorOn()

◆ ManagesCursorOff()

◆ SetPriority()

◆ ProcessEventsHandler()

◆ SetWidgetRepresentation()

◆ SetCursor()

Member Data Documentation

◆ WidgetRep

◆ ManagesCursor

◆ EventTranslator

◆ CallbackMapper

◆ Parent

◆ CallData

◆ ProcessEvents

◆ LastDevice