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

Class for drawing an XY plot given two columns from a vtkTable. More...

#include <vtkPlotBar.h>

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

List of all members.

Public Types

typedef vtkPlot Superclass
enum  { VERTICAL = 0, HORIZONTAL }

Public Member Functions

virtual int IsA (const char *type)
vtkPlotBarNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual bool Paint (vtkContext2D *painter)
virtual void GetBounds (double bounds[4], bool unscaled)
virtual void GetBounds (double bounds[4])
virtual void GetUnscaledInputBounds (double bounds[4])
virtual void SetInputArray (int index, const vtkStdString &name)
void SetColorSeries (vtkColorSeries *colorSeries)
vtkColorSeriesGetColorSeries ()
virtual vtkStringArrayGetLabels ()
virtual void SetGroupName (const vtkStdString &name)
virtual vtkStdString GetGroupName ()
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
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 void SetWidth (float)
virtual float GetWidth ()
virtual void SetOffset (float)
virtual float GetOffset ()
virtual void SetOrientation (int orientation)
virtual int GetOrientation ()
virtual vtkStdString GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &, vtkVector2f *location, vtkIdType *segmentIndex)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPlotBarSafeDownCast (vtkObjectBase *o)
static vtkPlotBarNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPlotBar ()
 ~vtkPlotBar ()
bool UpdateTableCache (vtkTable *table)

Protected Attributes

vtkPoints2DPoints
float Width
float Offset
int Orientation
vtkTimeStamp BuildTime
vtkSmartPointer< vtkColorSeriesColorSeries

Detailed Description

Class for drawing an XY plot given two columns from a vtkTable.

Tests:
vtkPlotBar (Tests)

Definition at line 42 of file vtkPlotBar.h.


Member Typedef Documentation

Reimplemented from vtkPlot.

Definition at line 45 of file vtkPlotBar.h.


Member Enumeration Documentation

anonymous enum

Enum of bar chart oritentation types

Enumerator:
VERTICAL 
HORIZONTAL 

Definition at line 50 of file vtkPlotBar.h.


Constructor & Destructor Documentation

vtkPlotBar::vtkPlotBar ( ) [protected]
vtkPlotBar::~vtkPlotBar ( ) [protected]

Member Function Documentation

static int vtkPlotBar::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 vtkPlotBar::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* vtkPlotBar::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPlot.

Reimplemented from vtkPlot.

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

Creates a 2D Chart object.

Reimplemented from vtkObject.

virtual bool vtkPlotBar::Paint ( vtkContext2D painter) [virtual]

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

Reimplemented from vtkAbstractContextItem.

virtual bool vtkPlotBar::PaintLegend ( vtkContext2D painter,
const vtkRectf rect,
int  legendIndex 
) [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 from vtkPlot.

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

Set the plot color

Reimplemented from vtkPlot.

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

Set the plot color

Reimplemented from vtkPlot.

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

Set the plot color

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetWidth ( float  ) [virtual]

Set the width of the line.

Reimplemented from vtkPlot.

virtual float vtkPlotBar::GetWidth ( ) [virtual]

Get the width of the line.

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetOffset ( float  ) [virtual]

Set/get the horizontal offset of the bars. Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

virtual float vtkPlotBar::GetOffset ( ) [virtual]

Set/get the horizontal offset of the bars. Positive values move the bars leftward. For HORIZONTAL orientation, offsets bars vertically, with a positive value moving bars downward.

virtual void vtkPlotBar::SetOrientation ( int  orientation) [virtual]

Set/get the orientation of the bars. Valid orientations are VERTICAL (default) and HORIZONTAL.

virtual int vtkPlotBar::GetOrientation ( ) [virtual]

Set/get the orientation of the bars. Valid orientations are VERTICAL (default) and HORIZONTAL.

virtual void vtkPlotBar::GetBounds ( double  bounds[4],
bool  unscaled 
) [virtual]

A helper used by both GetUnscaledBounds and GetBounds(double[4]).

virtual void vtkPlotBar::GetBounds ( double  bounds[4]) [virtual]

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).

Reimplemented from vtkPlot.

virtual void vtkPlotBar::GetUnscaledInputBounds ( double  bounds[4]) [virtual]

Get un-log-scaled bounds for this mapper as (Xmin,Xmax,Ymin,Ymax).

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetInputArray ( int  index,
const vtkStdString name 
) [virtual]

When used to set additional arrays, stacked bars are created.

Reimplemented from vtkPlot.

void vtkPlotBar::SetColorSeries ( vtkColorSeries colorSeries)

Set the color series to use if this becomes a stacked bar plot.

Get the color series used if when this is a stacked bar plot.

virtual vtkStringArray* vtkPlotBar::GetLabels ( ) [virtual]

Get the plot labels.

Reimplemented from vtkPlot.

virtual void vtkPlotBar::SetGroupName ( const vtkStdString name) [virtual]

Set the group name of the bar chart - can be displayed on the X axis.

virtual vtkStdString vtkPlotBar::GetGroupName ( ) [virtual]

Get the group name of the bar char - can be displayed on the X axis.

virtual vtkStdString vtkPlotBar::GetTooltipLabel ( const vtkVector2f plotPos,
vtkIdType  seriesIndex,
vtkIdType  segmentIndex 
) [virtual]

Generate and return the tooltip label string for this plot The segmentIndex is implemented here.

Reimplemented from vtkPlot.

virtual bool vtkPlotBar::SelectPoints ( const vtkVector2f min,
const vtkVector2f max 
) [virtual]

Select all points in the specified rectangle.

Reimplemented from vtkPlot.

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

virtual vtkIdType vtkPlotBar::GetNearestPoint ( const vtkVector2f point,
const vtkVector2f ,
vtkVector2f location,
vtkIdType segmentIndex 
) [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. If a vtkIdType* is passed, its referent will be set to index of the bar segment with which a point is associated, or -1.

bool vtkPlotBar::UpdateTableCache ( vtkTable table) [protected]

Update the table cache.


Member Data Documentation

Store a well packed set of XY coordinates for this data series.

Definition at line 174 of file vtkPlotBar.h.

float vtkPlotBar::Width [protected]

Definition at line 176 of file vtkPlotBar.h.

Definition at line 177 of file vtkPlotBar.h.

Definition at line 179 of file vtkPlotBar.h.

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

Definition at line 182 of file vtkPlotBar.h.

The color series to use if this becomes a stacked bar

Definition at line 185 of file vtkPlotBar.h.


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