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

#include <vtkPlotBar.h>

Inheritance diagram for vtkPlotBar:

Collaboration diagram for vtkPlotBar:

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

vtkPlotBar *	NewInstance () const

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

void	Update () override
	Perform any updates to the item that may be necessary before rendering. More...

bool	Paint (vtkContext2D *painter) override
	Paint event for the XY plot, called whenever the chart needs to be drawn. More...

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

void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a) override
	Set the plot color. More...

void	SetColor (double r, double g, double b) override

void	GetColor (double rgb[3]) override

void	SetWidth (float _arg) override
	Set the width of the line. More...

float	GetWidth () override
	Get the width of the line. More...

virtual void	SetOffset (float)
	Set/get the horizontal offset of the bars. More...

virtual float	GetOffset ()

virtual void	SetOrientation (int orientation)
	Set/get the orientation of the bars. More...

virtual int	GetOrientation ()

virtual void	GetBounds (double bounds[4], bool unscaled)
	A helper used by both GetUnscaledBounds and GetBounds(double[4]). More...

void	GetBounds (double bounds[4]) override
	Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax). More...

void	GetUnscaledInputBounds (double bounds[4]) override
	Get un-log-scaled bounds for this mapper as (Xmin,Xmax,Ymin,Ymax). More...

void	SetInputArray (int index, const vtkStdString &name) override
	When used to set additional arrays, stacked bars are created. More...

void	SetColorSeries (vtkColorSeries *colorSeries)
	Set the color series to use if this becomes a stacked bar plot. More...

vtkColorSeries *	GetColorSeries ()
	Get the color series used if when this is a stacked bar plot. More...

virtual void	SetLookupTable (vtkScalarsToColors *lut)
	Specify a lookup table for the mapper to use. More...

virtual vtkScalarsToColors *	GetLookupTable ()

virtual void	CreateDefaultLookupTable ()
	Create default lookup table. More...

virtual void	SetScalarVisibility (bool)
	Turn on/off flag to control whether scalar data is used to color objects. More...

virtual bool	GetScalarVisibility ()

virtual void	ScalarVisibilityOn ()

virtual void	ScalarVisibilityOff ()

virtual void	SetEnableOpacityMapping (bool)
	Enable/disable mapping of the opacity values. More...

virtual bool	GetEnableOpacityMapping ()

virtual void	EnableOpacityMappingOn ()

virtual void	EnableOpacityMappingOff ()

void	SelectColorArray (vtkIdType arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...

void	SelectColorArray (const vtkStdString &arrayName)

vtkStdString	GetColorArrayName ()
	Get the array name to color by. More...

vtkStringArray *	GetLabels () override
	Get the plot labels. More...

virtual void	SetGroupName (const vtkStdString &name)
	Set the group name of the bar chart - can be displayed on the X axis. More...

virtual vtkStdString	GetGroupName ()
	Get the group name of the bar char - can be displayed on the X axis. More...

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

bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max) override
	Select all points in the specified rectangle. More...

virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &, vtkVector2f location, vtkIdType segmentId) override
	Function to query a plot for the nearest point to the specified coordinate. More...

int	GetBarsCount ()
	Get amount of plotted bars. More...

void	GetDataBounds (double bounds[2])
	Get the data bounds for this mapper as (Xmin,Xmax). 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...

Public Member Functions inherited from vtkPlot
vtkPlot *	NewInstance () const

virtual void	SetLegendVisibility (bool)
	Set whether the plot renders an entry in the legend. More...

virtual bool	GetLegendVisibility ()

virtual void	LegendVisibilityOn ()

virtual void	LegendVisibilityOff ()

virtual void	SetTooltipLabelFormat (const vtkStdString &label)
	Sets/gets a printf-style string to build custom tooltip labels from. More...

virtual vtkStdString	GetTooltipLabelFormat ()

virtual void	SetTooltipNotation (int notation)
	Sets/gets the tooltip notation style. More...

virtual int	GetTooltipNotation ()

virtual void	SetTooltipPrecision (int precision)
	Sets/gets the tooltip precision. More...

virtual int	GetTooltipPrecision ()

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	SelectPointsInPolygon (const vtkContextPolygon &polygon)
	Select all points in the specified polygon. More...

void	GetColor (unsigned char rgb[3])

void	SetPen (vtkPen *pen)
	Set/get the vtkPen object that controls how this plot draws (out)lines. More...

vtkPen *	GetPen ()

void	SetBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills shapes. More...

vtkBrush *	GetBrush ()

void	SetSelectionPen (vtkPen *pen)
	Set/get the vtkBrush object that controls how this plot fills selected shapes. More...

vtkPen *	GetSelectionPen ()

void	SetSelectionBrush (vtkBrush *brush)
	Set/get the vtkBrush object that controls how this plot fills selected shapes. More...

vtkBrush *	GetSelectionBrush ()

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 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 vtkStringArray *	GetIndexedLabels ()
	Get the indexed labels array. More...

vtkContextMapper2D *	GetData ()
	Get the data object that the plot will draw. 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)

void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)

virtual vtkTable *	GetInput ()
	Get the input table used by the plot. More...

virtual void	SetSelectable (bool)
	Set whether the plot can be selected. More...

virtual bool	GetSelectable ()

virtual void	SelectableOn ()

virtual void	SelectableOff ()

virtual void	SetSelection (vtkIdTypeArray *id)
	Sets the list of points that must be selected. More...

virtual vtkIdTypeArray *	GetSelection ()

virtual vtkAxis *	GetXAxis ()
	Get/set the X axis associated with this plot. More...

virtual void	SetXAxis (vtkAxis *axis)

virtual vtkAxis *	GetYAxis ()
	Get/set the Y axis associated with this plot. More...

virtual void	SetYAxis (vtkAxis *axis)

void	SetShiftScale (const vtkRectd &scaling)
	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 ()

virtual void	UpdateCache ()
	Subclasses that build data caches to speed up painting should override this method to update such caches. 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)

virtual bool	ClampPos (double pos[2])

Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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
vtkAbstractContextItem *	NewInstance () const

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

vtkAbstractContextItem *	GetItem (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 bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item. More...

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse. More...

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event. More...

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event. More...

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event. More...

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

vtkContextScene *	GetScene ()
	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...

vtkAbstractContextItem *	GetParent ()
	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...

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)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

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)

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)

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkPlotBar *	SafeDownCast (vtkObjectBase *o)

static vtkPlotBar *	New ()
	Creates a 2D Chart object. More...

Static Public Member Functions inherited from vtkPlot
static vtkTypeBool	IsTypeOf (const char *type)

static vtkPlot *	SafeDownCast (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 vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 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 ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlotBar ()

	~vtkPlotBar () override

bool	UpdateTableCache (vtkTable *table)
	Update the table cache. 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)

virtual void	TransformScreenToData (const double inX, const double inY, double &outX, double &outY)

virtual void	TransformDataToScreen (const double inX, const double inY, double &outX, double &outY)

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem () override

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPoints2D *	Points
	Store a well packed set of XY coordinates for this data series. More...

float	Width

float	Offset

int	Orientation

vtkTimeStamp	BuildTime
	The point cache is marked dirty until it has been initialized. More...

vtkSmartPointer< vtkColorSeries >	ColorSeries
	The color series to use if this becomes a stacked bar. More...

vtkSmartPointer< vtkScalarsToColors >	LookupTable
	Lookup Table for coloring bars by scalar value. More...

vtkSmartPointer< vtkUnsignedCharArray >	Colors

bool	ScalarVisibility

bool	EnableOpacityMapping

vtkStdString	ColorArrayName

bool	LogX

bool	LogY

Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen >	Pen
	This object stores the vtkPen that controls how the plot is drawn. More...

vtkSmartPointer< vtkBrush >	Brush
	This object stores the vtkBrush that controls how the plot is drawn. More...

vtkSmartPointer< vtkPen >	SelectionPen
	This object stores the vtkPen that controls how the selected elements of the plot are drawn. More...

vtkSmartPointer< vtkBrush >	SelectionBrush
	This object stores the vtkBrush that controls how the selected elements of the plot are drawn. More...

vtkSmartPointer< vtkStringArray >	Labels
	Plot labels, used by legend. More...

vtkSmartPointer< vtkStringArray >	AutoLabels
	Holds Labels when they're auto-created. More...

vtkSmartPointer< vtkStringArray >	IndexedLabels
	Holds Labels when they're auto-created. More...

bool	UseIndexForXSeries
	Use the Y array index for the X value. More...

vtkSmartPointer< vtkContextMapper2D >	Data
	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...

vtkIdTypeArray *	Selection
	Selected indices for the table the plot is rendering. More...

vtkAxis *	XAxis
	The X axis associated with this plot. More...

vtkAxis *	YAxis
	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

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null. More...

vtkAbstractContextItem *	Parent
	Point to the parent item - can be null. More...

vtkContextScenePrivate *	Children
	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

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

Definition at line 42 of file vtkPlotBar.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlot vtkPlotBar::Superclass

Definition at line 45 of file vtkPlotBar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum of bar chart oritentation types.

Enumerator
VERTICAL
HORIZONTAL

Definition at line 51 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.

◆ Update()

void vtkPlotBar::Update ( )

overridevirtual

Perform any updates to the item that may be necessary before rendering.

Reimplemented from vtkAbstractContextItem.

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

Reimplemented from vtkPlot.

◆ SetColor() [2/2]

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

overridevirtual

Reimplemented from vtkPlot.

◆ GetColor()

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

overridevirtual

Reimplemented from vtkPlot.

◆ SetWidth()

void vtkPlotBar::SetWidth ( float _arg )

inlineoverridevirtual

Set the width of the line.

Reimplemented from vtkPlot.

Definition at line 93 of file vtkPlotBar.h.

◆ GetWidth()

float vtkPlotBar::GetWidth ( )

inlineoverridevirtual

Get the width of the line.

Reimplemented from vtkPlot.

Definition at line 108 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

◆ 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

◆ 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

◆ 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

◆ ScalarVisibilityOn()

virtual void vtkPlotBar::ScalarVisibilityOn ( )

virtual

◆ ScalarVisibilityOff()

virtual void vtkPlotBar::ScalarVisibilityOff ( )

virtual

◆ 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

◆ EnableOpacityMappingOn()

virtual void vtkPlotBar::EnableOpacityMappingOn ( )

virtual

◆ EnableOpacityMappingOff()

virtual void vtkPlotBar::EnableOpacityMappingOff ( )

virtual

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

◆ 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/3]

virtual vtkIdType vtkPlotBar::GetNearestPoint	(	const vtkVector2f &	point,
		const vtkVector2f &	,
		vtkVector2f *	location,
		vtkIdType *	segmentId
	)

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

◆ UpdateTableCache()

bool vtkPlotBar::UpdateTableCache ( vtkTable * table )

protected

Update the table cache.

◆ GetNearestPoint() [2/3]

virtual vtkIdType vtkPlot::GetNearestPoint

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.

◆ GetNearestPoint() [3/3]

virtual vtkIdType vtkPlot::GetNearestPoint

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. Deprecated method, uses GetNearestPoint(const vtkVector2f& point, const vtkVector2f& tolerance, vtkVector2f* location, vtkIdType* segmentId); instead.

Member Data Documentation

◆ Points

vtkPoints2D* vtkPlotBar::Points

protected

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

Definition at line 281 of file vtkPlotBar.h.

◆ Width

float vtkPlotBar::Width

protected

Definition at line 283 of file vtkPlotBar.h.

◆ Offset

float vtkPlotBar::Offset

protected

Definition at line 284 of file vtkPlotBar.h.

◆ Orientation

int vtkPlotBar::Orientation

protected

Definition at line 286 of file vtkPlotBar.h.

◆ BuildTime

vtkTimeStamp vtkPlotBar::BuildTime

protected

The point cache is marked dirty until it has been initialized.

Definition at line 291 of file vtkPlotBar.h.

◆ ColorSeries

vtkSmartPointer<vtkColorSeries> vtkPlotBar::ColorSeries

protected

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

Definition at line 296 of file vtkPlotBar.h.

◆ LookupTable

vtkSmartPointer<vtkScalarsToColors> vtkPlotBar::LookupTable

protected

Lookup Table for coloring bars by scalar value.

Definition at line 302 of file vtkPlotBar.h.

◆ Colors

vtkSmartPointer<vtkUnsignedCharArray> vtkPlotBar::Colors

protected

Definition at line 303 of file vtkPlotBar.h.

◆ ScalarVisibility

bool vtkPlotBar::ScalarVisibility

protected

Definition at line 304 of file vtkPlotBar.h.

◆ EnableOpacityMapping

bool vtkPlotBar::EnableOpacityMapping

protected

Definition at line 305 of file vtkPlotBar.h.

◆ ColorArrayName

vtkStdString vtkPlotBar::ColorArrayName

protected

Definition at line 306 of file vtkPlotBar.h.

◆ LogX

bool vtkPlotBar::LogX

protected

Definition at line 309 of file vtkPlotBar.h.

◆ LogY

bool vtkPlotBar::LogY

protected

Definition at line 310 of file vtkPlotBar.h.

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

dox/Charts/Core/vtkPlotBar.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkPlotBar()

◆ ~vtkPlotBar()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Update()

◆ Paint()

◆ PaintLegend()

◆ SetColor() [1/2]

◆ SetColor() [2/2]

◆ GetColor()

◆ SetWidth()

◆ GetWidth()

◆ SetOffset()

◆ GetOffset()

◆ SetOrientation()

◆ GetOrientation()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetUnscaledInputBounds()

◆ SetInputArray()

◆ SetColorSeries()

◆ GetColorSeries()

◆ SetLookupTable()

◆ GetLookupTable()

◆ CreateDefaultLookupTable()

◆ SetScalarVisibility()

◆ GetScalarVisibility()

◆ ScalarVisibilityOn()

◆ ScalarVisibilityOff()

◆ SetEnableOpacityMapping()

◆ GetEnableOpacityMapping()

◆ EnableOpacityMappingOn()

◆ EnableOpacityMappingOff()

◆ SelectColorArray() [1/2]

◆ SelectColorArray() [2/2]

◆ GetColorArrayName()

◆ GetLabels()

◆ SetGroupName()

◆ GetGroupName()

◆ GetTooltipLabel()

◆ SelectPoints()

◆ GetNearestPoint() [1/3]

◆ GetBarsCount()

◆ GetDataBounds()

◆ UpdateTableCache()

◆ GetNearestPoint() [2/3]

◆ GetNearestPoint() [3/3]

Member Data Documentation

◆ Points

◆ Width

◆ Offset

◆ Orientation

◆ BuildTime

◆ ColorSeries

◆ LookupTable

◆ Colors

◆ ScalarVisibility

◆ EnableOpacityMapping

◆ ColorArrayName

◆ LogX

◆ LogY