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

takes care of drawing 2D axes More...

#include <vtkTooltipItem.h>

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

Public Types

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 int IsA (const char *type)
 
vtkTooltipItemNewInstance () const
 
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 floatGetPosition ()
 
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 ()
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual 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 GetItemIndex (vtkAbstractContextItem *item)
 
unsigned int GetNumberOfItems ()
 
void ClearItems ()
 
unsigned int Raise (unsigned int index)
 
unsigned int Lower (unsigned int index)
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 
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 unsigned int StackAbove (unsigned int index, unsigned int under)
 
virtual unsigned int StackUnder (unsigned int child, unsigned int above)
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 
vtkContextSceneGetScene ()
 
vtkAbstractContextItemGetParent ()
 
virtual bool GetVisible ()
 
virtual void SetVisible (bool)
 
virtual bool GetInteractive ()
 
virtual void SetInteractive (bool)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool 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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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 &)
 
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 vtkTooltipItemSafeDownCast (vtkObjectBase *o)
 
static vtkTooltipItemNew ()
 
- Static Public Member Functions inherited from vtkContextItem
static int IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static int IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTooltipItem ()
 
 ~vtkTooltipItem ()
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVector2f PositionVector
 
floatPosition
 
vtkStdString Text
 
vtkTextPropertyTextProperties
 
vtkPenPen
 
vtkBrushBrush
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 
vtkAbstractContextItemParent
 
vtkContextScenePrivateChildren
 
bool Visible
 
bool Interactive
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 38 of file vtkTooltipItem.h.

Member Typedef Documentation

Definition at line 41 of file vtkTooltipItem.h.

Constructor & Destructor Documentation

vtkTooltipItem::vtkTooltipItem ( )
protected
vtkTooltipItem::~vtkTooltipItem ( )
protected

Member Function Documentation

static int vtkTooltipItem::IsTypeOf ( const char *  type)
static
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 ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkTooltipItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

vtkTooltipItem* vtkTooltipItem::NewInstance ( ) const
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.

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

vtkVector2f vtkTooltipItem::PositionVector
protected

Definition at line 93 of file vtkTooltipItem.h.

float* vtkTooltipItem::Position
protected

Definition at line 94 of file vtkTooltipItem.h.

vtkStdString vtkTooltipItem::Text
protected

Definition at line 95 of file vtkTooltipItem.h.

vtkTextProperty* vtkTooltipItem::TextProperties
protected

Definition at line 96 of file vtkTooltipItem.h.

vtkPen* vtkTooltipItem::Pen
protected

Definition at line 97 of file vtkTooltipItem.h.

vtkBrush* vtkTooltipItem::Brush
protected

Definition at line 98 of file vtkTooltipItem.h.


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