vtkChartLegend Class Reference

#include <vtkChartLegend.h>

Inheritance diagram for vtkChartLegend:

[legend]

Collaboration diagram for vtkChartLegend:

[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.

Tests:: vtkChartLegend (Tests)

Definition at line 40 of file vtkChartLegend.h.


Public Types
enum	{ LEFT = 0, CENTER, RIGHT, TOP, BOTTOM, CUSTOM }
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 vtkVector2f &	GetPointVector ()
virtual void	SetLabelSize (int size)
virtual int	GetLabelSize ()
void	SetChart (vtkChart *chart)
vtkChart *	GetChart ()
virtual void	Update ()
virtual bool	Paint (vtkContext2D *painter)
virtual vtkRectf	GetBoundingRect (vtkContext2D *painter)
vtkPen *	GetPen ()
vtkBrush *	GetBrush ()
vtkTextProperty *	GetLabelProperties ()
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	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	SetPadding (int)

virtual int	GetPadding ()

virtual void	SetSymbolWidth (int)

virtual int	GetSymbolWidth ()

virtual void	SetInline (bool)
virtual bool	GetInline ()

virtual void	SetDragEnabled (bool)
virtual bool	GetDragEnabled ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkChartLegend *	SafeDownCast (vtkObject *o)
static vtkChartLegend *	New ()
Protected Member Functions
	vtkChartLegend ()
	~vtkChartLegend ()
Protected Attributes
float *	Point
int	HorizontalAlignment
int	VerticalAlignment
vtkNew< vtkPen >	Pen
vtkNew< vtkBrush >	Brush
vtkNew< vtkTextProperty >	LabelProperties
bool	DragEnabled
int	Button
vtkTimeStamp	PlotTime
vtkTimeStamp	RectTime
vtkRectf	Rect
int	Padding
int	SymbolWidth
bool	Inline
Private *	Storage

Member Typedef Documentation

typedef vtkContextItem vtkChartLegend::Superclass

Reimplemented from vtkContextItem.

Reimplemented in vtkColorLegend.

Definition at line 43 of file vtkChartLegend.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

LEFT
CENTER
RIGHT
TOP
BOTTOM
CUSTOM

Definition at line 59 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.

Reimplemented in vtkColorLegend.

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.

Reimplemented in vtkColorLegend.

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.

Reimplemented in vtkColorLegend.

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

Reimplemented from vtkContextItem.

Reimplemented in vtkColorLegend.

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.

Reimplemented in vtkColorLegend.

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

Creates a 2D Chart object.

Reimplemented from vtkObject.

Reimplemented in vtkColorLegend.

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. Valid values are LEFT, CENTER and RIGHT.

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. Valid values are TOP, CENTER and BOTTOM.

virtual int vtkChartLegend::GetVerticalAlignment ( ) [virtual]

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

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

Set the padding between legend marks, default is 5.

virtual int vtkChartLegend::GetPadding ( ) [virtual]

Get the padding between legend marks.

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

Set the symbol width, default is 15.

virtual int vtkChartLegend::GetSymbolWidth ( ) [virtual]

Get the legend symbol width.

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

Set the point size of the label text.

virtual int vtkChartLegend::GetLabelSize ( ) [virtual]

Get the point size of the label text.

virtual void vtkChartLegend::SetInline ( bool ) [virtual]

Get/set if the legend should be drawn inline (inside the chart), or not. True would generally request that the chart draws it inside the chart, false would adjust the chart axes and make space to draw the axes outside.

virtual bool vtkChartLegend::GetInline ( ) [virtual]

Get/set if the legend should be drawn inline (inside the chart), or not. True would generally request that the chart draws it inside the chart, false would adjust the chart axes and make space to draw the axes outside.

virtual void vtkChartLegend::SetDragEnabled ( bool ) [virtual]

Get/set if the legend can be dragged with the mouse button, or not. True results in left click and drag causing the legend to move around the scene. False disables response to mouse events. The default is true.

virtual bool vtkChartLegend::GetDragEnabled ( ) [virtual]

Get/set if the legend can be dragged with the mouse button, or not. True results in left click and drag causing the legend to move around the scene. False disables response to mouse events. The default is true.

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 vtkAbstractContextItem.

Reimplemented in vtkColorLegend.

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

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

Reimplemented from vtkAbstractContextItem.

Reimplemented in vtkColorLegend.

virtual vtkRectf vtkChartLegend::GetBoundingRect ( vtkContext2D * painter ) [virtual]

Request the space the legend requires to be drawn. This is returned as a vtkRect4f, with the corner being the offset from Point, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called first.

Reimplemented in vtkColorLegend.

vtkPen* vtkChartLegend::GetPen ( )

Get the pen used to draw the legend outline.

vtkBrush* vtkChartLegend::GetBrush ( )

Get the brush used to draw the legend background.

vtkTextProperty* vtkChartLegend::GetLabelProperties ( )

Get the vtkTextProperty for the legend's labels.

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

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

Reimplemented from vtkAbstractContextItem.

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

Mouse move event.