VTK  9.0.20210926
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPlotBarRangeHandlesItem Class Reference

show and control the range of a vtkAxis used with a vtkPlotBar More...

#include <vtkPlotBarRangeHandlesItem.h>

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

Public Types

typedef vtkPlotRangeHandlesItem Superclass
 
- Public Types inherited from vtkPlotRangeHandlesItem
enum  Handle { NO_HANDLE = -1, LEFT_HANDLE = 0, RIGHT_HANDLE = 1 }
 
enum  Orientation { VERTICAL = 0, HORIZONTAL = 1 }
 
typedef vtkPlot Superclass
 
- Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
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...
 
vtkPlotBarRangeHandlesItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetBounds (double bounds[4]) override
 Recover the bounds of the item. More...
 
 vtkSetSmartPointerMacro (PlotBar, vtkPlotBar)
 Get/Set the plot bar object to work with. More...
 
 vtkGetSmartPointerMacro (PlotBar, vtkPlotBar)
 
- Public Member Functions inherited from vtkPlotRangeHandlesItem
vtkPlotRangeHandlesItemNewInstance () 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
 Paint both handles and the range if a handle is active or hovered. More...
 
void GetBounds (double bounds[4]) override
 Recover the bounds of the item. More...
 
virtual void GetHandlesRange (double range[2])
 Recover the range currently set by the handles Use this method by observing EndInteractionEvent. More...
 
virtual vtkBrushGetHighlightBrush ()
 Return the brush used to paint handles being hovered. More...
 
virtual void ComputeHandlesDrawRange ()
 Compute the handles draw range by using the handle width and the transfer function. More...
 
virtual void SetHandleWidth (float)
 Set/Get the handles width in pixels. More...
 
virtual float GetHandleWidth ()
 Set/Get the handles width in pixels. More...
 
virtual void SetHandleOrientation (int)
 Set/Get the handles orientation in the plot. More...
 
virtual int GetHandleOrientation ()
 Set/Get the handles orientation in the plot. More...
 
void SetHandleOrientationToVertical ()
 Set/Get the handles orientation in the plot. More...
 
void SetHandleOrientationToHorizontal ()
 Set/Get the handles orientation in the plot. More...
 
virtual void SetExtent (double, double, double, double)
 Set/Get the extent of the handles in data space (axis unscaled range). More...
 
virtual void SetExtent (double[4])
 Set/Get the extent of the handles in data space (axis unscaled range). More...
 
virtual double * GetExtent ()
 Set/Get the extent of the handles in data space (axis unscaled range). More...
 
virtual void GetExtent (double &, double &, double &, double &)
 Set/Get the extent of the handles in data space (axis unscaled range). More...
 
virtual void GetExtent (double[4])
 Set/Get the extent of the handles in data space (axis unscaled range). More...
 
virtual void SetExtentToAxisRange (vtkTypeBool)
 Set/Get whether handles span the range of the axis. More...
 
virtual vtkTypeBool GetExtentToAxisRange ()
 Set/Get whether handles span the range of the axis. More...
 
virtual void ExtentToAxisRangeOn ()
 Set/Get whether handles span the range of the axis. More...
 
virtual void ExtentToAxisRangeOff ()
 Set/Get whether handles span the range of the axis. More...
 
virtual void SetSynchronizeRangeHandles (vtkTypeBool)
 Set/Get whether handles move together when one of them is update. More...
 
virtual vtkTypeBool GetSynchronizeRangeHandles ()
 Set/Get whether handles move together when one of them is update. More...
 
virtual void SynchronizeRangeHandlesOn ()
 Set/Get whether handles move together when one of them is update. More...
 
virtual void SynchronizeRangeHandlesOff ()
 Set/Get whether handles move together when one of them is update. More...
 
virtual void SetLockTooltipToMouse (vtkTypeBool)
 If On, the range tooltip is always rendered using mouse position, otherwise it is placed at the center of the x axis Default is On. More...
 
virtual vtkTypeBool GetLockTooltipToMouse ()
 If On, the range tooltip is always rendered using mouse position, otherwise it is placed at the center of the x axis Default is On. More...
 
virtual void LockTooltipToMouseOn ()
 If On, the range tooltip is always rendered using mouse position, otherwise it is placed at the center of the x axis Default is On. More...
 
virtual void LockTooltipToMouseOff ()
 If On, the range tooltip is always rendered using mouse position, otherwise it is placed at the center of the x axis Default is On. More...
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn. More...
 
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 Function to query a plot for the nearest point to the specified coordinate. More...
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 Select all points in the specified rectangle. More...
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 Select all points in the specified polygon. More...
 
virtual void SetWidth (float width)
 Set the width of the line. More...
 
virtual float GetWidth ()
 Get the width of the line. More...
 
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot. More...
 
virtual vtkStdString GetLabel ()
 Get the label of this plot. More...
 
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index. More...
 
virtual vtkStringArrayGetLabels ()
 Get the plot labels. More...
 
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot. More...
 
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index. More...
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot. More...
 
virtual vtkStringArrayGetIndexedLabels ()
 Get the indexed labels array. More...
 
vtkContextMapper2DGetData ()
 Get the data object that the plot will draw. More...
 
virtual vtkTableGetInput ()
 Get the input table used by the plot. More...
 
virtual void SetInputArray (int index, const vtkStdString &name)
 Convenience function to set the input arrays. More...
 
virtual void GetUnscaledInputBounds (double bounds[4])
 Provide un-log-scaled bounds for the plot inputs. More...
 
virtual void UpdateCache ()
 Subclasses that build data caches to speed up painting should override this method to update such caches. More...
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend. More...
 
virtual bool GetLegendVisibility ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOn ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void LegendVisibilityOff ()
 Set whether the plot renders an entry in the legend. More...
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual vtkStdString GetTooltipLabelFormat ()
 Sets/gets a printf-style string to build custom tooltip labels from. More...
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style. More...
 
virtual int GetTooltipNotation ()
 Sets/gets the tooltip notation style. More...
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision. More...
 
virtual int GetTooltipPrecision ()
 Sets/gets the tooltip precision. More...
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color. More...
 
virtual void SetColor (double r, double g, double b)
 Set the plot color. More...
 
virtual void GetColor (double rgb[3])
 Set the plot color. More...
 
void GetColor (unsigned char rgb[3])
 Set the plot color. More...
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
vtkPenGetPen ()
 Set/get the vtkPen object that controls how this plot draws (out)lines. More...
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
vtkBrushGetBrush ()
 Set/get the vtkBrush object that controls how this plot fills shapes. More...
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkPenGetSelectionPen ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
vtkBrushGetSelectionBrush ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes. More...
 
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value. More...
 
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value. More...
 
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 This is a convenience function to set the input table and the x, y column for the plot. More...
 
virtual void SetSelectable (bool)
 Set whether the plot can be selected. More...
 
virtual bool GetSelectable ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOn ()
 Set whether the plot can be selected. More...
 
virtual void SelectableOff ()
 Set whether the plot can be selected. More...
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected. More...
 
virtual vtkIdTypeArrayGetSelection ()
 Sets the list of points that must be selected. More...
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot. More...
 
virtual void SetXAxis (vtkAxis *axis)
 Get/set the X axis associated with this plot. More...
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot. More...
 
virtual void SetYAxis (vtkAxis *axis)
 Get/set the Y axis associated with this plot. More...
 
void SetShiftScale (const vtkRectd &shiftScale)
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
vtkRectd GetShiftScale ()
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range. More...
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden. More...
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 A General setter/getter that should be overridden. More...
 
virtual bool ClampPos (double pos[2])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTransform (vtkContextTransform *)
 Set the transform of the item. More...
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
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 MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. 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 vtkPlotBarRangeHandlesItemSafeDownCast (vtkObjectBase *o)
 
static vtkPlotBarRangeHandlesItemNew ()
 
- Static Public Member Functions inherited from vtkPlotRangeHandlesItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotRangeHandlesItemSafeDownCast (vtkObjectBase *o)
 
static vtkPlotRangeHandlesItemNew ()
 
- Static Public Member Functions inherited from vtkPlot
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 
static bool ClampPos (double pos[2], double bounds[4])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise. More...
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkPlotBarRangeHandlesItem ()=default
 
 ~vtkPlotBarRangeHandlesItem () override=default
 
void SetActiveHandlePosition (double position) override
 Internal method to set the ActiveHandlePosition and compute the ActiveHandleRangeValue accordingly. More...
 
- Protected Member Functions inherited from vtkPlotRangeHandlesItem
 vtkPlotRangeHandlesItem ()
 
 ~vtkPlotRangeHandlesItem () override
 
void ComputeRange (double *range)
 Compute the range used for the handles. More...
 
void ComputeHandleDelta (double screenBounds[4])
 Compute the delta used for the picking handle size. More...
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is around a handle. More...
 
virtual int FindRangeHandle (const vtkVector2f &point, const vtkVector2f &tolerance)
 Returns the handle the provided point is over with a provided tolerance, it can be NO_HANDLE, LEFT_HANDLE or RIGHT_HANDLE. More...
 
bool IsActiveHandleMoved (double tolerance)
 Internal method to check if the active handle have actually been moved. More...
 
void SetCursor (int cursor)
 Set the cursor shape. More...
 
 vtkPlotRangeHandlesItem (const vtkPlotRangeHandlesItem &)=delete
 
void operator= (const vtkPlotRangeHandlesItem &)=delete
 
void GetAxesRange (double *abcissaRange, double *ordinateRange)
 Get the logical range of abcissa or ordinate axis based on the handle orientation, in plot coordinates. More...
 
void GetAxesUnscaledRange (double *abcissaRange, double *ordinateRange)
 Get the logical range of abcissa or ordinate axis based on the handle orientation, in plot coordinates. More...
 
void TransformScreenToData (const double inX, const double inY, double &outX, double &outY) override
 Transform the mouse event in the control-points space. More...
 
void TransformDataToScreen (const double inX, const double inY, double &outX, double &outY) override
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const double inX, const double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformScreenToData (const double inX, const double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space. More...
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseEnterEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseLeaveEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse) override
 Interaction methods to interact with the handles. More...
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot () override
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis. More...
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space. More...
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()=default
 
 ~vtkContextItem () override=default
 
- 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 vtkPlotRangeHandlesItem
float HandleWidth = 2
 
float HandleDelta = 0
 
float LeftHandleDrawRange [2] = { 0, 0 }
 
float RightHandleDrawRange [2] = { 0, 0 }
 
int ActiveHandle = NO_HANDLE
 
int HoveredHandle = NO_HANDLE
 
float HoveredPosition [2] = { 0, 0 }
 
vtkTypeBool LockTooltipToMouse = true
 
double ActiveHandlePosition = 0
 
double ActiveHandleRangeValue = 0
 
vtkNew< vtkBrushHighlightBrush
 
vtkNew< vtkBrushRangeLabelBrush
 
double Extent [4] = { 0, 1, 0, 1 }
 
vtkTypeBool ExtentToAxisRange = true
 
vtkTypeBool SynchronizeRangeHandles = false
 
int HandleOrientation = VERTICAL
 
- Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkBrushBrush
 This object stores the vtkBrush that controls how the plot is drawn. More...
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkBrushSelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More...
 
vtkSmartPointer< vtkStringArrayLabels
 Plot labels, used by legend. More...
 
vtkSmartPointer< vtkStringArrayAutoLabels
 Holds Labels when they're auto-created. More...
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 Holds Labels when they're auto-created. More...
 
bool UseIndexForXSeries
 Use the Y array index for the X value. More...
 
vtkSmartPointer< vtkContextMapper2DData
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm. More...
 
bool Selectable
 Whether plot points can be selected or not. More...
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering. More...
 
vtkAxisXAxis
 The X axis associated with this plot. More...
 
vtkAxisYAxis
 The X axis associated with this plot. More...
 
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from. More...
 
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from. More...
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot. More...
 
bool LegendVisibility
 
bool LegacyRecursionFlag = false
 Flag used by GetNearestPoint legacy implementation to avoid infinite call. More...
 
- Protected Attributes inherited from vtkContextItem
double Opacity = 1.0
 
vtkContextTransformTransform = nullptr
 
- 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

show and control the range of a vtkAxis used with a vtkPlotBar

This class is a vtkPlotRangeHandlesItem specialization working in coordination with a vtkPlotBar. It ensures that handles are sticking to the plot bars when being dragged. Vertical and horizontal bars are both supported but the handles orientation must match the vtkPlotBar orientation.

See also
vtkPlotRangeHandlesItem

Definition at line 38 of file vtkPlotBarRangeHandlesItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPlotBarRangeHandlesItem.h.

Constructor & Destructor Documentation

◆ vtkPlotBarRangeHandlesItem()

vtkPlotBarRangeHandlesItem::vtkPlotBarRangeHandlesItem ( )
protecteddefault

◆ ~vtkPlotBarRangeHandlesItem()

vtkPlotBarRangeHandlesItem::~vtkPlotBarRangeHandlesItem ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPlotBarRangeHandlesItem::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 vtkPlotRangeHandlesItem.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPlotBarRangeHandlesItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlotRangeHandlesItem.

◆ NewInstance()

vtkPlotBarRangeHandlesItem* vtkPlotBarRangeHandlesItem::NewInstance ( ) const

◆ PrintSelf()

void vtkPlotBarRangeHandlesItem::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 vtkPlot.

◆ New()

static vtkPlotBarRangeHandlesItem* vtkPlotBarRangeHandlesItem::New ( )
static

◆ GetBounds()

void vtkPlotBarRangeHandlesItem::GetBounds ( double  bounds[4])
overridevirtual

Recover the bounds of the item.

Reimplemented from vtkPlot.

◆ vtkSetSmartPointerMacro()

vtkPlotBarRangeHandlesItem::vtkSetSmartPointerMacro ( PlotBar  ,
vtkPlotBar   
)

Get/Set the plot bar object to work with.

◆ vtkGetSmartPointerMacro()

vtkPlotBarRangeHandlesItem::vtkGetSmartPointerMacro ( PlotBar  ,
vtkPlotBar   
)

◆ SetActiveHandlePosition()

void vtkPlotBarRangeHandlesItem::SetActiveHandlePosition ( double  position)
overrideprotectedvirtual

Internal method to set the ActiveHandlePosition and compute the ActiveHandleRangeValue accordingly.

Reimplemented from vtkPlotRangeHandlesItem.


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