vtkBarChartActor Class Reference

#include <vtkBarChartActor.h>

Inheritance diagram for vtkBarChartActor:

Inheritance graph
[legend]
Collaboration diagram for vtkBarChartActor:

Collaboration graph
[legend]

List of all members.


Detailed Description

create a bar chart from an array

vtkBarChartActor generates a bar chart from an array of numbers defined in field data (a vtkDataObject). To use this class, you must specify an input data object. You'll probably also want to specify the position of the plot be setting the Position and Position2 instance variables, which define a rectangle in which the plot lies. There are also many other instance variables that control the look of the plot includes its title and legend.

Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated with these components.

See also:
vtkParallelCoordinatesActor vtkXYPlotActor vtkSpiderPlotActor vtkPieChartActor
Tests:
vtkBarChartActor (Tests)

Definition at line 51 of file vtkBarChartActor.h.

typedef vtkActor2D Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkBarChartActorSafeDownCast (vtkObject *o)

Public Member Functions

virtual void SetInput (vtkDataObject *)
virtual int HasTranslucentPolygonalGeometry ()
void ReleaseGraphicsResources (vtkWindow *)
virtual vtkDataObjectGetInput ()
virtual void SetTitleVisibility (int)
virtual int GetTitleVisibility ()
virtual void TitleVisibilityOn ()
virtual void TitleVisibilityOff ()
virtual void SetTitle (const char *)
virtual char * GetTitle ()
virtual void SetTitleTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetTitleTextProperty ()
virtual void SetLabelVisibility (int)
virtual int GetLabelVisibility ()
virtual void LabelVisibilityOn ()
virtual void LabelVisibilityOff ()
virtual void SetLabelTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetLabelTextProperty ()
void SetBarColor (int i, double r, double g, double b)
void SetBarColor (int i, const double color[3])
double * GetBarColor (int i)
void SetBarLabel (const int i, const char *)
const char * GetBarLabel (int i)
virtual void SetYTitle (const char *)
virtual char * GetYTitle ()
virtual void SetLegendVisibility (int)
virtual int GetLegendVisibility ()
virtual void LegendVisibilityOn ()
virtual void LegendVisibilityOff ()
virtual vtkLegendBoxActorGetLegendActor ()
int RenderOverlay (vtkViewport *)
int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)

Static Public Member Functions

static vtkBarChartActorNew ()

Protected Member Functions

 vtkBarChartActor ()
 ~vtkBarChartActor ()

Member Typedef Documentation

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

Definition at line 56 of file vtkBarChartActor.h.


Constructor & Destructor Documentation

vtkBarChartActor::vtkBarChartActor (  )  [protected]

vtkBarChartActor::~vtkBarChartActor (  )  [protected]


Member Function Documentation

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

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

static int vtkBarChartActor::IsTypeOf ( const char *  type  )  [static]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

virtual int vtkBarChartActor::IsA ( const char *  type  )  [virtual]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

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

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

void vtkBarChartActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

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

Instantiate this class.

Reimplemented from vtkActor2D.

virtual void vtkBarChartActor::SetInput ( vtkDataObject  )  [virtual]

Set the input to the bar chart actor.

virtual vtkDataObject* vtkBarChartActor::GetInput (  )  [virtual]

Get the input data object to this actor.

virtual void vtkBarChartActor::SetTitleVisibility ( int   )  [virtual]

Enable/Disable the display of a plot title.

virtual int vtkBarChartActor::GetTitleVisibility (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkBarChartActor::TitleVisibilityOn (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkBarChartActor::TitleVisibilityOff (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkBarChartActor::SetTitle ( const char *   )  [virtual]

Set/Get the title of the bar chart.

virtual char* vtkBarChartActor::GetTitle (  )  [virtual]

Set/Get the title of the bar chart.

virtual void vtkBarChartActor::SetTitleTextProperty ( vtkTextProperty p  )  [virtual]

Set/Get the title text property. The property controls the appearance of the plot title.

virtual vtkTextProperty* vtkBarChartActor::GetTitleTextProperty (  )  [virtual]

Set/Get the title text property. The property controls the appearance of the plot title.

virtual void vtkBarChartActor::SetLabelVisibility ( int   )  [virtual]

Enable/Disable the display of bar labels.

virtual int vtkBarChartActor::GetLabelVisibility (  )  [virtual]

Enable/Disable the display of bar labels.

virtual void vtkBarChartActor::LabelVisibilityOn (  )  [virtual]

Enable/Disable the display of bar labels.

virtual void vtkBarChartActor::LabelVisibilityOff (  )  [virtual]

Enable/Disable the display of bar labels.

virtual void vtkBarChartActor::SetLabelTextProperty ( vtkTextProperty p  )  [virtual]

Set/Get the labels text property. This controls the appearance of all bar bar labels.

virtual vtkTextProperty* vtkBarChartActor::GetLabelTextProperty (  )  [virtual]

Set/Get the labels text property. This controls the appearance of all bar bar labels.

void vtkBarChartActor::SetBarColor ( int  i,
double  r,
double  g,
double  b 
)

Specify colors for each bar. If not specified, they are automatically generated.

void vtkBarChartActor::SetBarColor ( int  i,
const double  color[3] 
) [inline]

Specify colors for each bar. If not specified, they are automatically generated.

Definition at line 109 of file vtkBarChartActor.h.

double* vtkBarChartActor::GetBarColor ( int  i  ) 

Specify colors for each bar. If not specified, they are automatically generated.

void vtkBarChartActor::SetBarLabel ( const int  i,
const char *   
)

Specify the names of each bar. If not specified, then an integer number is automatically generated.

const char* vtkBarChartActor::GetBarLabel ( int  i  ) 

Specify the names of each bar. If not specified, then an integer number is automatically generated.

virtual void vtkBarChartActor::SetYTitle ( const char *   )  [virtual]

Specify the title of the y-axis.

virtual char* vtkBarChartActor::GetYTitle (  )  [virtual]

Specify the title of the y-axis.

virtual void vtkBarChartActor::SetLegendVisibility ( int   )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual int vtkBarChartActor::GetLegendVisibility (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual void vtkBarChartActor::LegendVisibilityOn (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual void vtkBarChartActor::LegendVisibilityOff (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual vtkLegendBoxActor* vtkBarChartActor::GetLegendActor (  )  [virtual]

Retrieve handles to the legend box. This is useful if you would like to manually control the legend appearance.

int vtkBarChartActor::RenderOverlay ( vtkViewport  )  [virtual]

Draw the bar plot.

Reimplemented from vtkActor2D.

int vtkBarChartActor::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

Draw the bar plot.

Reimplemented from vtkActor2D.

virtual int vtkBarChartActor::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [inline, virtual]

Draw the bar plot.

Reimplemented from vtkActor2D.

Definition at line 146 of file vtkBarChartActor.h.

virtual int vtkBarChartActor::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

void vtkBarChartActor::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkActor2D.


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

Generated on Wed Aug 24 11:29:19 2011 for VTK by  doxygen 1.5.6