vtkTooltipItem Class Reference

#include <vtkTooltipItem.h>

Inheritance diagram for vtkTooltipItem:

Inheritance graph
[legend]
Collaboration diagram for vtkTooltipItem:

Collaboration graph
[legend]

List of all members.


Detailed Description

takes care of drawing 2D axes

The vtkTooltipItem is drawn in screen coordinates. It is used to display a tooltip on a scene, giving additional information about an element on the scene, such as in vtkChartXY. It takes care of ensuring that it draws itself within the bounds of the screen.

Definition at line 37 of file vtkTooltipItem.h.


Public Types

typedef vtkContextItem Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual void SetPosition (float, float)
void SetPosition (float[2])
void SetPosition (const vtkVector2f &pos)
virtual float * GetPosition ()
virtual void GetPosition (float &, float &)
virtual void GetPosition (float[2])
vtkVector2f GetPositionVector ()
virtual void SetText (const vtkStdString &title)
virtual vtkStdString GetText ()
virtual vtkPenGetPen ()
virtual vtkBrushGetBrush ()
virtual vtkTextPropertyGetTextProperties ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkTooltipItemSafeDownCast (vtkObject *o)
static vtkTooltipItemNew ()

Protected Member Functions

 vtkTooltipItem ()
 ~vtkTooltipItem ()

Protected Attributes

vtkVector2f PositionVector
float * Position
vtkStdString Text
vtkTextPropertyTextProperties
vtkPenPen
vtkBrushBrush

Member Typedef Documentation

Reimplemented from vtkContextItem.

Definition at line 40 of file vtkTooltipItem.h.


Constructor & Destructor Documentation

vtkTooltipItem::vtkTooltipItem (  )  [protected]

vtkTooltipItem::~vtkTooltipItem (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkContextItem.

static int vtkTooltipItem::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 vtkTooltipItem::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 vtkTooltipItem* vtkTooltipItem::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkContextItem.

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

Creates a 2D Chart object.

Reimplemented from vtkObject.

virtual void vtkTooltipItem::SetPosition ( float  ,
float   
) [virtual]

Set the position of the tooltip (in pixels).

void vtkTooltipItem::SetPosition ( float  [2]  ) 

Set the position of the tooltip (in pixels).

void vtkTooltipItem::SetPosition ( const vtkVector2f pos  ) 

Set the position of the tooltip (in pixels).

virtual float* vtkTooltipItem::GetPosition (  )  [virtual]

Get position of the axis (in pixels).

virtual void vtkTooltipItem::GetPosition ( float &  ,
float &   
) [virtual]

Get position of the axis (in pixels).

virtual void vtkTooltipItem::GetPosition ( float  [2]  )  [virtual]

Get position of the axis (in pixels).

vtkVector2f vtkTooltipItem::GetPositionVector (  ) 

Get position of the axis (in pixels).

virtual void vtkTooltipItem::SetText ( const vtkStdString title  )  [virtual]

Get/set the text of the item.

virtual vtkStdString vtkTooltipItem::GetText (  )  [virtual]

Get/set the text of the item.

virtual vtkPen* vtkTooltipItem::GetPen (  )  [virtual]

Get a pointer to the vtkTextProperty object that controls the way the text is rendered.

virtual vtkBrush* vtkTooltipItem::GetBrush (  )  [virtual]

Get a pointer to the vtkPen object.

virtual vtkTextProperty* vtkTooltipItem::GetTextProperties (  )  [virtual]

Get the vtkTextProperty that governs how the tooltip text is displayed.

virtual void vtkTooltipItem::Update (  )  [virtual]

Update the geometry of the tooltip.

Reimplemented from vtkAbstractContextItem.

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

Paint event for the tooltip.

Reimplemented from vtkAbstractContextItem.


Member Data Documentation

Definition at line 92 of file vtkTooltipItem.h.

float* vtkTooltipItem::Position [protected]

Definition at line 93 of file vtkTooltipItem.h.

Definition at line 94 of file vtkTooltipItem.h.

Definition at line 95 of file vtkTooltipItem.h.

Definition at line 96 of file vtkTooltipItem.h.

Definition at line 97 of file vtkTooltipItem.h.


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

Generated on Wed Aug 24 12:13:55 2011 for VTK by  doxygen 1.5.6