Factory class for drawing 2D charts. More...

#include <vtkChart.h>

Inheritance diagram for vtkChart:

Collaboration diagram for vtkChart:

Classes
class	MouseActions

class	MouseClickActions

Public Types
typedef vtkContextItem	Superclass


enum	{ LINE, POINTS, BAR, STACKED, BAG, FUNCTIONALBAG, AREA }


enum	{ PAN = 0, ZOOM, ZOOM_AXIS, SELECT, SELECT_RECTANGLE = SELECT, SELECT_POLYGON, NOTIFY }


enum	EventIds { UpdateRange = 1002 }


enum	{ SELECTION_ROWS, SELECTION_PLOTS, SELECTION_COLUMNS }


enum	{ FILL_SCENE, FILL_RECT, AXES_TO_RECT }

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)

vtkChart *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual bool	Paint (vtkContext2D *painter)=0

virtual vtkPlot *	AddPlot (int type)

virtual vtkIdType	AddPlot (vtkPlot *plot)

virtual bool	RemovePlot (vtkIdType index)

virtual bool	RemovePlotInstance (vtkPlot *plot)

virtual void	ClearPlots ()

virtual vtkPlot *	GetPlot (vtkIdType index)

virtual vtkIdType	GetNumberOfPlots ()

virtual vtkAxis *	GetAxis (int axisIndex)

virtual vtkIdType	GetNumberOfAxes ()

virtual void	RecalculateBounds ()

virtual void	SetAnnotationLink (vtkAnnotationLink *link)

virtual vtkChartLegend *	GetLegend ()

void	SetBorders (int left, int bottom, int right, int top)

void	SetSize (const vtkRectf &rect)

vtkRectf	GetSize ()

virtual void	SetActionToButton (int action, int button)

virtual int	GetActionToButton (int action)

virtual void	SetClickActionToButton (int action, int button)

virtual int	GetClickActionToButton (int action)


virtual void	SetSelectionMethod (int method)

virtual int	GetSelectionMethod ()


virtual vtkAnnotationLink *	GetAnnotationLink ()


virtual void	SetGeometry (int, int)

void	SetGeometry (int[2])

virtual int *	GetGeometry ()

virtual void	GetGeometry (int &, int &)

virtual void	GetGeometry (int[2])


virtual void	SetPoint1 (int, int)

void	SetPoint1 (int[2])

virtual int *	GetPoint1 ()

virtual void	GetPoint1 (int &, int &)

virtual void	GetPoint1 (int[2])


virtual void	SetPoint2 (int, int)

void	SetPoint2 (int[2])

virtual int *	GetPoint2 ()

virtual void	GetPoint2 (int &, int &)

virtual void	GetPoint2 (int[2])


virtual void	SetShowLegend (bool visible)

virtual bool	GetShowLegend ()


virtual void	SetTitle (const vtkStdString &title)

virtual vtkStdString	GetTitle ()


virtual vtkTextProperty *	GetTitleProperties ()


void	SetBottomBorder (int border)

void	SetTopBorder (int border)

void	SetLeftBorder (int border)

void	SetRightBorder (int border)


virtual void	SetLayoutStrategy (int)

virtual int	GetLayoutStrategy ()


virtual void	SetAutoSize (bool isAutoSized)

virtual bool	GetAutoSize ()


virtual void	SetRenderEmpty (bool)

virtual bool	GetRenderEmpty ()


void	SetBackgroundBrush (vtkBrush *brush)

vtkBrush *	GetBackgroundBrush ()


virtual void	SetSelectionMode (int)

virtual int	GetSelectionMode ()

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	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 vtkChart *	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

	vtkChart ()

	~vtkChart ()

void	AttachAxisRangeListener (vtkAxis *)

void	AxisRangeForwarderCallback (vtkObject , unsigned long, void )


bool	CalculatePlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)


bool	CalculateUnscaledPlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)

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
vtkAnnotationLink *	AnnotationLink

int	Geometry [2]

int	Point1 [2]

int	Point2 [2]

bool	ShowLegend

vtkStdString	Title

vtkTextProperty *	TitleProperties

vtkRectf	Size

int	LayoutStrategy

bool	RenderEmpty

vtkSmartPointer< vtkBrush >	BackgroundBrush

int	SelectionMode

int	SelectionMethod

MouseActions	Actions

MouseClickActions	ActionsClick

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

Factory class for drawing 2D charts.

This defines the interface for a chart.

Examples:: vtkChart (Examples)

Tests:: vtkChart (Tests)

Definition at line 49 of file vtkChart.h.

Member Typedef Documentation

typedef vtkContextItem vtkChart::Superclass

Definition at line 52 of file vtkChart.h.

Member Enumeration Documentation

anonymous enum

Enum of the available chart types

Enumerator
LINE
POINTS
BAR
STACKED
BAG
FUNCTIONALBAG
AREA

Definition at line 58 of file vtkChart.h.

anonymous enum

Enum of valid chart action types. PAN - moves the axis range ZOOM - zooms to a selected rectangle ZOOM_AXIS - zooms the x and y axis range SELECT_RECTANGLE - selects points within a rectangle SELECT_POLYGON - selects points within a polygon SELECT - alias for SELECT_RECTANGLE NOTIFY - Post vtkCommand::InteractionEvent on selection of a point

Enumerator
PAN
ZOOM
ZOOM_AXIS
SELECT
SELECT_RECTANGLE
SELECT_POLYGON
NOTIFY

Definition at line 75 of file vtkChart.h.

enum vtkChart::EventIds

Enum of event type that are triggered by the charts

Enumerator
UpdateRange

Definition at line 88 of file vtkChart.h.

anonymous enum

Enumeration of the possible selection methods in a chart. SELECTION_ROWS is the default and simply selects the row in a table in all plots showing that table. SELECTION_PLOTS will make a selection in each plot, and that selection remains specific to the plot object. SELECTION_COLUMNS selects the plots that use as input the selected columns of a table.

Enumerator
SELECTION_ROWS
SELECTION_PLOTS
SELECTION_COLUMNS

Definition at line 144 of file vtkChart.h.

anonymous enum

Enum of the available layout strategies for the charts.

Enumerator
FILL_SCENE
FILL_RECT
AXES_TO_RECT

Definition at line 231 of file vtkChart.h.

Constructor & Destructor Documentation

vtkChart::vtkChart ( )

protected

vtkChart::~vtkChart ( )

protected

Member Function Documentation

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

static

virtual int vtkChart::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 vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.

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

static

virtual vtkObjectBase* vtkChart::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextItem.

Reimplemented in vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.

vtkChart* vtkChart::NewInstance ( ) const

virtual void vtkChart::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 vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.

virtual bool vtkChart::Paint ( vtkContext2D * painter )

pure virtual

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

Reimplemented from vtkAbstractContextItem.

Implemented in vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, and vtkChartPie.

virtual vtkPlot* vtkChart::AddPlot ( int type )

virtual

Add a plot to the chart, defaults to using the name of the y column

Reimplemented in vtkChartXY, and vtkChartPie.

virtual vtkIdType vtkChart::AddPlot ( vtkPlot * plot )

virtual

Add a plot to the chart. Return the index of the plot, -1 if it failed.

Reimplemented in vtkChartXY, and vtkChartPie.

virtual bool vtkChart::RemovePlot ( vtkIdType index )

virtual

Remove the plot at the specified index, returns true if successful, false if the index was invalid.

Reimplemented in vtkChartXY.

virtual bool vtkChart::RemovePlotInstance ( vtkPlot * plot )

virtual

Remove the given plot. Returns true if successful, false if the plot was not contained in this chart. Note, the base implementation of this method performs a linear search to locate the plot.

virtual void vtkChart::ClearPlots ( )

virtual

Remove all plots from the chart.

Reimplemented in vtkChartXY.

virtual vtkPlot* vtkChart::GetPlot ( vtkIdType index )

virtual

Get the plot at the specified index, returns null if the index is invalid.

Reimplemented in vtkChartBox, vtkChartXY, vtkChartParallelCoordinates, vtkChartPie, and vtkChartHistogram2D.

virtual vtkIdType vtkChart::GetNumberOfPlots ( )

virtual

Get the number of plots the chart contains.

Reimplemented in vtkChartXY, vtkChartBox, vtkChartParallelCoordinates, and vtkChartPie.

virtual vtkAxis* vtkChart::GetAxis ( int axisIndex )

virtual

Get the axis specified by axisIndex. 0 is x, 1 is y. This should probably be improved either using a string or enum to select the axis.

Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.

virtual vtkIdType vtkChart::GetNumberOfAxes ( )

virtual

Get the number of axes in the current chart.

Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.

virtual void vtkChart::RecalculateBounds ( )

virtual

Request that the chart recalculates the range of its axes. Especially useful in applications after the parameters of plots have been modified.

Reimplemented in vtkChartXY, and vtkChartParallelCoordinates.

virtual void vtkChart::SetSelectionMethod ( int method )

virtual

Set the selection method, which controls how selections are handled by the chart. The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair. SELECTION_COLUMNS selects all points of plots that correspond to selected columns.

Reimplemented in vtkChartXY.

virtual int vtkChart::GetSelectionMethod ( )

virtual

Set the selection method, which controls how selections are handled by the chart. The default is SELECTION_ROWS which selects all points in all plots in a chart that have values in the rows selected. SELECTION_PLOTS allows for finer-grained selections specific to each plot, and so to each XY column pair. SELECTION_COLUMNS selects all points of plots that correspond to selected columns.

virtual void vtkChart::SetAnnotationLink ( vtkAnnotationLink * link )

virtual

Set the vtkAnnotationLink for the chart.

virtual vtkAnnotationLink* vtkChart::GetAnnotationLink ( )

virtual

Get the vtkAnnotationLink for the chart.

virtual void vtkChart::SetGeometry	(	int	,
		int
	)

virtual

Set/get the width and the height of the chart.

void vtkChart::SetGeometry ( int [2] )

Set/get the width and the height of the chart.

virtual int* vtkChart::GetGeometry ( )

virtual

Set/get the width and the height of the chart.

virtual void vtkChart::GetGeometry	(	int &	,
		int &
	)

virtual

Set/get the width and the height of the chart.

virtual void vtkChart::GetGeometry ( int [2] )

virtual

Set/get the width and the height of the chart.

virtual void vtkChart::SetPoint1	(	int	,
		int
	)

virtual

Set/get the first point in the chart (the bottom left).

void vtkChart::SetPoint1 ( int [2] )

Set/get the first point in the chart (the bottom left).

virtual int* vtkChart::GetPoint1 ( )

virtual

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::GetPoint1	(	int &	,
		int &
	)

virtual

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::GetPoint1 ( int [2] )

virtual

Set/get the first point in the chart (the bottom left).

virtual void vtkChart::SetPoint2	(	int	,
		int
	)

virtual

Set/get the second point in the chart (the top right).

void vtkChart::SetPoint2 ( int [2] )

Set/get the second point in the chart (the top right).

virtual int* vtkChart::GetPoint2 ( )

virtual

Set/get the second point in the chart (the top right).

virtual void vtkChart::GetPoint2	(	int &	,
		int &
	)

virtual

Set/get the second point in the chart (the top right).

virtual void vtkChart::GetPoint2 ( int [2] )

virtual

Set/get the second point in the chart (the top right).

virtual void vtkChart::SetShowLegend ( bool visible )

virtual

Set/get whether the chart should draw a legend.

Reimplemented in vtkChartXY, and vtkChartPie.

virtual bool vtkChart::GetShowLegend ( )

virtual

Set/get whether the chart should draw a legend.

virtual vtkChartLegend* vtkChart::GetLegend ( )

virtual

Get the legend for the chart, if available. Can return NULL if there is no legend.

Reimplemented in vtkChartXY, and vtkChartPie.

virtual void vtkChart::SetTitle ( const vtkStdString & title )

virtual

Get/set the title text of the chart.

virtual vtkStdString vtkChart::GetTitle ( )

virtual

Get/set the title text of the chart.

virtual vtkTextProperty* vtkChart::GetTitleProperties ( )

virtual

Get the vtkTextProperty that governs how the chart title is displayed.

void vtkChart::SetBottomBorder ( int border )