Abstract class for 2D plots. More...

#include <vtkPlot.h>

Inheritance diagram for vtkPlot:

Collaboration diagram for vtkPlot:

Public Types
typedef vtkContextItem	Superclass

Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass

Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPlot *	NewInstance () const

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

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

vtkContextMapper2D *	GetData ()
	Get the data object that the plot will draw. More...

virtual vtkTable *	GetInput ()
	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	GetBounds (double bounds[4])
	Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax). 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...

vtkPen *	GetPen ()
	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...

vtkBrush *	GetBrush ()
	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...

vtkPen *	GetSelectionPen ()
	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...

vtkBrush *	GetSelectionBrush ()
	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 vtkIdTypeArray *	GetSelection ()
	Sets the list of points that must be selected. More...


virtual vtkAxis *	GetXAxis ()
	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 vtkAxis *	GetYAxis ()
	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 &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 ()
	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...

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

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 void	Update ()
	Perform any updates to the item that may be necessary before rendering. More...

virtual bool	Paint (vtkContext2D *painter)
	Paint event for the item, called whenever the item needs to be drawn. 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...

unsigned int	AddItem (vtkAbstractContextItem *item)
	Add child items to this item. More...

bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item. More...

bool	RemoveItem (unsigned int index)
	Remove child item from this item. More...

vtkAbstractContextItem *	GetItem (unsigned int index)
	Get the item at the specified index. More...

unsigned int	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item. More...

unsigned int	GetNumberOfItems ()
	Get the number of child items. More...

void	ClearItems ()
	Remove all child items from this item. More...

unsigned int	Raise (unsigned int index)
	Raises the child to the top of the item's stack. More...

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)
	Raises the child above the under sibling. More...

unsigned int	Lower (unsigned int index)
	Lowers the child to the bottom of the item's stack. More...

virtual unsigned int	StackUnder (unsigned int child, unsigned int 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...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

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

vtkCommand *	GetCommand (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...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

void	PrintRevisions (ostream &)
	Legacy. 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 int	IsTypeOf (const char *type)

static vtkPlot *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkContextItem
static int	IsTypeOf (const char *type)

static vtkContextItem *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractContextItem
static int	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 ()
	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 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

	vtkPlot ()

	~vtkPlot ()

vtkStdString	GetNumber (double position, vtkAxis *axis)
	Get the properly formatted number for the supplied position and axis. More...

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem ()

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

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=NULL)
	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	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
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

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract class for 2D plots.

The base class for all plot types used in vtkChart derived charts.

See also: vtkPlotPoints vtkPlotLine vtkPlotBar vtkChart vtkChartXY

Examples:: vtkPlot (Examples)

Tests:: vtkPlot (Tests)

Definition at line 52 of file vtkPlot.h.

Member Typedef Documentation

typedef vtkContextItem vtkPlot::Superclass

Definition at line 55 of file vtkPlot.h.

Constructor & Destructor Documentation

vtkPlot::vtkPlot ( )

protected

vtkPlot::~vtkPlot ( )

protected

Member Function Documentation

static int vtkPlot::IsTypeOf ( const char * type )

static

virtual int vtkPlot::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 vtkContextItem.

Reimplemented in vtkPlotPoints, vtkPlotFunctionalBag, vtkPlotBar, vtkControlPointsItem, vtkPlotBag, vtkPlotStacked, vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, vtkPlotBox, vtkScalarsToColorsItem, vtkColorTransferControlPointsItem, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotArea, vtkPlotHistogram2D, vtkPlotLine, vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

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

static

virtual vtkObjectBase* vtkPlot::NewInstanceInternal ( ) const

protectedvirtual

vtkPlot* vtkPlot::NewInstance ( ) const

virtual void vtkPlot::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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

Reimplemented in vtkPlotPoints, vtkPlotFunctionalBag, vtkPlotBar, vtkControlPointsItem, vtkPlotBag, vtkPlotStacked, vtkCompositeControlPointsItem, vtkPiecewiseControlPointsItem, vtkPlotBox, vtkScalarsToColorsItem, vtkColorTransferControlPointsItem, vtkPlotParallelCoordinates, vtkPlotPie, vtkPlotArea, vtkPlotHistogram2D, vtkPlotLine, vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

virtual void vtkPlot::SetLegendVisibility ( bool )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

virtual bool vtkPlot::GetLegendVisibility ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

virtual void vtkPlot::LegendVisibilityOn ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

virtual void vtkPlot::LegendVisibilityOff ( )

virtual

Set whether the plot renders an entry in the legend.

Default is true. vtkPlot::PaintLegend will get called to render the legend marker on when this is true.

virtual bool vtkPlot::PaintLegend	(	vtkContext2D *	painter,
		const vtkRectf &	rect,
		int	legendIndex
	)

virtual

Paint legend event for the 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. The index is used by Plots that return more than one label.

Reimplemented in vtkPlotArea, vtkPlotFunctionalBag, vtkPlotStacked, vtkPlotPoints, vtkPlotBar, vtkPlotBag, vtkPlotBox, vtkPlotParallelCoordinates, vtkPlotPie, and vtkPlotLine.

virtual void vtkPlot::SetTooltipLabelFormat ( const vtkStdString & label )

virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

virtual vtkStdString vtkPlot::GetTooltipLabelFormat ( )

virtual

Sets/gets a printf-style string to build custom tooltip labels from.

An empty string generates the default tooltip labels. The following case-sensitive format tags (without quotes) are recognized: 'x' The X value of the plot element 'y' The Y value of the plot element 'i' The IndexedLabels entry for the plot element 'l' The value of the plot's GetLabel() function 's' (vtkPlotBar only) The Labels entry for the bar segment Any other characters or unrecognized format tags are printed in the tooltip label verbatim.

virtual void vtkPlot::SetTooltipNotation ( int notation )

virtual

Sets/gets the tooltip notation style.

virtual int vtkPlot::GetTooltipNotation ( )

virtual

Sets/gets the tooltip notation style.

virtual void vtkPlot::SetTooltipPrecision ( int precision )

virtual

Sets/gets the tooltip precision.

virtual int vtkPlot::GetTooltipPrecision ( )

virtual

Sets/gets the tooltip precision.

virtual vtkStdString vtkPlot::GetTooltipLabel	(	const vtkVector2d &	plotPos,
		vtkIdType	seriesIndex,
		vtkIdType	segmentIndex
	)

virtual

Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.

Reimplemented in vtkPlotBar, vtkPlotArea, vtkPlotHistogram2D, and vtkPlotBag.

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

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 in vtkPlotBar, vtkPlotPoints, vtkPlotStacked, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotArea, vtkPlotBox, and vtkPlotPie.

virtual bool vtkPlot::SelectPoints	(	const vtkVector2f &	min,
		const vtkVector2f &	max
	)

virtual

Select all points in the specified rectangle.

Reimplemented in vtkPlotBar, vtkControlPointsItem, vtkPlotPoints, vtkPlotStacked, and vtkPlotFunctionalBag.

virtual bool vtkPlot::SelectPointsInPolygon ( const vtkContextPolygon & polygon )

virtual

Select all points in the specified polygon.

Reimplemented in vtkPlotPoints, and vtkPlotFunctionalBag.

virtual void vtkPlot::SetColor	(	unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a
	)

virtual

Set the plot color.

Reimplemented in vtkPlotBar, vtkPlotStacked, and vtkPlotArea.

virtual void vtkPlot::SetColor	(	double	r,
		double	g,
		double	b
	)

virtual

Set the plot color.

Reimplemented in vtkPlotBar, vtkPlotStacked, and vtkPlotArea.

virtual void vtkPlot::GetColor ( double rgb[3] )

virtual

Set the plot color.

Reimplemented in vtkPlotBar, and vtkPlotStacked.

void vtkPlot::GetColor ( unsigned char rgb[3] )

Set the plot color.

virtual void vtkPlot::SetWidth ( float width )

virtual

Set the width of the line.

Reimplemented in vtkPlotBar.

virtual float vtkPlot::GetWidth ( )

virtual

Get the width of the line.

Reimplemented in vtkPlotBar.

void vtkPlot::SetPen ( vtkPen * pen )

Set/get the vtkPen object that controls how this plot draws (out)lines.

vtkPen* vtkPlot::GetPen ( )

Set/get the vtkPen object that controls how this plot draws (out)lines.

void vtkPlot::SetBrush ( vtkBrush * brush )

Set/get the vtkBrush object that controls how this plot fills shapes.

vtkBrush* vtkPlot::GetBrush ( )

Set/get the vtkBrush object that controls how this plot fills shapes.

void vtkPlot::SetSelectionPen ( vtkPen * pen )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

vtkPen* vtkPlot::GetSelectionPen ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

void vtkPlot::SetSelectionBrush ( vtkBrush * brush )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

vtkBrush* vtkPlot::GetSelectionBrush ( )

Set/get the vtkBrush object that controls how this plot fills selected shapes.

virtual void vtkPlot::SetLabel ( const vtkStdString & label )

virtual

Set the label of this plot.

virtual vtkStdString vtkPlot::GetLabel ( )

virtual

Get the label of this plot.

virtual void vtkPlot::SetLabels ( vtkStringArray * labels )

virtual

Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.

virtual vtkStringArray* vtkPlot::GetLabels ( )

virtual

Get the plot labels.

If this array has a length greater than 1 the index refers to the stacked objects in the plot. See vtkPlotBar for example.

Reimplemented in vtkPlotBar, vtkPlotStacked, vtkPlotBox, and vtkPlotBag.

virtual int vtkPlot::GetNumberOfLabels ( )

virtual

Get the number of labels associated with this plot.

vtkStdString vtkPlot::GetLabel ( vtkIdType index )

Get the label at the specified index.

void vtkPlot::SetIndexedLabels ( vtkStringArray * labels )

Set indexed labels for the plot.

If set, this array can be used to provide custom labels for each point in a plot. This array should be the same length as the points array. Default is null (no indexed labels).

virtual vtkStringArray* vtkPlot::GetIndexedLabels ( )

virtual

Get the indexed labels array.

vtkContextMapper2D* vtkPlot::GetData ( )

Get the data object that the plot will draw.

virtual bool vtkPlot::GetUseIndexForXSeries ( )

virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

virtual void vtkPlot::SetUseIndexForXSeries ( bool )

virtual

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

virtual void vtkPlot::SetInputData ( vtkTable * table )

virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotBag, vtkPlotParallelCoordinates, vtkPlotBox, and vtkPlotHistogram2D.

virtual void vtkPlot::SetInputData	(	vtkTable *	table,
		const vtkStdString &	xColumn,
		const vtkStdString &	yColumn
	)

virtual

This is a convenience function to set the input table and the x, y column for the plot.

Reimplemented in vtkPlotBag, vtkPlotParallelCoordinates, vtkPlotBox, and vtkPlotHistogram2D.

void vtkPlot::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 vtkTable* vtkPlot::GetInput ( )

virtual

Get the input table used by the plot.

virtual void vtkPlot::SetInputArray	(	int	index,
		const vtkStdString &	name
	)

virtual

Convenience function to set the input arrays.

For most plots index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.

Reimplemented in vtkPlotBar, and vtkPlotStacked.

virtual void vtkPlot::SetSelectable ( bool )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

virtual bool vtkPlot::GetSelectable ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

virtual void vtkPlot::SelectableOn ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

virtual void vtkPlot::SelectableOff ( )

virtual

Set whether the plot can be selected.

True by default. If not, then SetSelection(), SelectPoints() or SelectPointsInPolygon() won't have any effect.

See also: SetSelection(), SelectPoints(), SelectPointsInPolygon()

virtual void vtkPlot::SetSelection ( vtkIdTypeArray * id )

virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also: SetSelectable()

virtual vtkIdTypeArray* vtkPlot::GetSelection ( )

virtual

Sets the list of points that must be selected.

If Selectable is false, then this method does nothing.

See also: SetSelectable()

virtual vtkAxis* vtkPlot::GetXAxis ( )

virtual

Get/set the X axis associated with this plot.

virtual void vtkPlot::SetXAxis ( vtkAxis * axis )

virtual

Get/set the X axis associated with this plot.

virtual vtkAxis* vtkPlot::GetYAxis ( )

virtual

Get/set the Y axis associated with this plot.

virtual void vtkPlot::SetYAxis ( vtkAxis * axis )

virtual

Get/set the Y axis associated with this plot.

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

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

vtkRectd vtkPlot::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.

The chart that owns the plot should set this and ensure the appropriate matrix is used when rendering the plot.

virtual void vtkPlot::GetBounds ( double bounds[4] )

inlinevirtual

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

See GetUnscaledInputBounds for more information.

Reimplemented in vtkPlotBar, vtkPlotFunctionalBag, vtkPlotStacked, vtkPlotPoints, vtkPlotHistogram2D, vtkPlotArea, vtkPlotParallelCoordinates, vtkControlPointsItem, and vtkScalarsToColorsItem.

Definition at line 336 of file vtkPlot.h.

virtual void vtkPlot::GetUnscaledInputBounds ( double bounds[4] )

inlinevirtual

Provide un-log-scaled bounds for the plot inputs.

This function is analogous to GetBounds() with 2 exceptions:

It will never return log-scaled bounds even when the x- and/or y-axes are log-scaled.
It will always return the bounds along the input axes rather than the output chart coordinates. Thus GetXAxis() returns the axis associated with the first 2 bounds entries and GetYAxis() returns the axis associated with the next 2 bounds entries.

For example, vtkPlotBar's GetBounds() method will swap axis bounds when its orientation is vertical while its GetUnscaledInputBounds() will not swap axis bounds.

This method is provided so user interfaces can determine whether or not to allow log-scaling of a particular vtkAxis.

Subclasses of vtkPlot are responsible for implementing this function to transform input plot data.

The returned bounds are stored as (Xmin, Xmax, Ymin, Ymax).

Reimplemented in vtkPlotBar, vtkPlotFunctionalBag, vtkPlotStacked, and vtkPlotPoints.

Definition at line 363 of file vtkPlot.h.

virtual void vtkPlot::UpdateCache ( )

inlinevirtual

Subclasses that build data caches to speed up painting should override this method to update such caches.

This is called on each Paint, hence subclasses must add checks to avoid rebuilding of cache, unless necessary. Default implementation is empty.

Reimplemented in vtkPlotArea.

Definition at line 376 of file vtkPlot.h.

virtual void vtkPlot::SetProperty	(	const vtkStdString &	property,
		const vtkVariant &	var
	)

virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

virtual vtkVariant vtkPlot::GetProperty ( const vtkStdString & property )

virtual

A General setter/getter that should be overridden.

It can silently drop options, case is important

vtkStdString vtkPlot::GetNumber	(	double	position,
		vtkAxis *	axis
	)

protected

Get the properly formatted number for the supplied position and axis.

Member Data Documentation

vtkSmartPointer<vtkPen> vtkPlot::Pen

protected

This object stores the vtkPen that controls how the plot is drawn.

Definition at line 399 of file vtkPlot.h.

vtkSmartPointer<vtkBrush> vtkPlot::Brush

protected

This object stores the vtkBrush that controls how the plot is drawn.

Definition at line 404 of file vtkPlot.h.

vtkSmartPointer<vtkPen> vtkPlot::SelectionPen

protected

This object stores the vtkPen that controls how the selected elements of the plot are drawn.

Definition at line 410 of file vtkPlot.h.

vtkSmartPointer<vtkBrush> vtkPlot::SelectionBrush

protected

This object stores the vtkBrush that controls how the selected elements of the plot are drawn.

Definition at line 416 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::Labels

protected

Plot labels, used by legend.

Definition at line 421 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::AutoLabels

protected

Holds Labels when they're auto-created.

Definition at line 426 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::IndexedLabels

protected

Holds Labels when they're auto-created.

Definition at line 431 of file vtkPlot.h.

bool vtkPlot::UseIndexForXSeries

protected

Use the Y array index for the X value.

If true any X column setting will be ignored, and the X values will simply be the index of the Y column.

Definition at line 437 of file vtkPlot.h.

vtkSmartPointer<vtkContextMapper2D> vtkPlot::Data

protected

This data member contains the data that will be plotted, it inherits from vtkAlgorithm.

Definition at line 443 of file vtkPlot.h.

bool vtkPlot::Selectable

protected

Whether plot points can be selected or not.

Definition at line 448 of file vtkPlot.h.

vtkIdTypeArray* vtkPlot::Selection

protected

Selected indices for the table the plot is rendering.

Definition at line 453 of file vtkPlot.h.

vtkAxis* vtkPlot::XAxis

protected

The X axis associated with this plot.

Definition at line 458 of file vtkPlot.h.

vtkAxis* vtkPlot::YAxis

protected

The X axis associated with this plot.

Definition at line 463 of file vtkPlot.h.

vtkStdString vtkPlot::TooltipLabelFormat

protected

A printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 469 of file vtkPlot.h.

vtkStdString vtkPlot::TooltipDefaultLabelFormat

protected

The default printf-style string to build custom tooltip labels from.

See the accessor/mutator functions for full documentation.

Definition at line 475 of file vtkPlot.h.

int vtkPlot::TooltipNotation

protected

Definition at line 477 of file vtkPlot.h.

int vtkPlot::TooltipPrecision

protected

Definition at line 478 of file vtkPlot.h.

vtkRectd vtkPlot::ShiftScale

protected

The current shift in origin and scaling factor applied to the plot.

Definition at line 483 of file vtkPlot.h.

bool vtkPlot::LegendVisibility

protected

Definition at line 485 of file vtkPlot.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Charts/Core/vtkPlot.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation