vtkPlot Class Reference

#include <vtkPlot.h>

Inheritance diagram for vtkPlot:

[legend]

Collaboration diagram for vtkPlot:

[legend]

List of all members.

Detailed Description

Abstract class for 2D plots.

Tests:: vtkPlot (Tests)

Definition at line 40 of file vtkPlot.h.


Public Types
typedef vtkContextItem	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	PaintLegend (vtkContext2D *painter, float rect[4])
virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
virtual void	SetWidth (float width)
virtual float	GetWidth ()
const char *	GetLabel ()
virtual vtkTable *	GetInput ()
virtual void	SetInputArray (int index, const char *name)
virtual void	SetSelection (vtkIdTypeArray *id)
virtual vtkIdTypeArray *	GetSelection ()
virtual void	GetBounds (double bounds[4])

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

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

virtual vtkPen *	GetPen ()

virtual vtkBrush *	GetBrush ()

virtual void	SetLabel (const char *)

virtual vtkContextMapper2D *	GetData ()

virtual bool	GetUseIndexForXSeries ()

virtual void	SetUseIndexForXSeries (bool)

virtual void	SetInput (vtkTable *table)
virtual void	SetInput (vtkTable table, const char xColumn, const char *yColumn)
void	SetInput (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)

virtual vtkAxis *	GetXAxis ()
virtual void	SetXAxis (vtkAxis *axis)

virtual vtkAxis *	GetYAxis ()
virtual void	SetYAxis (vtkAxis *axis)

void	SetProperty (const char property, vtkVariant var)
vtkVariant	GetProperty (const char *property)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlot *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPlot ()
	~vtkPlot ()
Protected Attributes
vtkPen *	Pen
vtkBrush *	Brush
char *	Label
bool	UseIndexForXSeries
vtkContextMapper2D *	Data
vtkIdTypeArray *	Selection
vtkAxis *	XAxis
vtkAxis *	YAxis

Member Typedef Documentation

typedef vtkContextItem vtkPlot::Superclass

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

Definition at line 43 of file vtkPlot.h.

Constructor & Destructor Documentation

vtkPlot::vtkPlot ( ) [protected]

vtkPlot::~vtkPlot ( ) [protected]

Member Function Documentation

virtual const char* vtkPlot::GetClassName ( ) [virtual]

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

static int vtkPlot::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

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 vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

static vtkPlot* vtkPlot::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkContextItem.

Reimplemented in vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

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 vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

virtual bool vtkPlot::PaintLegend	(	vtkContext2D *	painter,
		float	rect[4]
	)			`[virtual]`

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 in vtkPlotBar, vtkPlotLine, vtkPlotParallelCoordinates, and vtkPlotPoints.

virtual bool vtkPlot::GetNearestPoint	(	const vtkVector2f &	point,
		const vtkVector2f &	tolerance,
		vtkVector2f *	location
	)			`[virtual]`

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

Reimplemented in vtkPlotBar, vtkPlotParallelCoordinates, and vtkPlotPoints.

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

Reimplemented in vtkPlotPoints.

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

Set the plot color

Reimplemented in vtkPlotBar.

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

Set the plot color

Reimplemented in vtkPlotBar.

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

Set the plot color

Reimplemented in vtkPlotBar.

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.

virtual vtkPen* vtkPlot::GetPen ( ) [virtual]

Get a pointer to the vtkPen object that controls the was this plot draws lines.

virtual vtkBrush* vtkPlot::GetBrush ( ) [virtual]

Get a pointer to the vtkBrush object that controls the was this plot fills shapes.

virtual void vtkPlot::SetLabel ( const char * ) [virtual]

Set the plot label.

const char* vtkPlot::GetLabel ( )

Get the plot label.

virtual vtkContextMapper2D* vtkPlot::GetData ( ) [virtual]

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::SetInput ( vtkTable * table ) [virtual]

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

Reimplemented in vtkPlotParallelCoordinates.

virtual void vtkPlot::SetInput	(	vtkTable *	table,
		const char *	xColumn,
		const char *	yColumn
	)			`[virtual]`

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

Reimplemented in vtkPlotParallelCoordinates.

void vtkPlot::SetInput	(	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 char *	name
	)			`[virtual]`

Convenience function to set the input arrays. For most mappers index 0 is the x axis, and index 1 is the y axis. The name is the name of the column in the vtkTable.

virtual void vtkPlot::SetSelection ( vtkIdTypeArray * id ) [virtual]

virtual vtkIdTypeArray* vtkPlot::GetSelection ( ) [virtual]

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.

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

Reimplemented in vtkPlotBar, vtkPlotParallelCoordinates, and vtkPlotPoints.

Definition at line 150 of file vtkPlot.h.

void vtkPlot::SetProperty	(	const char *	property,
		vtkVariant *	var
	)

A General setter/getter that should be overridden. It can silently drop options, case is important

vtkVariant vtkPlot::GetProperty ( const char * property )

A General setter/getter that should be overridden. It can silently drop options, case is important

Member Data Documentation

vtkPen* vtkPlot::Pen [protected]

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

Definition at line 168 of file vtkPlot.h.

vtkBrush* vtkPlot::Brush [protected]

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

Definition at line 171 of file vtkPlot.h.

char* vtkPlot::Label [protected]

Plot label, used by legend.

Definition at line 174 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 179 of file vtkPlot.h.

vtkContextMapper2D* vtkPlot::Data [protected]

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

Definition at line 183 of file vtkPlot.h.

vtkIdTypeArray* vtkPlot::Selection [protected]

Selected indices for the table the plot is rendering

Definition at line 186 of file vtkPlot.h.

vtkAxis* vtkPlot::XAxis [protected]

The X axis associated with this plot.

Definition at line 189 of file vtkPlot.h.

vtkAxis* vtkPlot::YAxis [protected]

The X axis associated with this plot.

Definition at line 192 of file vtkPlot.h.

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

dox/Charts/vtkPlot.h

vtkPlot Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation