vtkChartLegend Class Reference

#include <vtkChartLegend.h>

Inheritance diagram for vtkChartLegend:

Inheritance graph
[legend]
Collaboration diagram for vtkChartLegend:

Collaboration graph
[legend]

List of all members.


Detailed Description

draw the chart legend

The vtkChartLegend is drawn in screen coordinates. It is usually one of the last elements of a chart to be drawn. It renders the the mark/line for each plot, and the plot labels.

Definition at line 33 of file vtkChartLegend.h.


Public Types

enum  {
  LEFT = 0, CENTER, RIGHT, TOP,
  BOTTOM
}
typedef vtkContextItem Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
void SetPoint (const vtkVector2f &point)
const vtkVector2fGetPointVector ()
void SetChart (vtkChart *chart)
vtkChartGetChart ()
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual void SetPoint (float, float)
void SetPoint (float[2])
virtual float * GetPoint ()
virtual void GetPoint (float &, float &)
virtual void GetPoint (float[2])
virtual void SetHorizontalAlignment (int)
virtual int GetHorizontalAlignment ()
virtual void SetVerticalAlignment (int)
virtual int GetVerticalAlignment ()
virtual void SetLabelSize (int)
virtual int GetLabelSize ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkChartLegendSafeDownCast (vtkObject *o)
static vtkChartLegendNew ()

Protected Member Functions

 vtkChartLegend ()
 ~vtkChartLegend ()

Protected Attributes

float * Point
int HorizontalAlignment
int VerticalAlignment
int LabelSize
Private * Storage

Member Typedef Documentation

Reimplemented from vtkContextItem.

Definition at line 36 of file vtkChartLegend.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
LEFT 
CENTER 
RIGHT 
TOP 
BOTTOM 

Definition at line 53 of file vtkChartLegend.h.


Constructor & Destructor Documentation

vtkChartLegend::vtkChartLegend (  )  [protected]

vtkChartLegend::~vtkChartLegend (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkContextItem.

static int vtkChartLegend::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 vtkContextItem.

virtual int vtkChartLegend::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 vtkContextItem.

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

Reimplemented from vtkContextItem.

virtual void vtkChartLegend::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 vtkContextItem.

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

Creates a 2D Chart object.

Reimplemented from vtkObject.

virtual void vtkChartLegend::SetPoint ( float  ,
float   
) [virtual]

Set point the legend box is anchored to.

void vtkChartLegend::SetPoint ( float  [2]  ) 

Set point the legend box is anchored to.

virtual float* vtkChartLegend::GetPoint (  )  [virtual]

Get point the legend box is anchored to.

virtual void vtkChartLegend::GetPoint ( float &  ,
float &   
) [virtual]

Get point the legend box is anchored to.

virtual void vtkChartLegend::GetPoint ( float  [2]  )  [virtual]

Get point the legend box is anchored to.

void vtkChartLegend::SetPoint ( const vtkVector2f point  ) 

Set point the legend box is anchored to.

const vtkVector2f& vtkChartLegend::GetPointVector (  ) 

Get point the legend box is anchored to.

virtual void vtkChartLegend::SetHorizontalAlignment ( int   )  [virtual]

Set the horizontal alignment of the legend to the point specified.

virtual int vtkChartLegend::GetHorizontalAlignment (  )  [virtual]

Get the horizontal alignment of the legend to the point specified.

virtual void vtkChartLegend::SetVerticalAlignment ( int   )  [virtual]

Set the vertical alignment of the legend to the point specified.

virtual int vtkChartLegend::GetVerticalAlignment (  )  [virtual]

Get the vertical alignment of the legend to the point specified.

virtual void vtkChartLegend::SetLabelSize ( int   )  [virtual]

Set the point size of the label text.

virtual int vtkChartLegend::GetLabelSize (  )  [virtual]

Get the point size of the label text.

void vtkChartLegend::SetChart ( vtkChart chart  ) 

Set the chart that the legend belongs to and will draw the legend for.

vtkChart* vtkChartLegend::GetChart (  ) 

Get the chart that the legend belongs to and will draw the legend for.

virtual void vtkChartLegend::Update (  )  [virtual]

Update the geometry of the axis. Takes care of setting up the tick mark locations etc. Should be called by the scene before rendering.

Reimplemented from vtkContextItem.

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

Paint event for the axis, called whenever the axis needs to be drawn.

Implements vtkContextItem.


Member Data Documentation

float* vtkChartLegend::Point [protected]

Definition at line 118 of file vtkChartLegend.h.

Definition at line 119 of file vtkChartLegend.h.

Definition at line 120 of file vtkChartLegend.h.

int vtkChartLegend::LabelSize [protected]

Definition at line 121 of file vtkChartLegend.h.

Private* vtkChartLegend::Storage [protected]

Definition at line 124 of file vtkChartLegend.h.


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

Generated on Mon Sep 27 18:19:39 2010 for VTK by  doxygen 1.5.6