<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkBalloonWidget Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkBalloonWidget Class Reference</h1><!-- doxytag: class="vtkBalloonWidget" --><!-- doxytag: inherits="vtkHoverWidget" --><code>#include <<a class="el" href="a05449.html">vtkBalloonWidget.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkBalloonWidget:</div>
<div class="dynsection">
<p><center><img src="a08072.png" border="0" usemap="#a08073" alt="Inheritance graph"></center>
<map name="a08073">
<area shape="rect" href="a00697.html" title="invoke a vtkTimerEvent when hovering" alt="" coords="24,304,141,331"><area shape="rect" href="a00091.html" title="define the API for widget / widget representation" alt="" coords="16,230,149,256"><area shape="rect" href="a00902.html" title="an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor..." alt="" coords="5,155,160,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="43,80,123,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="28,6,137,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkBalloonWidget:</div>
<div class="dynsection">
<p><center><img src="a08074.png" border="0" usemap="#a08075" alt="Collaboration graph"></center>
<map name="a08075">
<area shape="rect" href="a00697.html" title="invoke a vtkTimerEvent when hovering" alt="" coords="531,1206,648,1232"><area shape="rect" href="a00091.html" title="define the API for widget / widget representation" alt="" coords="330,1128,463,1155"><area shape="rect" href="a00902.html" title="an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor..." alt="" coords="1378,432,1532,459"><area shape="rect" href="a01091.html" title="manage contention for cursors and other resources" alt="" coords="1428,534,1578,560"><area shape="rect" href="a01491.html" title="platform-independent render window interaction including picking and frame rate control..." alt="" coords="1763,635,1955,662"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="1274,203,1354,230"><area shape="rect" href="a01886.html" title="window superclass for vtkRenderWindow" alt="" coords="1488,635,1576,662"><area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="1012,432,1114,459"><area shape="rect" href="a00286.html" title="vtkCollectionElement" alt="" coords="1050,310,1199,336"><area shape="rect" href="a01150.html" title="An adapter between a vtkPainter and a rendering device." alt="" coords="1879,371,2052,398"><area shape="rect" href="a00086.html" title="define API for picking subclasses" alt="" coords="2187,1038,2315,1064"><area shape="rect" href="a01833.html" title="abstract specification for Viewports" alt="" coords="1268,870,1362,896"><area shape="rect" href="a01317.html" title="abstract superclass for all actors, volumes and annotations" alt="" coords="800,635,870,662"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="290,432,399,459"><area shape="rect" href="a00681.html" title="manager for OpenGL-based selection." alt="" coords="1448,1038,1598,1064"><area shape="rect" href="a01482.html" title="Render the props of a vtkRenderer." alt="" coords="2002,483,2151,510"><area shape="rect" href="a01485.html" title="Perform part of the rendering of a vtkRenderer." alt="" coords="2092,371,2207,398"><area shape="rect" href="a00954.html" title="a virtual light for 3D rendering" alt="" coords="2196,483,2266,510"><area shape="rect" href="a00227.html" title="a virtual camera for 3D rendering" alt="" coords="2315,310,2403,336"><area shape="rect" href="a01876.html" title="map VTK events into widget events" alt="" coords="446,432,624,459"><area shape="rect" href="a00469.html" title="a complete specification of a VTK event including all modifiers" alt="" coords="510,310,584,336"><area shape="rect" href="a01874.html" title="map widget events into callbacks" alt="" coords="450,534,631,560"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="418,112,527,139"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="67,310,230,336"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="187,203,318,230"><area shape="rect" href="a00291.html" title="superclass for callback/observer methods" alt="" coords="1596,203,1700,230"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="1919,112,2028,139"><area shape="rect" href="a01480.html" title="abstract specification for renderers" alt="" coords="1556,947,1652,974"><area shape="rect" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes..." alt="" coords="434,1038,607,1064"><area shape="rect" href="a01489.html" title="create a window for renderers to draw into" alt="" coords="1884,752,2018,779"><area shape="rect" href="a01481.html" title="a list of renderers" alt="" coords="1226,584,1383,611"><area shape="rect" href="a01321.html" title="a list of Props" alt="" coords="1336,635,1464,662"><area shape="rect" href="a00143.html" title="a list of nodes that form an assembly path" alt="" coords="1036,752,1162,779"><area shape="rect" href="a00144.html" title="a list of lists of props representing an assembly hierarchy" alt="" coords="815,534,948,560"><area shape="rect" href="a00956.html" title="a list of lights" alt="" coords="1666,688,1796,715"><area shape="rect" href="a00346.html" title="a list of Cullers" alt="" coords="880,584,1016,611"><area shape="rect" href="a00088.html" title="abstract API for pickers that can pick an instance of vtkProp" alt="" coords="2071,1128,2228,1155"><area shape="rect" href="a00094.html" title="a list of 2D actors" alt="" coords="1384,752,1534,779"><area shape="rect" href="a00095.html" title="a list of actors" alt="" coords="1563,816,1696,843"><area shape="rect" href="a01841.html" title="a list of volumes" alt="" coords="1703,816,1850,843"><area shape="rect" href="a00717.html" title="DEPRECATED A vtkPolyDataPainter that colors each polygon with a color coded integer..." alt="" coords="499,752,662,779"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="254,310,435,336"><area shape="rect" href="a01723.html" title="describes linear transformations via a 4x4 matrix" alt="" coords="2623,203,2727,230"><area shape="rect" href="a00964.html" title="abstract superclass for linear transformations" alt="" coords="2640,112,2782,139"><area shape="rect" href="a01726.html" title="vtkTransformConcatenationStack" alt="" coords="2806,112,3030,139"><area shape="rect" href="a01725.html" title="vtkTransformConcatenation" alt="" coords="2539,6,2731,32"><area shape="rect" href="a01268.html" title="Abstract class for drawing poly data." alt="" coords="638,635,776,662"><area shape="rect" href="a00722.html" title="dynamic, self-adjusting array of vtkIdType" alt="" coords="499,635,614,662"><area shape="rect" href="a00226.html" title="supports function callbacks" alt="" coords="1667,310,1822,336"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a08076.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
popup text balloons above instance of <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> when hovering occurs
<p>
The <a class="el" href="a00157.html" title="popup text balloons above instance of vtkProp when hovering occurs">vtkBalloonWidget</a> is used to popup text and/or an image when the mouse hovers over an instance of <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. The widget keeps track of (<a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>,vtkBalloon) pairs (where the internal vtkBalloon class is defined by a pair of <a class="el" href="a01607.html" title="Wrapper around vtkstd::string to keep symbols short.">vtkStdString</a> and <a class="el" href="a00751.html" title="topologically and geometrically regular array of data">vtkImageData</a>), and when the mouse stops moving for a user-specified period of time over the <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>, then the vtkBalloon is drawn nearby the <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. Note that an instance of <a class="el" href="a00156.html" title="represent the vtkBalloonWidget">vtkBalloonRepresentation</a> is used to draw the balloon.<p>
To use this widget, specify an instance of <a class="el" href="a00157.html" title="popup text balloons above instance of vtkProp when hovering occurs">vtkBalloonWidget</a> and a representation (e.g., <a class="el" href="a00156.html" title="represent the vtkBalloonWidget">vtkBalloonRepresentation</a>). Then list all instances of <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>, a text string, and/or an instance of <a class="el" href="a00751.html" title="topologically and geometrically regular array of data">vtkImageData</a> to be associated with each <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. (Note that you can specify both text and an image, or just one or the other.) You may also wish to specify the hover delay (i.e., set in the superclass <a class="el" href="a00697.html" title="invoke a vtkTimerEvent when hovering">vtkHoverWidget</a>).<p>
<dl class="user" compact><dt><b>Event Bindings:</b></dt><dd>By default, the widget observes the following VTK events (i.e., it watches the <a class="el" href="a01491.html" title="platform-independent render window interaction including picking and frame rate control...">vtkRenderWindowInteractor</a> for these events): <pre>
MouseMoveEvent - occurs when mouse is moved in render window.
TimerEvent - occurs when the time between events (e.g., mouse move)
is greater than TimerDuration.
KeyPressEvent - when the "Enter" key is pressed after the balloon appears,
a callback is activited (e.g., WidgetActivateEvent).
</pre></dd></dl>
<dl class="user" compact><dt><b>Event Bindings:</b></dt><dd>Note that the event bindings described above can be changed using this class's <a class="el" href="a01876.html" title="map VTK events into widget events">vtkWidgetEventTranslator</a>. This class translates VTK events into the vtkBalloonWidget's widget events: <pre>
<a class="el" href="a01875.html#e463729c80b835d1f03f0107be64a35e4de3aa3412231d8536e62ddde5610a31">vtkWidgetEvent::Move</a> -- start the timer
<a class="el" href="a01875.html#e463729c80b835d1f03f0107be64a35ebb08a280260d5e77dd96b374559dcebd">vtkWidgetEvent::TimedOut</a> -- when hovering occurs,
vtkWidgetEvent::SelectAction -- activate any callbacks associated
with the balloon.
</pre></dd></dl>
<dl class="user" compact><dt><b>Event Bindings:</b></dt><dd>This widget invokes the following VTK events on itself (which observers can listen for): <pre>
<a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe8e9a017e5f6b3a3e543b10d54ddc8f11">vtkCommand::TimerEvent</a> (when hovering is determined to occur)
<a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe3be316361b18c911f1655da2896b8556">vtkCommand::EndInteractionEvent</a> (after a hover has occured and the
mouse begins moving again).
<a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fed24b9208135b752daca66e951ac49ee0">vtkCommand::WidgetActivateEvent</a> (when the balloon is selected with a
keypress).
</pre></dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00091.html" title="define the API for widget / widget representation">vtkAbstractWidget</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_2.html#c2_vtk_t_vtkBalloonWidget">vtkBalloonWidget (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a05449.html#l00086">86</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00697.html">vtkHoverWidget</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#dd83b6466ecc3e73420d2e34b6ff429d">Superclass</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#f845f552b6658b87dd31d2c19c3d1b9f">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00157.html">vtkBalloonWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#3d0b54f249b8623ba54d8d38759dca1a">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#3c528fc9f3f306f493ed5cb659d55086">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#51e2548ef0e4b38d3581bf3f3f5798c2">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#8136221660b14d08ed33219880c3e9f6">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#7b8af3ea0eab6447c431461f7f232c34">SetEnabled</a> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#00d0ddddb8ce17bf0dae013b1d60c887">CreateDefaultRepresentation</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#d42e747bb166bbfa9b5037b7b42a4e56">SetRepresentation</a> (<a class="el" href="a00156.html">vtkBalloonRepresentation</a> *r)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#ee37a86eedc8b036f4f18b0c1a3ffffb">AddBalloon</a> (<a class="el" href="a01317.html">vtkProp</a> *prop, <a class="el" href="a01607.html">vtkStdString</a> *str, <a class="el" href="a00751.html">vtkImageData</a> *img)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#faa005a03d4e8fe030bfbe6d75191d55">AddBalloon</a> (<a class="el" href="a01317.html">vtkProp</a> *prop, const char *str, <a class="el" href="a00751.html">vtkImageData</a> *img)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#5677f3c3912538e691ac790ef4e46c45">AddBalloon</a> (<a class="el" href="a01317.html">vtkProp</a> *prop, const char *str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#1a98342bed2a357684c05f669c0111d6">RemoveBalloon</a> (<a class="el" href="a01317.html">vtkProp</a> *prop)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#06041948528c519204da8631825e78dd">GetBalloonString</a> (<a class="el" href="a01317.html">vtkProp</a> *prop)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00751.html">vtkImageData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#fc4ac07787f725f1ee307a7d269c21e5">GetBalloonImage</a> (<a class="el" href="a01317.html">vtkProp</a> *prop)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a01317.html">vtkProp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#2fc77bf6937017a73245eda9da823f28">GetCurrentProp</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#41fbbcf4bb0e0fee2422aa0283b9153c">SetPicker</a> (<a class="el" href="a00088.html">vtkAbstractPropPicker</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00088.html">vtkAbstractPropPicker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#44a02381201658168ffdddc7db0196c3">GetPicker</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00157.html">vtkBalloonWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#cf7fa09b0380555d98234a43c707d85c">New</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#9b38171c925e0cf859ee5dd722a0e350">vtkBalloonWidget</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#58d17b53d2310ae7fc2d3e3e94db2238">~vtkBalloonWidget</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#67f04d90eeed124167694b19050d0ee4">SubclassEndHoverAction</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#b8b3fb1cfb17d31db2aec8083e29c694">SubclassHoverAction</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vtkPropMap * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#23f04ebb56e88fda6f77cc121331ae70">PropMap</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00088.html">vtkAbstractPropPicker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#f725079bd4a0a9d7fd50d78a41af30c9">Picker</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01317.html">vtkProp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#3356943440eeda17900ad994285dd5fb">CurrentProp</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="dd83b6466ecc3e73420d2e34b6ff429d"></a><!-- doxytag: member="vtkBalloonWidget::Superclass" ref="dd83b6466ecc3e73420d2e34b6ff429d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00697.html">vtkHoverWidget</a> <a class="el" href="a00697.html">vtkBalloonWidget::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#1cae81625c3ea817a1e90642ba5bc05f">vtkHoverWidget</a>.</p>
<p>Definition at line <a class="el" href="a05449.html#l00094">94</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9b38171c925e0cf859ee5dd722a0e350"></a><!-- doxytag: member="vtkBalloonWidget::vtkBalloonWidget" ref="9b38171c925e0cf859ee5dd722a0e350" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkBalloonWidget::vtkBalloonWidget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="58d17b53d2310ae7fc2d3e3e94db2238"></a><!-- doxytag: member="vtkBalloonWidget::~vtkBalloonWidget" ref="58d17b53d2310ae7fc2d3e3e94db2238" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkBalloonWidget::~vtkBalloonWidget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cf7fa09b0380555d98234a43c707d85c"></a><!-- doxytag: member="vtkBalloonWidget::New" ref="cf7fa09b0380555d98234a43c707d85c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00157.html">vtkBalloonWidget</a>* vtkBalloonWidget::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Instantiate this class.
<p>Reimplemented from <a class="el" href="a00697.html#febb2d1fafbdafebaa2581cd0d63704f">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c528fc9f3f306f493ed5cb659d55086"></a><!-- doxytag: member="vtkBalloonWidget::GetClassName" ref="3c528fc9f3f306f493ed5cb659d55086" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkBalloonWidget::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#fb37bc575f78a1ba7a17fdd7d4e2b369">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="f845f552b6658b87dd31d2c19c3d1b9f"></a><!-- doxytag: member="vtkBalloonWidget::IsTypeOf" ref="f845f552b6658b87dd31d2c19c3d1b9f" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkBalloonWidget::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#8fb1a080044eb90a7825671154e8f63e">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="51e2548ef0e4b38d3581bf3f3f5798c2"></a><!-- doxytag: member="vtkBalloonWidget::IsA" ref="51e2548ef0e4b38d3581bf3f3f5798c2" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBalloonWidget::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#06fc61fe489316c388a7bbfebf19de30">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="3d0b54f249b8623ba54d8d38759dca1a"></a><!-- doxytag: member="vtkBalloonWidget::SafeDownCast" ref="3d0b54f249b8623ba54d8d38759dca1a" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00157.html">vtkBalloonWidget</a>* vtkBalloonWidget::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#c953d8239025513092ed24d594e54bd0">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="8136221660b14d08ed33219880c3e9f6"></a><!-- doxytag: member="vtkBalloonWidget::PrintSelf" ref="8136221660b14d08ed33219880c3e9f6" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard methods for a VTK class.
<p>Reimplemented from <a class="el" href="a00697.html#9c23815f06ec32f08804b379b0838550">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="7b8af3ea0eab6447c431461f7f232c34"></a><!-- doxytag: member="vtkBalloonWidget::SetEnabled" ref="7b8af3ea0eab6447c431461f7f232c34" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkBalloonWidget::SetEnabled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The method for activiating and deactiviating this widget. This method must be overridden because it performs special timer-related operations.
<p>Reimplemented from <a class="el" href="a00697.html#e99d2e58ed1706fc38c11e161b96cb12">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="d42e747bb166bbfa9b5037b7b42a4e56"></a><!-- doxytag: member="vtkBalloonWidget::SetRepresentation" ref="d42e747bb166bbfa9b5037b7b42a4e56" args="(vtkBalloonRepresentation *r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::SetRepresentation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00156.html">vtkBalloonRepresentation</a> * </td>
<td class="paramname"> <em>r</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify an instance of <a class="el" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes...">vtkWidgetRepresentation</a> used to represent this widget in the scene. Note that the representation is a subclass of <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> so it can be added to the renderer independent of the widget.
<p>Definition at line <a class="el" href="a05449.html#l00107">107</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="00d0ddddb8ce17bf0dae013b1d60c887"></a><!-- doxytag: member="vtkBalloonWidget::CreateDefaultRepresentation" ref="00d0ddddb8ce17bf0dae013b1d60c887" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::CreateDefaultRepresentation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the default widget representation if one is not set.
<p>Reimplemented from <a class="el" href="a00697.html#c3b70efdb928f034ce9430ff83c82c3a">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="ee37a86eedc8b036f4f18b0c1a3ffffb"></a><!-- doxytag: member="vtkBalloonWidget::AddBalloon" ref="ee37a86eedc8b036f4f18b0c1a3ffffb" args="(vtkProp *prop, vtkStdString *str, vtkImageData *img)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::AddBalloon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01607.html">vtkStdString</a> * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> * </td>
<td class="paramname"> <em>img</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add and remove text and/or an image to be associated with a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. You may add one or both of them.
</div>
</div><p>
<a class="anchor" name="faa005a03d4e8fe030bfbe6d75191d55"></a><!-- doxytag: member="vtkBalloonWidget::AddBalloon" ref="faa005a03d4e8fe030bfbe6d75191d55" args="(vtkProp *prop, const char *str, vtkImageData *img)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::AddBalloon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> * </td>
<td class="paramname"> <em>img</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add and remove text and/or an image to be associated with a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. You may add one or both of them.
</div>
</div><p>
<a class="anchor" name="5677f3c3912538e691ac790ef4e46c45"></a><!-- doxytag: member="vtkBalloonWidget::AddBalloon" ref="5677f3c3912538e691ac790ef4e46c45" args="(vtkProp *prop, const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::AddBalloon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add and remove text and/or an image to be associated with a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. You may add one or both of them.
<p>Definition at line <a class="el" href="a05449.html#l00119">119</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1a98342bed2a357684c05f669c0111d6"></a><!-- doxytag: member="vtkBalloonWidget::RemoveBalloon" ref="1a98342bed2a357684c05f669c0111d6" args="(vtkProp *prop)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::RemoveBalloon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add and remove text and/or an image to be associated with a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>. You may add one or both of them.
</div>
</div><p>
<a class="anchor" name="06041948528c519204da8631825e78dd"></a><!-- doxytag: member="vtkBalloonWidget::GetBalloonString" ref="06041948528c519204da8631825e78dd" args="(vtkProp *prop)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* vtkBalloonWidget::GetBalloonString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods to retrieve the information associated with each <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> (i.e., the information that makes up each balloon). A NULL will be returned if the <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> does not exist, or if a string or image have not been associated with the specified <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
</div>
</div><p>
<a class="anchor" name="fc4ac07787f725f1ee307a7d269c21e5"></a><!-- doxytag: member="vtkBalloonWidget::GetBalloonImage" ref="fc4ac07787f725f1ee307a7d269c21e5" args="(vtkProp *prop)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00751.html">vtkImageData</a>* vtkBalloonWidget::GetBalloonImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01317.html">vtkProp</a> * </td>
<td class="paramname"> <em>prop</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods to retrieve the information associated with each <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> (i.e., the information that makes up each balloon). A NULL will be returned if the <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> does not exist, or if a string or image have not been associated with the specified <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
</div>
</div><p>
<a class="anchor" name="2fc77bf6937017a73245eda9da823f28"></a><!-- doxytag: member="vtkBalloonWidget::GetCurrentProp" ref="2fc77bf6937017a73245eda9da823f28" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01317.html">vtkProp</a>* vtkBalloonWidget::GetCurrentProp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> that is being hovered over. Note that the value may be NULL (if hovering over nothing or the mouse is moving).
<p>Definition at line <a class="el" href="a05449.html#l00136">136</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="41fbbcf4bb0e0fee2422aa0283b9153c"></a><!-- doxytag: member="vtkBalloonWidget::SetPicker" ref="41fbbcf4bb0e0fee2422aa0283b9153c" args="(vtkAbstractPropPicker *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkBalloonWidget::SetPicker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00088.html">vtkAbstractPropPicker</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the object used to perform pick operations. Since the <a class="el" href="a00157.html" title="popup text balloons above instance of vtkProp when hovering occurs">vtkBalloonWidget</a> operates on vtkProps, the picker must be a subclass of <a class="el" href="a00088.html" title="abstract API for pickers that can pick an instance of vtkProp">vtkAbstractPropPicker</a>. (Note: if not specified, an instance of <a class="el" href="a01324.html" title="pick an actor/prop using graphics hardware">vtkPropPicker</a> is used.)
</div>
</div><p>
<a class="anchor" name="44a02381201658168ffdddc7db0196c3"></a><!-- doxytag: member="vtkBalloonWidget::GetPicker" ref="44a02381201658168ffdddc7db0196c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00088.html">vtkAbstractPropPicker</a>* vtkBalloonWidget::GetPicker </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the object used to perform pick operations. Since the <a class="el" href="a00157.html" title="popup text balloons above instance of vtkProp when hovering occurs">vtkBalloonWidget</a> operates on vtkProps, the picker must be a subclass of <a class="el" href="a00088.html" title="abstract API for pickers that can pick an instance of vtkProp">vtkAbstractPropPicker</a>. (Note: if not specified, an instance of <a class="el" href="a01324.html" title="pick an actor/prop using graphics hardware">vtkPropPicker</a> is used.)
</div>
</div><p>
<a class="anchor" name="67f04d90eeed124167694b19050d0ee4"></a><!-- doxytag: member="vtkBalloonWidget::SubclassEndHoverAction" ref="67f04d90eeed124167694b19050d0ee4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBalloonWidget::SubclassEndHoverAction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00697.html#cbc50a3a66b8f0d556a40cb5da5aa723">vtkHoverWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="b8b3fb1cfb17d31db2aec8083e29c694"></a><!-- doxytag: member="vtkBalloonWidget::SubclassHoverAction" ref="b8b3fb1cfb17d31db2aec8083e29c694" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkBalloonWidget::SubclassHoverAction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00697.html#f5066f713140bfeb2915e328ea5af9a7">vtkHoverWidget</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="23f04ebb56e88fda6f77cc121331ae70"></a><!-- doxytag: member="vtkBalloonWidget::PropMap" ref="23f04ebb56e88fda6f77cc121331ae70" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPropMap* <a class="el" href="a00157.html#23f04ebb56e88fda6f77cc121331ae70">vtkBalloonWidget::PropMap</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05449.html#l00158">158</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f725079bd4a0a9d7fd50d78a41af30c9"></a><!-- doxytag: member="vtkBalloonWidget::Picker" ref="f725079bd4a0a9d7fd50d78a41af30c9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00088.html">vtkAbstractPropPicker</a>* <a class="el" href="a00157.html#f725079bd4a0a9d7fd50d78a41af30c9">vtkBalloonWidget::Picker</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05449.html#l00161">161</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3356943440eeda17900ad994285dd5fb"></a><!-- doxytag: member="vtkBalloonWidget::CurrentProp" ref="3356943440eeda17900ad994285dd5fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01317.html">vtkProp</a>* <a class="el" href="a00157.html#3356943440eeda17900ad994285dd5fb">vtkBalloonWidget::CurrentProp</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05449.html#l00164">164</a> of file <a class="el" href="a05449.html">vtkBalloonWidget.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Widgets/<a class="el" href="a05449.html">vtkBalloonWidget.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:53:59 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
160
