VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkChartLegend Class Reference

draw the chart legend More...

#include <vtkChartLegend.h>

Inheritance diagram for vtkChartLegend:
[legend]
Collaboration diagram for vtkChartLegend:
[legend]

Public Types

enum  {
  LEFT = 0, CENTER, RIGHT, TOP,
  BOTTOM, CUSTOM
}
 
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
 
virtual void SetLabelSize (int size)
 
virtual int GetLabelSize ()
 
void SetChart (vtkChart *chart)
 
vtkChartGetChart ()
 
virtual void Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
virtual vtkRectf GetBoundingRect (vtkContext2D *painter)
 
vtkPenGetPen ()
 
vtkBrushGetBrush ()
 
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 ()
 
- Public Member Functions inherited from vtkContextItem
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
bool PaintChildren (vtkContext2D *painter)
 
virtual void ReleaseGraphicsResources ()
 
unsigned int AddItem (vtkAbstractContextItem *item)
 
bool RemoveItem (vtkAbstractContextItem *item)
 
bool RemoveItem (unsigned int index)
 
vtkAbstractContextItemGetItem (unsigned int index)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
virtual void SetScene (vtkContextScene *scene)
 
virtual void SetParent (vtkAbstractContextItem *parent)
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkChartLegendSafeDownCast (vtkObject *o)
 
static vtkChartLegendNew ()
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkChartLegend ()
 
 ~vtkChartLegend ()
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem ()
 
- Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

float * Point
 
int HorizontalAlignment
 
int VerticalAlignment
 
vtkNew< vtkPenPen
 
vtkNew< vtkBrushBrush
 
vtkNew< vtkTextProperty > LabelProperties
 
bool DragEnabled
 
int Button
 
vtkTimeStamp PlotTime
 
vtkTimeStamp RectTime
 
vtkRectf Rect
 
int Padding
 
int SymbolWidth
 
bool Inline
 
Private * Storage
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

Member Typedef Documentation

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 *  type)
static
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
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.

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.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkChartLegend::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
virtual

Mouse button down event

Reimplemented from vtkAbstractContextItem.

virtual bool vtkChartLegend::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
virtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

Member Data Documentation

float* vtkChartLegend::Point
protected

Definition at line 187 of file vtkChartLegend.h.

int vtkChartLegend::HorizontalAlignment
protected

Definition at line 188 of file vtkChartLegend.h.

int vtkChartLegend::VerticalAlignment
protected

Definition at line 189 of file vtkChartLegend.h.

vtkNew<vtkPen> vtkChartLegend::Pen
protected

The pen used to draw the legend box.

Definition at line 192 of file vtkChartLegend.h.

vtkNew<vtkBrush> vtkChartLegend::Brush
protected

The brush used to render the background of the legend.

Definition at line 195 of file vtkChartLegend.h.

vtkNew<vtkTextProperty> vtkChartLegend::LabelProperties
protected

The text properties of the labels used in the legend.

Definition at line 198 of file vtkChartLegend.h.

bool vtkChartLegend::DragEnabled
protected

Should we move the legend box around in response to the mouse drag?

Definition at line 201 of file vtkChartLegend.h.

int vtkChartLegend::Button
protected

Last button to be pressed.

Definition at line 204 of file vtkChartLegend.h.

vtkTimeStamp vtkChartLegend::PlotTime
protected

Definition at line 206 of file vtkChartLegend.h.

vtkTimeStamp vtkChartLegend::RectTime
protected

Definition at line 207 of file vtkChartLegend.h.

vtkRectf vtkChartLegend::Rect
protected

Definition at line 209 of file vtkChartLegend.h.

int vtkChartLegend::Padding
protected

Padding between symbol and text.

Definition at line 212 of file vtkChartLegend.h.

int vtkChartLegend::SymbolWidth
protected

Width of the symbols in pixels in the legend.

Definition at line 215 of file vtkChartLegend.h.

bool vtkChartLegend::Inline
protected

Should the legend be drawn inline in its chart?

Definition at line 218 of file vtkChartLegend.h.

Private* vtkChartLegend::Storage
protected

Definition at line 221 of file vtkChartLegend.h.


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