vtkInteractiveArea Class Reference

Implements zooming and panning in a vtkContextArea. More...

#include <vtkInteractiveArea.h>

Inheritance diagram for vtkInteractiveArea:

Collaboration diagram for vtkInteractiveArea:

Public Types
typedef vtkContextArea	Superclass
Public Types inherited from vtkContextArea
enum	DrawAreaResizeBehaviorType { DARB_Expand , DARB_FixedAspect , DARB_FixedRect , DARB_FixedMargins }
typedef vtkTuple< int, 4 >	Margins
typedef vtkAbstractContextItem	Superclass
Public Types inherited from vtkAbstractContextItem
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.
vtkInteractiveArea *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	Paint (vtkContext2D *painter) override
	vtkAbstractContextItem API
bool	Hit (const vtkContextMouseEvent &mouse) override
	Return true if the supplied x, y coordinate is inside the item.
bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta) override
	Mouse wheel event, positive delta indicates forward movement of the wheel.
bool	MouseMoveEvent (const vtkContextMouseEvent &mouse) override
	Mouse move event.
bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
Public Member Functions inherited from vtkContextArea
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkContextArea *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkAxis *	GetAxis (vtkAxis::Location location)
	Get the vtkAxis associated with the specified location.
vtkAbstractContextItem *	GetDrawAreaItem ()
	Returns the vtkAbstractContextItem that will draw in the clipped, transformed space.
bool	Paint (vtkContext2D *painter) override
	Paint event for the item, called whenever the item needs to be drawn.
virtual vtkRecti	GetGeometry ()
	The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc.
virtual void	SetGeometry (vtkRecti)
	The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc.
virtual vtkRectd	GetDrawAreaBounds ()
	The data bounds of the clipped and transformed area inside of the axes.
virtual void	SetDrawAreaBounds (vtkRectd)
	The data bounds of the clipped and transformed area inside of the axes.
virtual DrawAreaResizeBehaviorType	GetDrawAreaResizeBehavior ()
	Set the resize behavior for the draw area:
virtual void	SetDrawAreaResizeBehavior (DrawAreaResizeBehaviorType)
	Set the resize behavior for the draw area:
virtual float	GetFixedAspect ()
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.
virtual void	SetFixedAspect (float aspect)
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.
virtual vtkRecti	GetFixedRect ()
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.
virtual void	SetFixedRect (vtkRecti rect)
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.
virtual void	SetFixedRect (int x, int y, int width, int height)
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.
virtual const Margins &	GetFixedMargins ()
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual void	GetFixedMarginsArray (int margins[4])
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual const int *	GetFixedMarginsArray ()
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual void	SetFixedMargins (Margins margins)
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual void	SetFixedMargins (int margins[4])
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual void	SetFixedMargins (int left, int right, int bottom, int top)
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
virtual bool	GetFillViewport ()
	If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.
virtual void	SetFillViewport (bool)
	If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.
virtual void	FillViewportOn ()
	If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.
virtual void	FillViewportOff ()
	If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.
virtual void	SetShowGrid (bool show)
	Turn on/off grid visibility.
virtual bool	GetShowGrid ()
	Turn on/off grid visibility.
virtual void	ShowGridOn ()
	Turn on/off grid visibility.
virtual void	ShowGridOff ()
	Turn on/off grid visibility.
Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractContextItem *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Update ()
	Perform any updates to the item that may be necessary before rendering.
virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn.
virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered.
virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item.
vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item.
bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item.
bool	RemoveItem (vtkIdType index)
	Remove child item from this item.
vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index.
vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex.
vtkIdType	GetNumberOfItems ()
	Get the number of child items.
void	ClearItems ()
	Remove all child items from this item.
vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack.
virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling.
vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack.
virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling.
virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item.
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse.
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event.
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event.
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event.
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event.
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event.
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel.
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event.
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event.
virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene.
vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene.
virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item.
vtkAbstractContextItem *	GetParent ()
	Get the parent item.
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system.
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system.
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system.
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system.
virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn).
virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn).
virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events).
virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events).
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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInteractiveArea *	SafeDownCast (vtkObjectBase *o)
static vtkInteractiveArea *	New ()
Static Public Member Functions inherited from vtkContextArea
static vtkTypeBool	IsTypeOf (const char *type)
static vtkContextArea *	SafeDownCast (vtkObjectBase *o)
static vtkContextArea *	New ()
Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInteractiveArea ()
	~vtkInteractiveArea () override
void	SetAxisRange (vtkRectd const &data) override
	vtkContextArea API
Protected Member Functions inherited from vtkContextArea
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkContextArea ()
	~vtkContextArea () override
void	LayoutAxes (vtkContext2D *painter)
	Sync the Axes locations with Geometry, and update the DrawAreaGeometry to account for Axes size (margins).
virtual void	SetAxisRange (vtkRectd const &data)
virtual void	ComputeViewTransform ()
vtkRecti	ComputeDrawAreaGeometry (vtkContext2D *painter)
	Return the draw area's geometry.
void	UpdateDrawArea ()
	Set the transform to map DrawAreaBounds to DrawAreaGeometry.
virtual void	InitializeDrawArea ()
	Initialize the drawing area's item hierarchy.
vtkRecti	ComputeExpandedDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.
vtkRecti	ComputeFixedAspectDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.
vtkRecti	ComputeFixedRectDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.
vtkRecti	ComputeFixedMarginsDrawAreaGeometry (vtkContext2D *painter)
	Working implementations for ComputeDrawAreaGeometry.
Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractContextItem ()
	~vtkAbstractContextItem () override
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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkContextArea
vtkTuple< vtkAxis *, 4 >	Axes
	vtkAxis objects that surround the draw area, indexed by vtkAxis::Location.
vtkNew< vtkPlotGrid >	Grid
	The vtkPlotGrid that renders a grid atop the data in the draw area.
vtkNew< vtkContextClip >	Clip
	The context item that clips rendered data.
vtkNew< vtkContextTransform >	Transform
	The context item that clips rendered data.
vtkRecti	Geometry
	The rect defining the pixel location and size of the entire vtkContextArea, including axis label, title, etc.
vtkRectd	DrawAreaBounds
	The data bounds of the clipped and transformed area inside of the axes.
vtkRecti	DrawAreaGeometry
	The rect defining the pixel location and size of the clipped and transformed area inside the axes.
DrawAreaResizeBehaviorType	DrawAreaResizeBehavior
	Controls how the draw area size is determined.
float	FixedAspect
	The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect.
vtkRecti	FixedRect
	The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect.
Margins	FixedMargins
	The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins.
bool	FillViewport
	If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call.
vtkNew< vtkAxis >	TopAxis
vtkNew< vtkAxis >	BottomAxis
vtkNew< vtkAxis >	LeftAxis
vtkNew< vtkAxis >	RightAxis
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null.
vtkAbstractContextItem *	Parent
	Point to the parent item - can be null.
vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc.
bool	Visible
	Store the visibility of the item (default is true).
bool	Interactive
	Store whether the item should respond to interactions (default is true).
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

Implements zooming and panning in a vtkContextArea.

Implements zooming and panning in a vtkContextArea.

Definition at line 33 of file vtkInteractiveArea.h.

Member Typedef Documentation

Superclass

typedef vtkContextArea vtkInteractiveArea::Superclass

Definition at line 36 of file vtkInteractiveArea.h.

Constructor & Destructor Documentation

vtkInteractiveArea()

vtkInteractiveArea::vtkInteractiveArea ( )

protected

~vtkInteractiveArea()

vtkInteractiveArea::~vtkInteractiveArea ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkInteractiveArea::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 vtkContextArea.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkInteractiveArea::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextArea.

NewInstance()

vtkInteractiveArea * vtkInteractiveArea::NewInstance

(

)

const

New()

static vtkInteractiveArea * vtkInteractiveArea::New ( )

static

PrintSelf()

void vtkInteractiveArea::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 vtkContextArea.

Paint()

bool vtkInteractiveArea::Paint ( vtkContext2D *  painter )

overridevirtual

vtkAbstractContextItem API

Reimplemented from vtkContextArea.

Hit()

bool vtkInteractiveArea::Hit ( const vtkContextMouseEvent &  mouse )

overridevirtual

Return true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

MouseWheelEvent()

bool vtkInteractiveArea::MouseWheelEvent ( const vtkContextMouseEvent &  mouse, int  delta  )

overridevirtual

Mouse wheel event, positive delta indicates forward movement of the wheel.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

MouseMoveEvent()

bool vtkInteractiveArea::MouseMoveEvent ( const vtkContextMouseEvent &  mouse )

overridevirtual

Mouse move event.

Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

MouseButtonPressEvent()

bool vtkInteractiveArea::MouseButtonPressEvent ( const vtkContextMouseEvent &  mouse )

overridevirtual

Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.

Reimplemented from vtkAbstractContextItem.

SetAxisRange()

void vtkInteractiveArea::SetAxisRange ( vtkRectd const &  data )

overrideprotectedvirtual

vtkContextArea API

Reimplemented from vtkContextArea.

---

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

• Charts/Core/vtkInteractiveArea.h