VTK  9.4.20241212
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPlotBar Class Reference

Class for drawing an XY plot given two columns from a vtkTable. More...

#include <vtkPlotBar.h>

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

Public Types

enum  { VERTICAL = 0 , HORIZONTAL }
 Enum of bar chart oritentation types. More...
 
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.
 
vtkPlotBarNewInstance () 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
 Paint event for the XY plot, called whenever the chart needs to be drawn.
 
bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex) override
 Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn.
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a) override
 Set the plot color with integer values (comprised between 0 and 255)
 
virtual void GetBounds (double bounds[4], bool unscaled)
 A helper used by both GetUnscaledBounds and GetBounds(double[4]).
 
void GetBounds (double bounds[4]) override
 Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
 
void GetUnscaledInputBounds (double bounds[4]) override
 Get un-log-scaled bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).
 
void SetInputArray (int index, const vtkStdString &name) override
 When used to set additional arrays, stacked bars are created.
 
void SetColorSeries (vtkColorSeries *colorSeries)
 Set the color series to use if this becomes a stacked bar plot.
 
vtkColorSeriesGetColorSeries ()
 Get the color series used if when this is a stacked bar plot.
 
virtual void CreateDefaultLookupTable ()
 Create default lookup table.
 
vtkStdString GetColorArrayName ()
 Get the array name to color by.
 
vtkStringArrayGetLabels () override
 Get the plot labels.
 
virtual void SetGroupName (const vtkStdString &name)
 Set the group name of the bar chart - can be displayed on the X axis.
 
virtual vtkStdString GetGroupName ()
 Get the group name of the bar char - can be displayed on the X axis.
 
vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex) override
 Generate and return the tooltip label string for this plot The segmentIndex is implemented here.
 
bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max) override
 Select all points in the specified rectangle.
 
vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &, vtkVector2f *location, vtkIdType *segmentIndex) override
 Function to query a plot for the nearest point to the specified coordinate.
 
int GetBarsCount ()
 Get amount of plotted bars.
 
void GetDataBounds (double bounds[2])
 Get the data bounds for this mapper as (Xmin,Xmax).
 
bool UpdateCache () override
 Update the internal cache.
 
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.
 
void SetColorF (double r, double g, double b, double a) override
 Set the plot color with floating values (comprised between 0.0 and 1.0)
 
void SetColorF (double r, double g, double b) override
 Set the plot color with floating values (comprised between 0.0 and 1.0)
 
void SetColor (double r, double g, double b) override
 Set the plot color with floating values (comprised between 0.0 and 1.0)
 
void GetColorF (double rgb[3]) override
 Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
 
void GetColor (double rgb[3]) override
 Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
 
void SetWidth (float _arg) override
 Set the width of the line.
 
float GetWidth () override
 Get the width of the line.
 
virtual void SetOffset (float)
 Set/get the horizontal offset of the bars.
 
virtual float GetOffset ()
 Set/get the horizontal offset of the bars.
 
virtual void SetOrientation (int orientation)
 Set/get the orientation of the bars.
 
virtual int GetOrientation ()
 Set/get the orientation of the bars.
 
virtual void SetLookupTable (vtkScalarsToColors *lut)
 Specify a lookup table for the mapper to use.
 
virtual vtkScalarsToColorsGetLookupTable ()
 Specify a lookup table for the mapper to use.
 
virtual void SetScalarVisibility (bool)
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual bool GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects.
 
virtual void SetEnableOpacityMapping (bool)
 Enable/disable mapping of the opacity values.
 
virtual bool GetEnableOpacityMapping ()
 Enable/disable mapping of the opacity values.
 
virtual void EnableOpacityMappingOn ()
 Enable/disable mapping of the opacity values.
 
virtual void EnableOpacityMappingOff ()
 Enable/disable mapping of the opacity values.
 
void SelectColorArray (vtkIdType arrayNum)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.
 
void SelectColorArray (const vtkStdString &arrayName)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.
 
- Public Member Functions inherited from vtkPlot
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPlotNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Update () override
 Perform any updates to the item that may be necessary before rendering.
 
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.
 
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.
 
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.
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 Select all points in the specified rectangle.
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 Select all points in the specified polygon.
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color with integer values (comprised between 0 and 255)
 
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot.
 
virtual vtkStdString GetLabel ()
 Get the label of this plot.
 
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
 
virtual vtkStringArrayGetLabels ()
 Get the plot labels.
 
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot.
 
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index.
 
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot.
 
virtual vtkStringArrayGetIndexedLabels ()
 Get the indexed labels array.
 
vtkContextMapper2DGetData ()
 Get the data object that the plot will draw.
 
virtual vtkTableGetInput ()
 Get the input table used by the plot.
 
vtkAlgorithmOutputGetInputConnection ()
 Get the input connection used by the plot.
 
virtual void SetInputArray (int index, const vtkStdString &name)
 Convenience function to set the input arrays.
 
virtual void GetBounds (double bounds[4])
 Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
 
virtual void GetUnscaledInputBounds (double bounds[4])
 Provide un-log-scaled bounds for the plot inputs.
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is inside the item.
 
virtual bool UpdateCache ()
 Update the internal cache.
 
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend.
 
virtual bool GetLegendVisibility ()
 Set whether the plot renders an entry in the legend.
 
virtual void LegendVisibilityOn ()
 Set whether the plot renders an entry in the legend.
 
virtual void LegendVisibilityOff ()
 Set whether the plot renders an entry in the legend.
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a printf-style string to build custom tooltip labels from.
 
virtual vtkStdString GetTooltipLabelFormat ()
 Sets/gets a printf-style string to build custom tooltip labels from.
 
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style.
 
virtual int GetTooltipNotation ()
 Sets/gets the tooltip notation style.
 
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision.
 
virtual int GetTooltipPrecision ()
 Sets/gets the tooltip precision.
 
void GetColor (unsigned char rgb[3])
 Get the plot color as integer rgb values (comprised between 0 and 255)
 
void GetColorRGBA (unsigned char rgba[4])
 Get the plot color as integer rgb values (comprised between 0 and 255)
 
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines.
 
vtkPenGetPen ()
 Get the plot color as floating rgb values (comprised between 0.0 and 1.0)
 
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes.
 
vtkBrushGetBrush ()
 Set/get the vtkBrush object that controls how this plot fills shapes.
 
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
 
vtkPenGetSelectionPen ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
 
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
 
vtkBrushGetSelectionBrush ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
 
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value.
 
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value.
 
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot.
 
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.
 
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.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 This is a convenience function to set the input connection for the plot.
 
void SetXAxisInputArrayToProcess (const std::string &name)
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
 
std::string GetXAxisInputArrayToProcess ()
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
 
void SetYAxisInputArrayToProcess (const std::string &name)
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
 
std::string GetYAxisInputArrayToProcess ()
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
 
virtual void SetSelectable (bool)
 Set whether the plot can be selected.
 
virtual bool GetSelectable ()
 Set whether the plot can be selected.
 
virtual void SelectableOn ()
 Set whether the plot can be selected.
 
virtual void SelectableOff ()
 Set whether the plot can be selected.
 
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected.
 
virtual vtkIdTypeArrayGetSelection ()
 Sets the list of points that must be selected.
 
virtual vtkAxisGetXAxis ()
 Get/set the X axis associated with this plot.
 
virtual void SetXAxis (vtkAxis *axis)
 Get/set the X axis associated with this plot.
 
virtual vtkAxisGetYAxis ()
 Get/set the Y axis associated with this plot.
 
virtual void SetYAxis (vtkAxis *axis)
 Get/set the Y axis associated with this plot.
 
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.
 
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.
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden.
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 A General setter/getter that should be overridden.
 
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.
 
- Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetTransform (vtkContextTransform *)
 Set the transform of the item.
 
virtual double GetOpacity ()
 Get the opacity of the item.
 
virtual void SetOpacity (double)
 Set the opacity of the item.
 
- 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.
 
vtkAbstractContextItemNewInstance () 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.
 
vtkAbstractContextItemGetItem (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 vtkAbstractContextItemGetPickedItem (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.
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene.
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item.
 
vtkAbstractContextItemGetParent ()
 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotBarSafeDownCast (vtkObjectBase *o)
 
static vtkPlotBarNew ()
 Creates a 2D Chart object.
 
- Static Public Member Functions inherited from vtkPlot
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 
static void FilterSelectedPoints (vtkDataArray *points, vtkDataArray *selectedPoints, vtkIdTypeArray *selectedIds)
 Utility function that fills up selectedPoints with tuples from points.
 
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.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkPlotBar ()
 
 ~vtkPlotBar () override
 
bool CacheRequiresUpdate () override
 Test if the internal cache requires an update.
 
- Protected Member Functions inherited from vtkPlot
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPlot ()
 
 ~vtkPlot () override
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis.
 
virtual bool CacheRequiresUpdate ()
 Test if the internal cache requires an update.
 
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space.
 
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space.
 
virtual void TransformScreenToData (double inX, double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space.
 
virtual void TransformDataToScreen (double inX, double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space.
 
- Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkContextItem ()=default
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () override
 
virtual void ReleaseGraphicsCache ()
 Release cache entries created by this context item.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPoints2DPoints
 Store a well packed set of XY coordinates for this data series.
 
float Width
 
float Offset
 
int Orientation
 
vtkSmartPointer< vtkColorSeriesColorSeries
 The color series to use if this becomes a stacked bar.
 
bool LogX
 
bool LogY
 
vtkSmartPointer< vtkScalarsToColorsLookupTable
 Lookup Table for coloring bars by scalar value.
 
vtkSmartPointer< vtkUnsignedCharArrayColors
 Lookup Table for coloring bars by scalar value.
 
bool ScalarVisibility
 Lookup Table for coloring bars by scalar value.
 
bool EnableOpacityMapping
 Lookup Table for coloring bars by scalar value.
 
vtkStdString ColorArrayName
 Lookup Table for coloring bars by scalar value.
 
- Protected Attributes inherited from vtkPlot
vtkTimeStamp BuildTime
 The point cache is marked dirty until it has been initialized.
 
vtkSmartPointer< vtkPenPen
 This object stores the vtkPen that controls how the plot is drawn.
 
vtkSmartPointer< vtkBrushBrush
 This object stores the vtkBrush that controls how the plot is drawn.
 
vtkSmartPointer< vtkPenSelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn.
 
vtkSmartPointer< vtkBrushSelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn.
 
vtkSmartPointer< vtkStringArrayLabels
 Plot labels, used by legend.
 
vtkSmartPointer< vtkStringArrayAutoLabels
 Holds Labels when they're auto-created.
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 Holds Labels when they're auto-created.
 
bool UseIndexForXSeries
 Use the Y array index for the X value.
 
vtkSmartPointer< vtkContextMapper2DData
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
 
bool Selectable
 Whether plot points can be selected or not.
 
vtkIdTypeArraySelection
 Selected indices for the table the plot is rendering.
 
vtkAxisXAxis
 The X axis associated with this plot.
 
vtkAxisYAxis
 The X axis associated with this plot.
 
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from.
 
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from.
 
int TooltipNotation
 
int TooltipPrecision
 
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot.
 
bool LegendVisibility
 
- 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.
 
vtkAbstractContextItemParent
 Point to the parent item - can be null.
 
vtkContextScenePrivateChildren
 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Class for drawing an XY plot given two columns from a vtkTable.

Online Examples:

Tests:
vtkPlotBar (Tests)

Definition at line 54 of file vtkPlotBar.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkPlotBar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of bar chart oritentation types.

Enumerator
VERTICAL 
HORIZONTAL 

Definition at line 63 of file vtkPlotBar.h.

Constructor & Destructor Documentation

◆ vtkPlotBar()

vtkPlotBar::vtkPlotBar ( )
protected

◆ ~vtkPlotBar()

vtkPlotBar::~vtkPlotBar ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPlotBar::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 vtkPlot.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPlotBar::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

◆ NewInstance()

vtkPlotBar * vtkPlotBar::NewInstance ( ) const

◆ PrintSelf()

void vtkPlotBar::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 vtkPlotBar * vtkPlotBar::New ( )
static

Creates a 2D Chart object.

◆ Paint()

bool vtkPlotBar::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the XY plot, called whenever the chart needs to be drawn.

Reimplemented from vtkAbstractContextItem.

◆ PaintLegend()

bool vtkPlotBar::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
)
overridevirtual

Paint legend event for the XY plot, called whenever the legend needs the plot items symbol/mark/line drawn.

A rect is supplied with the lower left corner of the rect (elements 0 and 1) and with width x height (elements 2 and 3). The plot can choose how to fill the space supplied.

Reimplemented from vtkPlot.

◆ SetColor() [1/2]

void vtkPlotBar::SetColor ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a 
)
overridevirtual

Set the plot color with integer values (comprised between 0 and 255)

Reimplemented from vtkPlot.

◆ SetColorF() [1/2]

void vtkPlotBar::SetColorF ( double  r,
double  g,
double  b,
double  a 
)
overridevirtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented from vtkPlot.

◆ SetColorF() [2/2]

void vtkPlotBar::SetColorF ( double  r,
double  g,
double  b 
)
overridevirtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented from vtkPlot.

◆ SetColor() [2/2]

void vtkPlotBar::SetColor ( double  r,
double  g,
double  b 
)
inlineoverridevirtual

Set the plot color with floating values (comprised between 0.0 and 1.0)

Reimplemented from vtkPlot.

Definition at line 100 of file vtkPlotBar.h.

◆ GetColorF()

void vtkPlotBar::GetColorF ( double  rgb[3])
overridevirtual

Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

Reimplemented from vtkPlot.

◆ GetColor()

void vtkPlotBar::GetColor ( double  rgb[3])
inlineoverridevirtual

Get the plot color as floating rgb values (comprised between 0.0 and 1.0)

Reimplemented from vtkPlot.

Definition at line 110 of file vtkPlotBar.h.

◆ SetWidth()

void vtkPlotBar::SetWidth ( float  _arg)
inlineoverridevirtual

Set the width of the line.

Reimplemented from vtkPlot.

Definition at line 117 of file vtkPlotBar.h.

◆ GetWidth()

float vtkPlotBar::GetWidth ( )
inlineoverridevirtual

Get the width of the line.

Reimplemented from vtkPlot.

Definition at line 132 of file vtkPlotBar.h.

◆ SetOffset()

virtual void vtkPlotBar::SetOffset ( float  )
virtual

Set/get the horizontal offset of the bars.

Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

◆ GetOffset()

virtual float vtkPlotBar::GetOffset ( )
virtual

Set/get the horizontal offset of the bars.

Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

◆ SetOrientation()

virtual void vtkPlotBar::SetOrientation ( int  orientation)
virtual

Set/get the orientation of the bars.

Valid orientations are VERTICAL (default) and HORIZONTAL.

◆ GetOrientation()

virtual int vtkPlotBar::GetOrientation ( )
virtual

Set/get the orientation of the bars.

Valid orientations are VERTICAL (default) and HORIZONTAL.

◆ GetBounds() [1/2]

virtual void vtkPlotBar::GetBounds ( double  bounds[4],
bool  unscaled 
)
virtual

A helper used by both GetUnscaledBounds and GetBounds(double[4]).

◆ GetBounds() [2/2]

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

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).

Reimplemented from vtkPlot.

◆ GetUnscaledInputBounds()

void vtkPlotBar::GetUnscaledInputBounds ( double  bounds[4])
overridevirtual

Get un-log-scaled bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).

Reimplemented from vtkPlot.

◆ SetInputArray()

void vtkPlotBar::SetInputArray ( int  index,
const vtkStdString name 
)
overridevirtual

When used to set additional arrays, stacked bars are created.

Reimplemented from vtkPlot.

◆ SetColorSeries()

void vtkPlotBar::SetColorSeries ( vtkColorSeries colorSeries)

Set the color series to use if this becomes a stacked bar plot.

◆ GetColorSeries()

vtkColorSeries * vtkPlotBar::GetColorSeries ( )

Get the color series used if when this is a stacked bar plot.

◆ SetLookupTable()

virtual void vtkPlotBar::SetLookupTable ( vtkScalarsToColors lut)
virtual

Specify a lookup table for the mapper to use.

◆ GetLookupTable()

virtual vtkScalarsToColors * vtkPlotBar::GetLookupTable ( )
virtual

Specify a lookup table for the mapper to use.

◆ CreateDefaultLookupTable()

virtual void vtkPlotBar::CreateDefaultLookupTable ( )
virtual

Create default lookup table.

Generally used to create one when none is available with the scalar data.

◆ SetScalarVisibility()

virtual void vtkPlotBar::SetScalarVisibility ( bool  )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ GetScalarVisibility()

virtual bool vtkPlotBar::GetScalarVisibility ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ ScalarVisibilityOn()

virtual void vtkPlotBar::ScalarVisibilityOn ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ ScalarVisibilityOff()

virtual void vtkPlotBar::ScalarVisibilityOff ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

◆ SetEnableOpacityMapping()

virtual void vtkPlotBar::SetEnableOpacityMapping ( bool  )
virtual

Enable/disable mapping of the opacity values.

Default is set to true.

◆ GetEnableOpacityMapping()

virtual bool vtkPlotBar::GetEnableOpacityMapping ( )
virtual

Enable/disable mapping of the opacity values.

Default is set to true.

◆ EnableOpacityMappingOn()

virtual void vtkPlotBar::EnableOpacityMappingOn ( )
virtual

Enable/disable mapping of the opacity values.

Default is set to true.

◆ EnableOpacityMappingOff()

virtual void vtkPlotBar::EnableOpacityMappingOff ( )
virtual

Enable/disable mapping of the opacity values.

Default is set to true.

◆ SelectColorArray() [1/2]

void vtkPlotBar::SelectColorArray ( vtkIdType  arrayNum)

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.

The lookup table will decide how to convert vectors to colors.

◆ SelectColorArray() [2/2]

void vtkPlotBar::SelectColorArray ( const vtkStdString arrayName)

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods.

The lookup table will decide how to convert vectors to colors.

◆ GetColorArrayName()

vtkStdString vtkPlotBar::GetColorArrayName ( )

Get the array name to color by.

◆ GetLabels()

vtkStringArray * vtkPlotBar::GetLabels ( )
overridevirtual

Get the plot labels.

Reimplemented from vtkPlot.

◆ SetGroupName()

virtual void vtkPlotBar::SetGroupName ( const vtkStdString name)
virtual

Set the group name of the bar chart - can be displayed on the X axis.

◆ GetGroupName()

virtual vtkStdString vtkPlotBar::GetGroupName ( )
virtual

Get the group name of the bar char - can be displayed on the X axis.

◆ GetTooltipLabel()

vtkStdString vtkPlotBar::GetTooltipLabel ( const vtkVector2d plotPos,
vtkIdType  seriesIndex,
vtkIdType  segmentIndex 
)
overridevirtual

Generate and return the tooltip label string for this plot The segmentIndex is implemented here.

Reimplemented from vtkPlot.

◆ SelectPoints()

bool vtkPlotBar::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
)
overridevirtual

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

◆ GetNearestPoint() [1/2]

vtkIdType vtkPlotBar::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f ,
vtkVector2f location,
vtkIdType segmentIndex 
)
overridevirtual

Function to query a plot for the nearest point to the specified coordinate.

Returns the index of the data series with which the point is associated or -1. If a vtkIdType* is passed, its referent will be set to index of the bar segment with which a point is associated, or -1.

Reimplemented from vtkPlot.

◆ GetBarsCount()

int vtkPlotBar::GetBarsCount ( )

Get amount of plotted bars.

◆ GetDataBounds()

void vtkPlotBar::GetDataBounds ( double  bounds[2])

Get the data bounds for this mapper as (Xmin,Xmax).

◆ UpdateCache()

bool vtkPlotBar::UpdateCache ( )
overridevirtual

Update the internal cache.

Returns true if cache was successfully updated. Default does nothing. This method is called by Update() when either the plot's data has changed or CacheRequiresUpdate() returns true. It is not necessary to call this method explicitly.

Reimplemented from vtkPlot.

◆ CacheRequiresUpdate()

bool vtkPlotBar::CacheRequiresUpdate ( )
overrideprotectedvirtual

Test if the internal cache requires an update.

Reimplemented from vtkPlot.

◆ GetNearestPoint() [2/2]

virtual vtkIdType vtkPlot::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f tolerance,
vtkVector2f location,
vtkIdType segmentId 
)
virtual

Function to query a plot for the nearest point to the specified coordinate.

Returns the index of the data series with which the point is associated, or -1 if no point was found.

Reimplemented from vtkPlot.

Member Data Documentation

◆ Points

vtkPoints2D* vtkPlotBar::Points
protected

Store a well packed set of XY coordinates for this data series.

Definition at line 305 of file vtkPlotBar.h.

◆ Width

float vtkPlotBar::Width
protected

Definition at line 307 of file vtkPlotBar.h.

◆ Offset

float vtkPlotBar::Offset
protected

Definition at line 308 of file vtkPlotBar.h.

◆ Orientation

int vtkPlotBar::Orientation
protected

Definition at line 310 of file vtkPlotBar.h.

◆ ColorSeries

vtkSmartPointer<vtkColorSeries> vtkPlotBar::ColorSeries
protected

The color series to use if this becomes a stacked bar.

Definition at line 315 of file vtkPlotBar.h.

◆ LookupTable

vtkSmartPointer<vtkScalarsToColors> vtkPlotBar::LookupTable
protected

Lookup Table for coloring bars by scalar value.

Definition at line 321 of file vtkPlotBar.h.

◆ Colors

vtkSmartPointer<vtkUnsignedCharArray> vtkPlotBar::Colors
protected

Lookup Table for coloring bars by scalar value.

Definition at line 322 of file vtkPlotBar.h.

◆ ScalarVisibility

bool vtkPlotBar::ScalarVisibility
protected

Lookup Table for coloring bars by scalar value.

Definition at line 323 of file vtkPlotBar.h.

◆ EnableOpacityMapping

bool vtkPlotBar::EnableOpacityMapping
protected

Lookup Table for coloring bars by scalar value.

Definition at line 324 of file vtkPlotBar.h.

◆ ColorArrayName

vtkStdString vtkPlotBar::ColorArrayName
protected

Lookup Table for coloring bars by scalar value.

Definition at line 325 of file vtkPlotBar.h.

◆ LogX

bool vtkPlotBar::LogX
protected

Definition at line 328 of file vtkPlotBar.h.

◆ LogY

bool vtkPlotBar::LogY
protected

Definition at line 329 of file vtkPlotBar.h.


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