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

#include <vtkBorderWidget.h>

Inheritance diagram for vtkBorderWidget:

Collaboration diagram for vtkBorderWidget:

Public Member Functions
void	SetRepresentation (vtkBorderRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.

vtkBorderRepresentation *	GetBorderRepresentation ()
	Return the representation as a vtkBorderRepresentation.

void	CreateDefaultRepresentation () override
	Create the default widget representation if one is not set.

vtkTypeBool	GetProcessEvents () override
	Reimplement ProcessEvents to disable it when using relative location with windowLocation.


virtual void	SetSelectable (vtkTypeBool)
	Indicate whether the interior region of the widget can be selected or not.

virtual vtkTypeBool	GetSelectable ()
	Indicate whether the interior region of the widget can be selected or not.

virtual void	SelectableOn ()
	Indicate whether the interior region of the widget can be selected or not.

virtual void	SelectableOff ()
	Indicate whether the interior region of the widget can be selected or not.


virtual void	SetResizable (vtkTypeBool)
	Indicate whether the boundary of the widget can be resized.

virtual vtkTypeBool	GetResizable ()
	Indicate whether the boundary of the widget can be resized.

virtual void	ResizableOn ()
	Indicate whether the boundary of the widget can be resized.

virtual void	ResizableOff ()
	Indicate whether the boundary of the widget can be resized.

Public Member Functions inherited from vtkAbstractWidget
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 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.

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkBorderWidget *	New ()
	Method to instantiate class.

Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods.

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

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 (vtkTypeBool 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 vtkTypeBool	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.

Protected Types
enum	WidgetStateType { Start = 0 , Define , Manipulate , Selected }

Protected Member Functions
	vtkBorderWidget ()

	~vtkBorderWidget () override

virtual void	SelectRegion (double eventPos[2])
	Subclasses generally implement this method.

virtual int	SubclassSelectAction ()

virtual int	SubclassTranslateAction ()

virtual int	SubclassEndSelectAction ()

virtual int	SubclassMoveAction ()

void	SetCursor (int State) override

Protected Member Functions inherited from vtkAbstractWidget
	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 *)

virtual void	ObjectFinalize ()

	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 void	HoverLeaveAction (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)
	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
vtkTypeBool	Selectable

vtkTypeBool	Resizable

int	WidgetState

Protected Attributes inherited from vtkAbstractWidget
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

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

typedef vtkAbstractWidget	Superclass
	Standard methods for class.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for class.

static vtkBorderWidget *	SafeDownCast (vtkObjectBase *o)
	Standard methods for class.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for class.

vtkBorderWidget *	NewInstance () const
	Standard methods for class.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for class.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for class.

Additional Inherited Members
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods.

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

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

Online Examples:

Tests:: vtkBorderWidget (Tests)

Definition at line 136 of file vtkBorderWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractWidget vtkBorderWidget::Superclass

Standard methods for class.

Definition at line 148 of file vtkBorderWidget.h.

Member Enumeration Documentation

◆ WidgetStateType

enum vtkBorderWidget::WidgetStateType

protected

Enumerator
Start
Define
Manipulate
Selected

Definition at line 238 of file vtkBorderWidget.h.

Constructor & Destructor Documentation

◆ vtkBorderWidget()

vtkBorderWidget::vtkBorderWidget ( )

protected

◆ ~vtkBorderWidget()

vtkBorderWidget::~vtkBorderWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkBorderWidget * vtkBorderWidget::New ( )

static

Method to instantiate class.

◆ IsTypeOf()

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

static

Standard methods for class.

◆ IsA()

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

virtual

Standard methods for class.

Reimplemented from vtkAbstractWidget.

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

◆ SafeDownCast()

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

static

Standard methods for class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBorderWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for class.

Reimplemented from vtkAbstractWidget.

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

◆ NewInstance()

vtkBorderWidget * vtkBorderWidget::NewInstance ( ) const

Standard methods for class.

◆ PrintSelf()

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

overridevirtual

Standard methods for class.

Reimplemented from vtkAbstractWidget.

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

◆ SetSelectable()

virtual void vtkBorderWidget::SetSelectable ( vtkTypeBool )

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.

◆ GetSelectable()

virtual vtkTypeBool 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.

◆ SelectableOn()

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.

◆ SelectableOff()

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.

◆ SetResizable()

virtual void vtkBorderWidget::SetResizable ( vtkTypeBool )

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.

◆ GetResizable()

virtual vtkTypeBool 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.

◆ ResizableOn()

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.

◆ ResizableOff()

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.

◆ SetRepresentation()

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 180 of file vtkBorderWidget.h.

◆ GetBorderRepresentation()

vtkBorderRepresentation * vtkBorderWidget::GetBorderRepresentation ( )

inline

Return the representation as a vtkBorderRepresentation.

Definition at line 188 of file vtkBorderWidget.h.

◆ CreateDefaultRepresentation()

void vtkBorderWidget::CreateDefaultRepresentation ( )

overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

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

◆ GetProcessEvents()

vtkTypeBool vtkBorderWidget::GetProcessEvents ( )

overridevirtual

Reimplement ProcessEvents to disable it when using relative location with windowLocation.

When using exact location this override has no effect.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkScalarBarWidget.

◆ SelectRegion()

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.

◆ SelectAction()

static void vtkBorderWidget::SelectAction ( vtkAbstractWidget * )

staticprotected

◆ TranslateAction()

static void vtkBorderWidget::TranslateAction ( vtkAbstractWidget * )

staticprotected

◆ EndSelectAction()

static void vtkBorderWidget::EndSelectAction ( vtkAbstractWidget * )

staticprotected

◆ MoveAction()

static void vtkBorderWidget::MoveAction ( vtkAbstractWidget * )

staticprotected

◆ HoverLeaveAction()

static void vtkBorderWidget::HoverLeaveAction ( vtkAbstractWidget * )

staticprotected

◆ SubclassSelectAction()

virtual int vtkBorderWidget::SubclassSelectAction ( )

inlineprotectedvirtual

Definition at line 228 of file vtkBorderWidget.h.

◆ SubclassTranslateAction()

virtual int vtkBorderWidget::SubclassTranslateAction ( )

inlineprotectedvirtual

Definition at line 229 of file vtkBorderWidget.h.

◆ SubclassEndSelectAction()

virtual int vtkBorderWidget::SubclassEndSelectAction ( )

inlineprotectedvirtual

Definition at line 230 of file vtkBorderWidget.h.

◆ SubclassMoveAction()

virtual int vtkBorderWidget::SubclassMoveAction ( )

inlineprotectedvirtual

Definition at line 231 of file vtkBorderWidget.h.

◆ SetCursor()

void vtkBorderWidget::SetCursor ( int State )

overrideprotected

Member Data Documentation

◆ Selectable

vtkTypeBool vtkBorderWidget::Selectable

protected

Definition at line 216 of file vtkBorderWidget.h.

◆ Resizable

vtkTypeBool vtkBorderWidget::Resizable

protected

Definition at line 217 of file vtkBorderWidget.h.

◆ WidgetState

int vtkBorderWidget::WidgetState

protected

Definition at line 237 of file vtkBorderWidget.h.

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

Interaction/Widgets/vtkBorderWidget.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ WidgetStateType

Constructor & Destructor Documentation

◆ vtkBorderWidget()

◆ ~vtkBorderWidget()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSelectable()

◆ GetSelectable()

◆ SelectableOn()

◆ SelectableOff()

◆ SetResizable()

◆ GetResizable()

◆ ResizableOn()

◆ ResizableOff()

◆ SetRepresentation()

◆ GetBorderRepresentation()

◆ CreateDefaultRepresentation()

◆ GetProcessEvents()

◆ SelectRegion()

◆ SelectAction()

◆ TranslateAction()

◆ EndSelectAction()

◆ MoveAction()

◆ HoverLeaveAction()

◆ SubclassSelectAction()

◆ SubclassTranslateAction()

◆ SubclassEndSelectAction()

◆ SubclassMoveAction()

◆ SetCursor()

Member Data Documentation

◆ Selectable

◆ Resizable

◆ WidgetState