VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPlotBox Class Reference

Class for drawing box plots. More...

#include <vtkPlotBox.h>

Inheritance diagram for vtkPlotBox:
Inheritance graph
[legend]
Collaboration diagram for vtkPlotBox:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkPlot Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPlotBoxNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual vtkStringArrayGetLabels ()
void SetColumnColor (const vtkStdString &colName, double *rgb)
virtual void CreateDefaultLookupTable ()
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
virtual void SetInputData (vtkTable *table)
virtual void SetInputData (vtkTable *table, const vtkStdString &, const vtkStdString &)
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
void SetLookupTable (vtkScalarsToColors *lut)
vtkScalarsToColorsGetLookupTable ()
virtual float GetBoxWidth ()
virtual void SetBoxWidth (float)
virtual vtkTextPropertyGetTitleProperties ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlotBoxSafeDownCast (vtkObjectBase *o)
static vtkPlotBoxNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPlotBox ()
 ~vtkPlotBox ()
void DrawBoxPlot (int, unsigned char *, double, vtkContext2D *)
bool UpdateTableCache (vtkTable *table)

Protected Attributes

vtkTimeStamp BuildTime
float BoxWidth
vtkScalarsToColorsLookupTable
vtkTextPropertyTitleProperties
Private * Storage

Detailed Description

Class for drawing box plots.

Plots to draw box plots given columns from a vtkTable that may contains 5 lines with quartiles and median.

Tests:
vtkPlotBox (Tests)

Definition at line 40 of file vtkPlotBox.h.


Member Typedef Documentation

Reimplemented from vtkPlot.

Definition at line 43 of file vtkPlotBox.h.


Constructor & Destructor Documentation

vtkPlotBox::vtkPlotBox ( ) [protected]
vtkPlotBox::~vtkPlotBox ( ) [protected]

Member Function Documentation

static int vtkPlotBox::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 vtkPlot.

virtual int vtkPlotBox::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 vtkPlot.

Reimplemented from vtkPlot.

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

Reimplemented from vtkPlot.

Reimplemented from vtkPlot.

virtual void vtkPlotBox::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 vtkPlot.

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

Creates a box plot.

Reimplemented from vtkObject.

virtual void vtkPlotBox::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 vtkPlotBox::Paint ( vtkContext2D painter) [virtual]

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

Reimplemented from vtkAbstractContextItem.

virtual bool vtkPlotBox::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.

Reimplemented from vtkPlot.

virtual void vtkPlotBox::SetInputData ( vtkTable table) [virtual]

This is a convenience function to set the input table.

Reimplemented from vtkPlot.

virtual void vtkPlotBox::SetInputData ( vtkTable table,
const vtkStdString ,
const vtkStdString  
) [inline, virtual]

This is a convenience function to set the input table.

Reimplemented from vtkPlot.

Definition at line 70 of file vtkPlotBox.h.

virtual vtkStringArray* vtkPlotBox::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.

Reimplemented from vtkPlot.

virtual vtkIdType vtkPlotBox::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.

Reimplemented from vtkPlot.

Specify a lookup table for the mapper to use.

Specify a lookup table for the mapper to use.

void vtkPlotBox::SetColumnColor ( const vtkStdString colName,
double rgb 
)

Helper function to set the color of a given column.

virtual void vtkPlotBox::CreateDefaultLookupTable ( ) [virtual]

Create default lookup table. Generally used to create one when none is available with the scalar data.

virtual float vtkPlotBox::GetBoxWidth ( ) [virtual]

Get/Set the width of boxes.

virtual void vtkPlotBox::SetBoxWidth ( float  ) [virtual]

Get/Set the width of boxes.

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

void vtkPlotBox::DrawBoxPlot ( int  ,
unsigned char *  ,
double  ,
vtkContext2D  
) [protected]
bool vtkPlotBox::UpdateTableCache ( vtkTable table) [protected]

Update the table cache.


Member Data Documentation

Private* vtkPlotBox::Storage [protected]

Definition at line 126 of file vtkPlotBox.h.

The point cache is marked dirty until it has been initialized.

Definition at line 131 of file vtkPlotBox.h.

Width of boxes.

Definition at line 134 of file vtkPlotBox.h.

Lookup Table for coloring points by scalar value

Definition at line 137 of file vtkPlotBox.h.

Text properties for the plot title

Definition at line 140 of file vtkPlotBox.h.


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