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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPlot *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

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

virtual void	SetWidth (float width)

virtual float	GetWidth ()

virtual void	SetLabel (const vtkStdString &label)

virtual vtkStdString	GetLabel ()

virtual void	SetLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetLabels ()

virtual int	GetNumberOfLabels ()

vtkStdString	GetLabel (vtkIdType index)

void	SetIndexedLabels (vtkStringArray *labels)

virtual vtkStringArray *	GetIndexedLabels ()

vtkContextMapper2D *	GetData ()

virtual vtkTable *	GetInput ()

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

virtual void	UpdateCache ()


virtual void	SetLegendVisibility (bool)

virtual bool	GetLegendVisibility ()

virtual void	LegendVisibilityOn ()

virtual void	LegendVisibilityOff ()


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


virtual void	SetTooltipLabelFormat (const vtkStdString &label)

virtual vtkStdString	GetTooltipLabelFormat ()


virtual void	SetTooltipNotation (int notation)

virtual int	GetTooltipNotation ()


virtual void	SetTooltipPrecision (int precision)

virtual int	GetTooltipPrecision ()


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


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


virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)


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

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

virtual void	GetColor (double rgb[3])

void	GetColor (unsigned char rgb[3])


void	SetPen (vtkPen *pen)

vtkPen *	GetPen ()


void	SetBrush (vtkBrush *brush)

vtkBrush *	GetBrush ()


void	SetSelectionPen (vtkPen *pen)

vtkPen *	GetSelectionPen ()


void	SetSelectionBrush (vtkBrush *brush)

vtkBrush *	GetSelectionBrush ()


virtual bool	GetUseIndexForXSeries ()


virtual void	SetUseIndexForXSeries (bool)


virtual void	SetInputData (vtkTable *table)

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

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


virtual void	SetSelectable (bool)

virtual bool	GetSelectable ()

virtual void	SelectableOn ()

virtual void	SelectableOff ()


virtual void	SetSelection (vtkIdTypeArray *id)

virtual vtkIdTypeArray *	GetSelection ()


virtual vtkAxis *	GetXAxis ()

virtual void	SetXAxis (vtkAxis *axis)


virtual vtkAxis *	GetYAxis ()

virtual void	SetYAxis (vtkAxis *axis)


void	SetShiftScale (const vtkRectd &scaling)

vtkRectd	GetShiftScale ()


virtual void	GetBounds (double bounds[4])


virtual void	GetUnscaledInputBounds (double bounds[4])


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

virtual vtkVariant	GetProperty (const vtkStdString &property)

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

virtual double	GetOpacity ()

virtual void	SetOpacity (double)

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

virtual void	Update ()

virtual bool	Paint (vtkContext2D *painter)

virtual bool	PaintChildren (vtkContext2D *painter)

virtual void	ReleaseGraphicsResources ()

unsigned int	AddItem (vtkAbstractContextItem *item)

bool	RemoveItem (vtkAbstractContextItem *item)

bool	RemoveItem (unsigned int index)

vtkAbstractContextItem *	GetItem (unsigned int index)

unsigned int	GetItemIndex (vtkAbstractContextItem *item)

unsigned int	GetNumberOfItems ()

void	ClearItems ()

unsigned int	Raise (unsigned int index)

unsigned int	Lower (unsigned int index)

virtual bool	Hit (const vtkContextMouseEvent &mouse)

virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)

virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)

virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)

virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)

virtual void	SetScene (vtkContextScene *scene)

virtual void	SetParent (vtkAbstractContextItem *parent)

virtual vtkVector2f	MapToParent (const vtkVector2f &point)

virtual vtkVector2f	MapFromParent (const vtkVector2f &point)

virtual vtkVector2f	MapToScene (const vtkVector2f &point)

virtual vtkVector2f	MapFromScene (const vtkVector2f &point)

virtual unsigned int	StackAbove (unsigned int index, unsigned int under)

virtual unsigned int	StackUnder (unsigned int child, unsigned int above)

virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)

vtkContextScene *	GetScene ()

vtkAbstractContextItem *	GetParent ()

virtual bool	GetVisible ()

virtual void	SetVisible (bool)

virtual bool	GetInteractive ()

virtual void	SetInteractive (bool)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

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 )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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 int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPlot ()

	~vtkPlot ()

vtkStdString	GetNumber (double position, vtkAxis *axis)

Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()

	~vtkContextItem ()

Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()

	~vtkAbstractContextItem ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkSmartPointer< vtkPen >	Pen

vtkSmartPointer< vtkBrush >	Brush

vtkSmartPointer< vtkPen >	SelectionPen

vtkSmartPointer< vtkBrush >	SelectionBrush

vtkSmartPointer< vtkStringArray >	Labels

vtkSmartPointer< vtkStringArray >	AutoLabels

vtkSmartPointer< vtkStringArray >	IndexedLabels

bool	UseIndexForXSeries

vtkSmartPointer< vtkContextMapper2D >	Data

bool	Selectable

vtkIdTypeArray *	Selection

vtkAxis *	XAxis

vtkAxis *	YAxis

vtkStdString	TooltipLabelFormat

vtkStdString	TooltipDefaultLabelFormat

int	TooltipNotation

int	TooltipPrecision

vtkRectd	ShiftScale

bool	LegendVisibility

Protected Attributes inherited from vtkContextItem
double	Opacity

Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene

vtkAbstractContextItem *	Parent

vtkContextScenePrivate *	Children

bool	Visible

bool	Interactive

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 51 of file vtkPlot.h.

Member Typedef Documentation

typedef vtkContextItem vtkPlot::Superclass

Definition at line 54 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, vtkPlotPoints, vtkPlotBar, vtkPlotStacked, 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, vtkPlotFunctionalBag, vtkPlotHistogram2D, vtkPlotStacked, 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, vtkPlotPoints, vtkControlPointsItem, vtkPlotFunctionalBag, and vtkPlotStacked.

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, vtkPlotPoints, vtkPlotStacked, vtkPlotHistogram2D, vtkPlotParallelCoordinates, vtkControlPointsItem, vtkPlotArea, and vtkScalarsToColorsItem.

Definition at line 276 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: 1. It will never return log-scaled bounds even when the x- and/or y-axes are log-scaled. 2. 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, vtkPlotPoints, and vtkPlotStacked.

Definition at line 295 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 307 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 327 of file vtkPlot.h.

vtkSmartPointer<vtkBrush> vtkPlot::Brush

protected

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

Definition at line 330 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 334 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 338 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::Labels

protected

Plot labels, used by legend.

Definition at line 341 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::AutoLabels

protected

Holds Labels when they're auto-created

Definition at line 344 of file vtkPlot.h.

vtkSmartPointer<vtkStringArray> vtkPlot::IndexedLabels

protected

Holds Labels when they're auto-created

Definition at line 347 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 352 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 356 of file vtkPlot.h.

bool vtkPlot::Selectable

protected

Whether plot points can be selected or not.

Definition at line 359 of file vtkPlot.h.

vtkIdTypeArray* vtkPlot::Selection

protected

Selected indices for the table the plot is rendering

Definition at line 362 of file vtkPlot.h.

vtkAxis* vtkPlot::XAxis

protected

The X axis associated with this plot.

Definition at line 365 of file vtkPlot.h.

vtkAxis* vtkPlot::YAxis

protected

The X axis associated with this plot.

Definition at line 368 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 372 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 376 of file vtkPlot.h.

int vtkPlot::TooltipNotation

protected

Definition at line 378 of file vtkPlot.h.

int vtkPlot::TooltipPrecision

protected

Definition at line 379 of file vtkPlot.h.

vtkRectd vtkPlot::ShiftScale

protected

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

Definition at line 382 of file vtkPlot.h.

bool vtkPlot::LegendVisibility

protected

Definition at line 384 of file vtkPlot.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-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