vtkTooltipItem Class Reference

takes care of drawing 2D axes More...

#include <vtkTooltipItem.h>

Inheritance diagram for vtkTooltipItem:

Collaboration diagram for vtkTooltipItem:

Public Types
typedef vtkContextItem	Superclass
Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem	Superclass
Public Types inherited from vtkAbstractContextItem
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkTooltipItem *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	Update () override
	Update the geometry of the tooltip. More...
bool	Paint (vtkContext2D *painter) override
	Paint event for the tooltip. More...
virtual void	SetPosition (float, float)
	Set the position of the tooltip (in pixels). More...
void	SetPosition (float[2])
	Set the position of the tooltip (in pixels). More...
void	SetPosition (const vtkVector2f &pos)
	Set the position of the tooltip (in pixels). More...
virtual float *	GetPosition ()
	Get position of the axis (in pixels). More...
virtual void	GetPosition (float &, float &)
	Get position of the axis (in pixels). More...
virtual void	GetPosition (float[2])
	Get position of the axis (in pixels). More...
vtkVector2f	GetPositionVector ()
	Get position of the axis (in pixels). More...
virtual void	SetText (const vtkStdString &title)
	Get/set the text of the item. More...
virtual vtkStdString	GetText ()
	Get/set the text of the item. More...
virtual vtkPen *	GetPen ()
	Get a pointer to the vtkTextProperty object that controls the way the text is rendered. More...
virtual vtkBrush *	GetBrush ()
	Get a pointer to the vtkPen object. More...
virtual vtkTextProperty *	GetTextProperties ()
	Get the vtkTextProperty that governs how the tooltip text is displayed. More...
Public Member Functions inherited from vtkContextItem
vtkContextItem *	NewInstance () const
virtual double	GetOpacity ()
	Get the opacity of the item. More...
virtual void	SetOpacity (double)
	Set the opacity of the item. More...
Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem *	NewInstance () const
virtual bool	PaintChildren (vtkContext2D *painter)
	Paint the children of the item, should be called whenever the children need to be rendered. More...
virtual void	ReleaseGraphicsResources ()
	Release graphics resources hold by the item. More...
vtkIdType	AddItem (vtkAbstractContextItem *item)
	Add child items to this item. More...
bool	RemoveItem (vtkAbstractContextItem *item)
	Remove child item from this item. More...
bool	RemoveItem (vtkIdType index)
	Remove child item from this item. More...
vtkAbstractContextItem *	GetItem (vtkIdType index)
	Get the item at the specified index. More...
vtkIdType	GetItemIndex (vtkAbstractContextItem *item)
	Get the index of the specified item in itemIndex. More...
vtkIdType	GetNumberOfItems ()
	Get the number of child items. More...
void	ClearItems ()
	Remove all child items from this item. More...
vtkIdType	Raise (vtkIdType index)
	Raises the child to the top of the item's stack. More...
virtual vtkIdType	StackAbove (vtkIdType index, vtkIdType under)
	Raises the child above the under sibling. More...
vtkIdType	Lower (vtkIdType index)
	Lowers the child to the bottom of the item's stack. More...
virtual vtkIdType	StackUnder (vtkIdType child, vtkIdType above)
	Lowers the child under the above sibling. More...
virtual bool	Hit (const vtkContextMouseEvent &mouse)
	Return true if the supplied x, y coordinate is inside the item. More...
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
	Return the item under the mouse. More...
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
	Mouse enter event. More...
virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
	Mouse move event. More...
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
	Mouse leave event. More...
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
	Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items. More...
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
	Mouse button release event. More...
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
	Mouse button double click event. More...
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
	Mouse wheel event, positive delta indicates forward movement of the wheel. More...
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
	Key press event. More...
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
	Key release event. More...
virtual void	SetScene (vtkContextScene *scene)
	Set the vtkContextScene for the item, always set for an item in a scene. More...
vtkContextScene *	GetScene ()
	Get the vtkContextScene for the item, always set for an item in a scene. More...
virtual void	SetParent (vtkAbstractContextItem *parent)
	Set the parent item. More...
vtkAbstractContextItem *	GetParent ()
	Get the parent item. More...
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
	Maps the point to the parent coordinate system. More...
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
	Maps the point from the parent coordinate system. More...
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
	Maps the point to the scene coordinate system. More...
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
	Maps the point from the scene coordinate system. More...
virtual bool	GetVisible ()
	Get the visibility of the item (should it be drawn). More...
virtual void	SetVisible (bool)
	Set the visibility of the item (should it be drawn). More...
virtual bool	GetInteractive ()
	Get if the item is interactive (should respond to mouse events). More...
virtual void	SetInteractive (bool)
	Set if the item is interactive (should respond to mouse events). More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTooltipItem *	SafeDownCast (vtkObjectBase *o)
static vtkTooltipItem *	New ()
	Creates a 2D Chart object. More...
Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractContextItem *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTooltipItem ()
	~vtkTooltipItem () override
Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()
	~vtkContextItem () override
Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()
	~vtkAbstractContextItem () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
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
float *	Position
vtkStdString	Text
vtkTextProperty *	TextProperties
vtkPen *	Pen
vtkBrush *	Brush
Protected Attributes inherited from vtkContextItem
double	Opacity
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
	Point to the scene the item is on - can be null. More...
vtkAbstractContextItem *	Parent
	Point to the parent item - can be null. More...
vtkContextScenePrivate *	Children
	This structure provides a list of children, along with convenience functions to paint the children etc. More...
bool	Visible
	Store the visibility of the item (default is true). More...
bool	Interactive
	Store whether the item should respond to interactions (default is true). More...
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 39 of file vtkTooltipItem.h.

Member Typedef Documentation

typedef vtkContextItem vtkTooltipItem::Superclass

Definition at line 42 of file vtkTooltipItem.h.

Constructor & Destructor Documentation

vtkTooltipItem::vtkTooltipItem ( )

protected

vtkTooltipItem::~vtkTooltipItem ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkTooltipItem::IsTypeOf ( const char *  type )

static

virtual vtkTypeBool 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

void vtkTooltipItem::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

void vtkTooltipItem::Update ( )

overridevirtual

Update the geometry of the tooltip.

Reimplemented from vtkAbstractContextItem.

bool vtkTooltipItem::Paint ( vtkContext2D *  painter )

overridevirtual

Paint event for the tooltip.

Reimplemented from vtkAbstractContextItem.

Member Data Documentation

vtkVector2f vtkTooltipItem::PositionVector

protected

Definition at line 110 of file vtkTooltipItem.h.

float* vtkTooltipItem::Position

protected

Definition at line 111 of file vtkTooltipItem.h.

vtkStdString vtkTooltipItem::Text

protected

Definition at line 112 of file vtkTooltipItem.h.

vtkTextProperty* vtkTooltipItem::TextProperties

protected

Definition at line 113 of file vtkTooltipItem.h.

vtkPen* vtkTooltipItem::Pen

protected

Definition at line 114 of file vtkTooltipItem.h.

vtkBrush* vtkTooltipItem::Brush

protected

Definition at line 115 of file vtkTooltipItem.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/Context2D/vtkTooltipItem.h