Factory class for drawing box plot charts. More...

#include <vtkChartBox.h>

Inheritance diagram for vtkChartBox:

Collaboration diagram for vtkChartBox:

Public Types
typedef vtkChart	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkChartBox *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
void	SetColumnVisibilityAll (bool visible)
vtkIdType	GetColumnId (const vtkStdString &name)
virtual int	GetSelectedColumn ()
virtual void	SetSelectedColumn (int)
virtual vtkPlot *	GetPlot (vtkIdType index)
virtual vtkIdType	GetNumberOfPlots ()
virtual vtkAxis *	GetYAxis ()
virtual float	GetXPosition (int index)
virtual vtkIdType	GetNumberOfVisibleColumns ()
virtual void	SetPlot (vtkPlotBox *plot)
virtual bool	Hit (const vtkContextMouseEvent &mouse)
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
virtual void	SetTooltip (vtkTooltipItem *tooltip)
virtual vtkTooltipItem *	GetTooltip ()

void	SetColumnVisibility (const vtkStdString &name, bool visible)
void	SetColumnVisibility (vtkIdType column, bool visible)

bool	GetColumnVisibility (const vtkStdString &name)
bool	GetColumnVisibility (vtkIdType column)

virtual vtkStringArray *	GetVisibleColumns ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkChartBox *	SafeDownCast (vtkObjectBase *o)
static vtkChartBox *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
void	ResetSelection ()
void	UpdateGeometry (vtkContext2D *)
void	CalculatePlotTransform ()
void	SwapAxes (int a1, int a2)
int	LocatePointInPlot (const vtkVector2f &position, const vtkVector2f &tolerance, vtkVector2f &plotPos, vtkPlot *plot, vtkIdType &segmentIndex)

bool	LocatePointInPlots (const vtkContextMouseEvent &mouse, int invokeEvent=-1)
Protected Attributes
bool	GeometryValid
vtkIdTypeArray *	Selection
vtkStringArray *	VisibleColumns
vtkTimeStamp	BuildTime
vtkSmartPointer< vtkTooltipItem >	Tooltip

Private *	Storage

int	SelectedColumn
float	SelectedColumnDelta
virtual void	SetTooltipInfo (const vtkContextMouseEvent &, const vtkVector2d &, vtkIdType, vtkPlot *, vtkIdType segmentIndex=-1)
	vtkChartBox ()
	~vtkChartBox ()

Detailed Description

Factory class for drawing box plot charts.

This defines the interface for a box plot chart.

Tests:: vtkChartBox (Tests)

Definition at line 38 of file vtkChartBox.h.

Member Typedef Documentation

typedef vtkChart vtkChartBox::Superclass

Reimplemented from vtkChart.

Definition at line 41 of file vtkChartBox.h.

Constructor & Destructor Documentation

vtkChartBox::vtkChartBox ( ) [protected]

Set the information passed to the tooltip.

vtkChartBox::~vtkChartBox ( ) [protected]

Set the information passed to the tooltip.

Member Function Documentation

static int vtkChartBox::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 vtkChartBox::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 vtkChartBox* vtkChartBox::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkChart.

virtual vtkObjectBase* vtkChartBox::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkChart.

vtkChartBox* vtkChartBox::NewInstance ( ) const

Reimplemented from vtkChart.

virtual void vtkChartBox::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 vtkChartBox* vtkChartBox::New ( ) [static]

Creates a parallel coordinates chart

Reimplemented from vtkObject.

virtual void vtkChartBox::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 vtkAbstractContextItem.

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

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

Implements vtkChart.

void vtkChartBox::SetColumnVisibility	(	const vtkStdString &	name,
		bool	visible
	)

Set the visibility of the specified column.

void vtkChartBox::SetColumnVisibility	(	vtkIdType	column,
		bool	visible
	)

Set the visibility of the specified column.

void vtkChartBox::SetColumnVisibilityAll ( bool visible )

Set the visibility of all columns (true will make them all visible, false will remove all visible columns).

bool vtkChartBox::GetColumnVisibility ( const vtkStdString & name )

Get the visibility of the specified column.

bool vtkChartBox::GetColumnVisibility ( vtkIdType column )

Get the visibility of the specified column.

vtkIdType vtkChartBox::GetColumnId ( const vtkStdString & name )

Get the input table column id of a column by its name.

virtual vtkStringArray* vtkChartBox::GetVisibleColumns ( ) [virtual]

Get a list of the columns, and the order in which they are displayed.

virtual int vtkChartBox::GetSelectedColumn ( ) [virtual]

virtual void vtkChartBox::SetSelectedColumn ( int ) [virtual]

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

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

Reimplemented from vtkChart.

virtual vtkIdType vtkChartBox::GetNumberOfPlots ( ) [virtual]

Get the number of plots the chart contains.

Reimplemented from vtkChart.

virtual vtkAxis* vtkChartBox::GetYAxis ( ) [virtual]

Get the chart Y axis

virtual float vtkChartBox::GetXPosition ( int index ) [virtual]

Get the column X position by index in the visible set.

virtual vtkIdType vtkChartBox::GetNumberOfVisibleColumns ( ) [virtual]

Get the number of visible box plots in the current chart.

virtual void vtkChartBox::SetPlot ( vtkPlotBox * plot ) [virtual]

Set plot to use for the chart. Since this type of chart can only contain one plot, this will replace the previous plot.

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

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

Reimplemented from vtkAbstractContextItem.

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

Mouse move event.

Reimplemented from vtkAbstractContextItem.

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

Mouse button down event

Reimplemented from vtkAbstractContextItem.

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

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

virtual void vtkChartBox::SetTooltip ( vtkTooltipItem * tooltip ) [virtual]

Set the vtkTooltipItem object that will be displayed by the chart.

virtual vtkTooltipItem* vtkChartBox::GetTooltip ( ) [virtual]

Get the vtkTooltipItem object that will be displayed by the chart.

virtual void vtkChartBox::SetTooltipInfo	(	const vtkContextMouseEvent &	,
		const vtkVector2d &	,
		vtkIdType	,
		vtkPlot *	,
		vtkIdType	segmentIndex = `-1`
	)		`[virtual]`

Set the information passed to the tooltip.

void vtkChartBox::ResetSelection ( ) [protected]

void vtkChartBox::UpdateGeometry ( vtkContext2D * ) [protected]

void vtkChartBox::CalculatePlotTransform ( ) [protected]

void vtkChartBox::SwapAxes	(	int	a1,
		int	a2
	)		`[protected]`

bool vtkChartBox::LocatePointInPlots	(	const vtkContextMouseEvent &	mouse,
		int	invokeEvent = `-1`
	)		`[protected]`

Try to locate a point within the plots to display in a tooltip. If invokeEvent is greater than 0, then an event will be invoked if a point is at that mouse position.

int vtkChartBox::LocatePointInPlot	(	const vtkVector2f &	position,
		const vtkVector2f &	tolerance,
		vtkVector2f &	plotPos,
		vtkPlot *	plot,
		vtkIdType &	segmentIndex
	)		`[protected]`