2D widget for manipulating a XY plot More...

#include <vtkXYPlotWidget.h>

Inheritance diagram for vtkXYPlotWidget:

Collaboration diagram for vtkXYPlotWidget:

Public Types
typedef vtkInteractorObserver	Superclass

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

vtkXYPlotWidget *	NewInstance () 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 turning the interactor observer on and off. More...


virtual void	SetXYPlotActor (vtkXYPlotActor *)
	Get the XY plot used by this Widget. More...

virtual vtkXYPlotActor *	GetXYPlotActor ()
	Get the XY plot used by this Widget. More...

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

vtkInteractorObserver *	NewInstance () const

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

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

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

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

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

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

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed. More...

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

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

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

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

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

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

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

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

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

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 ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

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

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

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

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer. 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 ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

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

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

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

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

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

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

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

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

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

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

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

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

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

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

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

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

Static Public Member Functions
static vtkXYPlotWidget *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXYPlotWidget *	SafeDownCast (vtkObjectBase *o)

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

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

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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

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 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). More...

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

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

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

Protected Types
enum	WidgetState { Moving = 0 , AdjustingP1 , AdjustingP2 , AdjustingP3 , AdjustingP4 , AdjustingE1 , AdjustingE2 , AdjustingE3 , AdjustingE4 , Inside , Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXYPlotWidget ()

	~vtkXYPlotWidget () override

void	OnLeftButtonDown ()

void	OnLeftButtonUp ()

void	OnMouseMove ()

int	ComputeStateBasedOnPosition (int X, int Y, int pos1, int pos2)

void	SetCursor (int State)

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

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

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

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

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

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

int	RequestCursorShape (int requestedShape)

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

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

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])
	Helper method for subclasses. More...

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 ()
	These methods allow a command to exclusively grab all events. More...

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkXYPlotActor *	XYPlotActor

float	StartPosition [2]

int	State

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

Detailed Description

2D widget for manipulating a XY plot

This class provides support for interactively manipulating the position, size, and orientation of a XY Plot. It listens to Left mouse events and mouse movement. It will change the cursor shape based on its location. If the cursor is over an edge of thea XY plot it will change the cursor shape to a resize edge shape. If the position of a XY plot is moved to be close to the center of one of the four edges of the viewport, then the XY plot will change its orientation to align with that edge. This orientation is sticky in that it will stay that orientation until the position is moved close to another edge.

See also: vtkInteractorObserver

Definition at line 40 of file vtkXYPlotWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorObserver vtkXYPlotWidget::Superclass

Definition at line 44 of file vtkXYPlotWidget.h.

Member Enumeration Documentation

◆ WidgetState

enum vtkXYPlotWidget::WidgetState

protected

Enumerator
Moving
AdjustingP1
AdjustingP2
AdjustingP3
AdjustingP4
AdjustingE1
AdjustingE2
AdjustingE3
AdjustingE4
Inside
Outside

Definition at line 81 of file vtkXYPlotWidget.h.

Constructor & Destructor Documentation

◆ vtkXYPlotWidget()

vtkXYPlotWidget::vtkXYPlotWidget ( )

protected

◆ ~vtkXYPlotWidget()

vtkXYPlotWidget::~vtkXYPlotWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkXYPlotWidget * vtkXYPlotWidget::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorObserver.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXYPlotWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorObserver.

◆ NewInstance()

vtkXYPlotWidget * vtkXYPlotWidget::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetXYPlotActor()

virtual void vtkXYPlotWidget::SetXYPlotActor ( vtkXYPlotActor * )

virtual

Get the XY plot used by this Widget.

One is created automatically.

◆ GetXYPlotActor()

virtual vtkXYPlotActor * vtkXYPlotWidget::GetXYPlotActor ( )

virtual

Get the XY plot used by this Widget.

One is created automatically.

◆ SetEnabled()

void vtkXYPlotWidget::SetEnabled ( int )

overridevirtual

Methods for turning the interactor observer on and off.

Reimplemented from vtkInteractorObserver.

◆ ProcessEvents()

static void vtkXYPlotWidget::ProcessEvents	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)

staticprotected

◆ OnLeftButtonDown()

void vtkXYPlotWidget::OnLeftButtonDown ( )

protected

◆ OnLeftButtonUp()

void vtkXYPlotWidget::OnLeftButtonUp ( )

protected

◆ OnMouseMove()

void vtkXYPlotWidget::OnMouseMove ( )

protected

◆ ComputeStateBasedOnPosition()

int vtkXYPlotWidget::ComputeStateBasedOnPosition	(	int	X,
		int	Y,
		int *	pos1,
		int *	pos2
	)

protected

◆ SetCursor()

void vtkXYPlotWidget::SetCursor ( int State )

protected

Member Data Documentation

◆ XYPlotActor

vtkXYPlotActor* vtkXYPlotWidget::XYPlotActor

protected

Definition at line 65 of file vtkXYPlotWidget.h.

◆ StartPosition

float vtkXYPlotWidget::StartPosition[2]

protected

Definition at line 77 of file vtkXYPlotWidget.h.

◆ State

int vtkXYPlotWidget::State

protected

Definition at line 80 of file vtkXYPlotWidget.h.

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

Interaction/Widgets/vtkXYPlotWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ WidgetState

Constructor & Destructor Documentation

◆ vtkXYPlotWidget()

◆ ~vtkXYPlotWidget()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetXYPlotActor()

◆ GetXYPlotActor()

◆ SetEnabled()

◆ ProcessEvents()

◆ OnLeftButtonDown()

◆ OnLeftButtonUp()

◆ OnMouseMove()

◆ ComputeStateBasedOnPosition()

◆ SetCursor()

Member Data Documentation

◆ XYPlotActor

◆ StartPosition

◆ State