VTK  9.1.20211015
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkInteractiveArea Class Reference

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

#include <vtkInteractiveArea.h>

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

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. More...
 
vtkInteractiveAreaNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Paint (vtkContext2D *painter) override
 vtkAbstractContextItem API More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Return true if the supplied x, y coordinate is inside the item. More...
 
bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta) override
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event. More...
 
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. More...
 
- Public Member Functions inherited from vtkContextArea
vtkContextAreaNewInstance () const
 
vtkAxisGetAxis (vtkAxis::Location location)
 Get the vtkAxis associated with the specified location. More...
 
vtkAbstractContextItemGetDrawAreaItem ()
 Returns the vtkAbstractContextItem that will draw in the clipped, transformed space. More...
 
virtual vtkRecti GetGeometry ()
 The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc. More...
 
virtual void SetGeometry (vtkRecti)
 The rect defining the pixel location and size of the entire vtkContextArea, including axis labels, title, etc. More...
 
virtual vtkRectd GetDrawAreaBounds ()
 The data bounds of the clipped and transformed area inside of the axes. More...
 
virtual void SetDrawAreaBounds (vtkRectd)
 The data bounds of the clipped and transformed area inside of the axes. More...
 
virtual DrawAreaResizeBehaviorType GetDrawAreaResizeBehavior ()
 Set the resize behavior for the draw area: More...
 
virtual void SetDrawAreaResizeBehavior (DrawAreaResizeBehaviorType)
 Set the resize behavior for the draw area: More...
 
virtual float GetFixedAspect ()
 The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect. More...
 
virtual void SetFixedAspect (float aspect)
 The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect. More...
 
virtual vtkRecti GetFixedRect ()
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
virtual void SetFixedRect (vtkRecti rect)
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
virtual void SetFixedRect (int x, int y, int width, int height)
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
virtual const MarginsGetFixedMargins ()
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
virtual void GetFixedMarginsArray (int margins[4])
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
virtual const int * GetFixedMarginsArray ()
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
virtual void SetFixedMargins (Margins margins)
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
virtual void SetFixedMargins (int margins[4])
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
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. More...
 
virtual bool GetFillViewport ()
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
virtual void SetFillViewport (bool)
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
virtual void FillViewportOn ()
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
virtual void FillViewportOff ()
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
virtual void SetShowGrid (bool show)
 Turn on/off grid visibility. More...
 
virtual bool GetShowGrid ()
 Turn on/off grid visibility. More...
 
virtual void ShowGridOn ()
 Turn on/off grid visibility. More...
 
virtual void ShowGridOff ()
 Turn on/off grid visibility. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). 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 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...
 
vtkCommandGetCommand (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 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractiveAreaSafeDownCast (vtkObjectBase *o)
 
static vtkInteractiveAreaNew ()
 
- Static Public Member Functions inherited from vtkContextArea
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextAreaSafeDownCast (vtkObjectBase *o)
 
static vtkContextAreaNew ()
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 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 vtkObjectBaseNew ()
 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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInteractiveArea ()
 
 ~vtkInteractiveArea () override
 
void SetAxisRange (vtkRectd const &data) override
 vtkContextArea API More...
 
- Protected Member Functions inherited from vtkContextArea
 vtkContextArea ()
 
 ~vtkContextArea () override
 
void LayoutAxes (vtkContext2D *painter)
 Sync the Axes locations with Geometry, and update the DrawAreaGeometry to account for Axes size (margins). More...
 
vtkRecti ComputeDrawAreaGeometry (vtkContext2D *painter)
 Return the draw area's geometry. More...
 
void UpdateDrawArea ()
 Set the transform to map DrawAreaBounds to DrawAreaGeometry. More...
 
virtual void InitializeDrawArea ()
 Initialize the drawing area's item hierarchy. More...
 
vtkRecti ComputeExpandedDrawAreaGeometry (vtkContext2D *painter)
 Working implementations for ComputeDrawAreaGeometry. More...
 
vtkRecti ComputeFixedAspectDrawAreaGeometry (vtkContext2D *painter)
 Working implementations for ComputeDrawAreaGeometry. More...
 
vtkRecti ComputeFixedRectDrawAreaGeometry (vtkContext2D *painter)
 Working implementations for ComputeDrawAreaGeometry. More...
 
vtkRecti ComputeFixedMarginsDrawAreaGeometry (vtkContext2D *painter)
 Working implementations for ComputeDrawAreaGeometry. More...
 
- Protected Member Functions inherited from vtkAbstractContextItem
 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. 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 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. More...
 
vtkNew< vtkPlotGridGrid
 The vtkPlotGrid that renders a grid atop the data in the draw area. More...
 
vtkNew< vtkContextClipClip
 The context item that clips rendered data. More...
 
vtkNew< vtkContextTransformTransform
 The context item that clips rendered data. More...
 
vtkRecti Geometry
 The rect defining the pixel location and size of the entire vtkContextArea, including axis label, title, etc. More...
 
vtkRectd DrawAreaBounds
 The data bounds of the clipped and transformed area inside of the axes. More...
 
vtkRecti DrawAreaGeometry
 The rect defining the pixel location and size of the clipped and transformed area inside the axes. More...
 
DrawAreaResizeBehaviorType DrawAreaResizeBehavior
 Controls how the draw area size is determined. More...
 
float FixedAspect
 The fixed aspect ratio, if DrawAreaResizeBehavior is FixedAspect. More...
 
vtkRecti FixedRect
 The fixed rect to use for the draw area, if DrawAreaResizeBehavior is FixedRect. More...
 
Margins FixedMargins
 The left, right, bottom, and top margins for the draw area, if DrawAreaResizeBehavior is FixedMargins. More...
 
bool FillViewport
 If true, Geometry is set to (0, 0, vpSize[0], vpSize[1]) at the start of each Paint call. More...
 
vtkNew< vtkAxisTopAxis
 
vtkNew< vtkAxisBottomAxis
 
vtkNew< vtkAxisLeftAxis
 
vtkNew< vtkAxisRightAxis
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- 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

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: