vtkChartXY Class Reference

#include <vtkChartXY.h>

Inheritance diagram for vtkChartXY:

[legend]

Collaboration diagram for vtkChartXY:

[legend]

List of all members.

Detailed Description

Factory class for drawing XY charts.

This class implements an XY chart.

Tests:: vtkChartXY (Tests)

Definition at line 40 of file vtkChartXY.h.


Public Types
typedef vtkChart	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
virtual vtkPlot *	AddPlot (int type)
virtual bool	RemovePlot (vtkIdType index)
virtual void	ClearPlots ()
virtual vtkPlot *	GetPlot (vtkIdType index)
virtual vtkIdType	GetNumberOfPlots ()
int	GetPlotCorner (vtkPlot *plot)
void	SetPlotCorner (vtkPlot *plot, int corner)
virtual vtkAxis *	GetAxis (int axisIndex)
virtual vtkIdType	GetNumberOfAxes ()
virtual void	RecalculateBounds ()
virtual bool	Hit (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	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
virtual void	SetScene (vtkContextScene *scene)

virtual void	SetDrawAxesAtOrigin (bool)
virtual bool	GetDrawAxesAtOrigin ()

virtual void	SetAutoAxes (bool)
virtual bool	GetAutoAxes ()

virtual void	SetBarWidthFraction (float)
virtual float	GetBarWidthFraction ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkChartXY *	SafeDownCast (vtkObject *o)
static vtkChartXY *	New ()
Protected Member Functions
	vtkChartXY ()
	~vtkChartXY ()
void	RecalculatePlotTransforms ()
void	RecalculatePlotBounds ()
virtual void	ProcessSelectionEvent (vtkObject caller, void callData)

void	RecalculatePlotTransform (vtkAxis x, vtkAxis y, vtkTransform2D *transform)
Protected Attributes
vtkChartLegend *	Legend
vtkTooltipItem *	Tooltip
bool	PlotTransformValid
float	BoxOrigin [2]
float	BoxGeometry [2]
bool	DrawBox
bool	DrawNearestPoint
bool	DrawAxesAtOrigin
bool	AutoAxes
float	BarWidthFraction
bool	LayoutChanged

vtkPlotGrid *	Grid
vtkPlotGrid *	Grid2

Member Typedef Documentation

typedef vtkChart vtkChartXY::Superclass

Reimplemented from vtkChart.

Definition at line 43 of file vtkChartXY.h.

Constructor & Destructor Documentation

vtkChartXY::vtkChartXY ( ) [protected]

vtkChartXY::~vtkChartXY ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkChart.

static int vtkChartXY::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 vtkChart.

virtual int vtkChartXY::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 vtkChart.

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

Reimplemented from vtkChart.

virtual void vtkChartXY::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 vtkChart.

static vtkChartXY* vtkChartXY::New ( ) [static]

Creates a 2D Chart object.

Reimplemented from vtkObject.

virtual void vtkChartXY::Update ( ) [virtual]

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::Paint ( vtkContext2D * painter ) [virtual]

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

Implements vtkChart.

virtual vtkPlot* vtkChartXY::AddPlot ( int type ) [virtual]

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

Reimplemented from vtkChart.

virtual bool vtkChartXY::RemovePlot ( vtkIdType index ) [virtual]

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

Reimplemented from vtkChart.

virtual void vtkChartXY::ClearPlots ( ) [virtual]

Remove all plots from the chart.

Reimplemented from vtkChart.

virtual vtkPlot* vtkChartXY::GetPlot ( vtkIdType index ) [virtual]

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

Reimplemented from vtkChart.

virtual vtkIdType vtkChartXY::GetNumberOfPlots ( ) [virtual]

Get the number of plots the chart contains.

Reimplemented from vtkChart.

int vtkChartXY::GetPlotCorner ( vtkPlot * plot )

Figure out which quadrant the plot is in.

void vtkChartXY::SetPlotCorner	(	vtkPlot *	plot,
		int	corner
	)

Figure out which quadrant the plot is in.

virtual vtkAxis* vtkChartXY::GetAxis ( int axisIndex ) [virtual]

Get the axis specified by axisIndex. This should probably be improved either using a string or enum to select the axis. (0 - left, 1 - bottom, 2 - right, 3 - top).

Reimplemented from vtkChart.

virtual vtkIdType vtkChartXY::GetNumberOfAxes ( ) [virtual]

Get the number of axes in the current chart.

Reimplemented from vtkChart.

virtual void vtkChartXY::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 from vtkChart.

virtual void vtkChartXY::SetDrawAxesAtOrigin ( bool ) [virtual]

If true then the axes will be drawn at the origin (scientific style).

virtual bool vtkChartXY::GetDrawAxesAtOrigin ( ) [virtual]

If true then the axes will be drawn at the origin (scientific style).

virtual void vtkChartXY::SetAutoAxes ( bool ) [virtual]

If true then the axes will be turned on and off depending upon whether any plots are in that corner. Defaults to true.

virtual bool vtkChartXY::GetAutoAxes ( ) [virtual]

If true then the axes will be turned on and off depending upon whether any plots are in that corner. Defaults to true.

virtual void vtkChartXY::SetBarWidthFraction ( float ) [virtual]

Set the width fraction for any bar charts drawn in this chart. It is assumed that all bar plots will use the same array for the X axis, and that this array is regularly spaced. The delta between the first two x values is used to calculated the width of the bars, and subdivided between each bar. The default value is 0.8, 1.0 would lead to bars that touch.

virtual float vtkChartXY::GetBarWidthFraction ( ) [virtual]

Set the width fraction for any bar charts drawn in this chart. It is assumed that all bar plots will use the same array for the X axis, and that this array is regularly spaced. The delta between the first two x values is used to calculated the width of the bars, and subdivided between each bar. The default value is 0.8, 1.0 would lead to bars that touch.

virtual bool vtkChartXY::Hit ( const vtkContextMouseEvent & mouse ) [virtual]

Return true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseEnterEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse enter event.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseMoveEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse move event.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseLeaveEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse leave event.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseButtonPressEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse button down event

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseButtonReleaseEvent ( const vtkContextMouseEvent & mouse ) [virtual]

Mouse button release event.

Reimplemented from vtkContextItem.

virtual bool vtkChartXY::MouseWheelEvent	(	const vtkContextMouseEvent &	mouse,
		int	delta
	)			`[virtual]`

Mouse wheel event, positive delta indicates forward movement of the wheel.

Reimplemented from vtkContextItem.

virtual void vtkChartXY::SetScene ( vtkContextScene * scene ) [virtual]

Set the vtkContextScene for the item, always set for an item in a scene.

Reimplemented from vtkContextItem.

void vtkChartXY::RecalculatePlotTransforms ( ) [protected]

Recalculate the necessary transforms.

void vtkChartXY::RecalculatePlotTransform	(	vtkAxis *	x,
		vtkAxis *	y,
		vtkTransform2D *	transform
	)			`[protected]`

Recalculate the supplied transform for the two axes.

void vtkChartXY::RecalculatePlotBounds ( ) [protected]

Calculate the optimal zoom level such that all of the points to be plotted will fit into the plot area.

virtual void vtkChartXY::ProcessSelectionEvent	(	vtkObject *	caller,
		void *	callData
	)			`[protected, virtual]`

Process a rubber band selection event.

Member Data Documentation

vtkPlotGrid* vtkChartXY::Grid [protected]

The grid for the chart.

Definition at line 170 of file vtkChartXY.h.

vtkPlotGrid* vtkChartXY::Grid2 [protected]

The grid for the chart.

Definition at line 171 of file vtkChartXY.h.

vtkChartLegend* vtkChartXY::Legend [protected]

The legend for the chart.

Definition at line 175 of file vtkChartXY.h.

vtkTooltipItem* vtkChartXY::Tooltip [protected]

The tooltip item for the chart - can be used to display extra information.

Definition at line 179 of file vtkChartXY.h.

bool vtkChartXY::PlotTransformValid [protected]

Does the plot area transform need to be recalculated?

Definition at line 182 of file vtkChartXY.h.

float vtkChartXY::BoxOrigin[2] [protected]

The origin of the box when selecting a region of the chart.

Definition at line 185 of file vtkChartXY.h.

float vtkChartXY::BoxGeometry[2] [protected]

The width and height of the selection box.

Definition at line 188 of file vtkChartXY.h.

bool vtkChartXY::DrawBox [protected]

Should the box be drawn (could be selection, zoom etc).

Definition at line 191 of file vtkChartXY.h.

bool vtkChartXY::DrawNearestPoint [protected]

Should we draw the location of the nearest point on the plot?

Definition at line 194 of file vtkChartXY.h.

bool vtkChartXY::DrawAxesAtOrigin [protected]

Keep the axes drawn at the origin? This will attempt to keep the axes drawn at the origin, i.e. 0.0, 0.0 for the chart. This is often the preferred way of drawing scientific/mathematical charts.

Definition at line 199 of file vtkChartXY.h.

bool vtkChartXY::AutoAxes [protected]

Should axes be turned on and off automatically - defaults to on.

Definition at line 202 of file vtkChartXY.h.

float vtkChartXY::BarWidthFraction [protected]

The fraction of the interval taken up along the x axis by any bars that are drawn on the chart.

Definition at line 206 of file vtkChartXY.h.

bool vtkChartXY::LayoutChanged [protected]

Indicate if the layout has changed in some way that would require layout code to be called.

Definition at line 210 of file vtkChartXY.h.

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

dox/Charts/vtkChartXY.h

vtkChartXY 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