<!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: vtkCaptionRepresentation 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>vtkCaptionRepresentation Class Reference</h1><!-- doxytag: class="vtkCaptionRepresentation" --><!-- doxytag: inherits="vtkBorderRepresentation" --><code>#include <<a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkCaptionRepresentation:</div>
<div class="dynsection">
<p><center><img src="a08425.png" border="0" usemap="#a08426" alt="Inheritance graph"></center>
<map name="a08426">
<area shape="rect" href="a00191.html" title="represent a vtkBorderWidget" alt="" coords="8,304,181,331"><area shape="rect" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes..." alt="" coords="8,230,181,256"><area shape="rect" href="a01317.html" title="abstract superclass for all actors, volumes and annotations" alt="" coords="60,155,129,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="55,80,135,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="40,6,149,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkCaptionRepresentation:</div>
<div class="dynsection">
<p><center><img src="a08427.png" border="0" usemap="#a08428" alt="Collaboration graph"></center>
<map name="a08428">
<area shape="rect" href="a00191.html" title="represent a vtkBorderWidget" alt="" coords="1983,1239,2156,1266"><area shape="rect" href="a01877.html" title="abstract class defines interface between the widget and widget representation classes..." alt="" coords="1195,1776,1368,1803"><area shape="rect" href="a00678.html" title="abstract class for representing widget handles" alt="" coords="1580,1827,1756,1854"><area shape="rect" href="a01317.html" title="abstract superclass for all actors, volumes and annotations" alt="" coords="461,1594,531,1620"><area shape="rect" href="a01480.html" title="abstract specification for renderers" alt="" coords="813,1714,909,1740"><area shape="rect" href="a00093.html" title="a actor that draws 2D data" alt="" coords="1623,1314,1713,1340"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="205,1303,285,1330"><area shape="rect" href="a01833.html" title="abstract specification for Viewports" alt="" coords="449,1356,543,1383"><area shape="rect" href="a01250.html" title="represent and manipulate 3D points" alt="" coords="823,972,900,999"><area shape="rect" href="a00335.html" title="perform coordinate transformation, and represent position, in a variety of vtk coordinate..." alt="" coords="1228,1448,1335,1475"><area shape="rect" href="a01513.html" title="map scalar values into colors" alt="" coords="599,1175,740,1202"><area shape="rect" href="a01323.html" title="represent surface properties of a 2D image" alt="" coords="1227,1274,1336,1300"><area shape="rect" href="a00089.html" title="superclass for all geometric transformations" alt="" coords="420,1543,572,1570"><area shape="rect" href="a00248.html" title="object represents upward pointers from points to list of cells using each point" alt="" coords="1015,718,1111,744"><area shape="rect" href="a00242.html" title="object to represent cell connectivity" alt="" coords="621,1050,717,1076"><area shape="rect" href="a01692.html" title="represent text properties." alt="" coords="1609,792,1727,819"><area shape="rect" href="a01322.html" title="represent surface properties of a geometric object" alt="" coords="1623,1751,1713,1778"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="5,1599,115,1626"><area shape="rect" href="a01266.html" title="draw vtkPolyData onto the image plane" alt="" coords="1589,1108,1747,1135"><area shape="rect" href="a00092.html" title="represents an object (geometry & properties) in a rendered scene" alt="" coords="2033,1812,2105,1839"><area shape="rect" href="a01689.html" title="An actor that displays text. Scaled or unscaled." alt="" coords="2020,886,2119,912"><area shape="rect" href="a01251.html" title="abstract class for specifying dataset behavior" alt="" coords="1236,804,1327,831"><area shape="rect" href="a00356.html" title="abstract superclass for arrays of numeric data" alt="" coords="445,1124,547,1151"><area shape="rect" href="a01784.html" title="dynamic, self-adjusting array of unsigned char" alt="" coords="983,1120,1143,1147"><area shape="rect" href="a00233.html" title="draw text label associated with a point" alt="" coords="2367,1179,2503,1206"><area shape="rect" href="a00985.html" title="abstract class specifies interface for objects which render 2D actors" alt="" coords="1229,1223,1333,1250"><area shape="rect" href="a01723.html" title="describes linear transformations via a 4x4 matrix" alt="" coords="1616,1383,1720,1410"><area shape="rect" href="a00964.html" title="abstract superclass for linear transformations" alt="" coords="1211,1358,1352,1384"><area shape="rect" href="a01726.html" title="vtkTransformConcatenationStack" alt="" coords="1169,1664,1393,1691"><area shape="rect" href="a01725.html" title="vtkTransformConcatenation" alt="" coords="765,1602,957,1628"><area shape="rect" href="a01731.html" title="transform points and associated normals and vectors for polygonal dataset" alt="" coords="1573,1058,1763,1084"><area shape="rect" href="a01261.html" title="Superclass for algorithms that produce only polydata as output." alt="" coords="1204,88,1359,115"><area shape="rect" href="a00115.html" title="appends one or more polygonal datasets together" alt="" coords="1801,63,1943,90"><area shape="rect" href="a00651.html" title="copy oriented and scaled glyph geometry to every input point" alt="" coords="2023,143,2116,170"><area shape="rect" href="a00348.html" title="generate a 3D cursor representation" alt="" coords="2020,303,2119,330"><area shape="rect" href="a00316.html" title="generate polygonal cone" alt="" coords="2183,16,2297,43"><area shape="rect" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips" alt="" coords="1620,463,1716,490"><area shape="rect" href="a00960.html" title="cell represents a 1D line" alt="" coords="212,404,279,431"><area shape="rect" href="a01278.html" title="a cell that represents an n-sided polygon" alt="" coords="1236,410,1327,436"><area shape="rect" href="a01760.html" title="a cell that represents a triangle" alt="" coords="451,370,541,396"><area shape="rect" href="a01428.html" title="a cell that represents a 2D quadrilateral" alt="" coords="824,415,899,442"><area shape="rect" href="a01762.html" title="a cell that represents a triangle strip" alt="" coords="803,466,920,492"><area shape="rect" href="a01284.html" title="cell represents a set of 1D lines" alt="" coords="623,187,716,214"><area shape="rect" href="a01286.html" title="cell represents a set of 0D vertices" alt="" coords="1228,524,1335,551"><area shape="rect" href="a01821.html" title="a cell that represents a 3D point" alt="" coords="821,575,901,602"><area shape="rect" href="a00458.html" title="an empty cell used as a place-holder during processing" alt="" coords="1231,639,1332,666"><area shape="rect" href="a01245.html" title="represent the position of a point in 3D space" alt="" coords="2323,1707,2547,1734"><area shape="rect" href="a01265.html" title="map vtkPolyData to graphics primitives" alt="" coords="1999,1620,2140,1647"><area shape="rect" href="a00251.html" title="select a cell by shooting a ray into graphics window" alt="" coords="2019,1682,2120,1708"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a08429.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
represents <a class="el" href="a00235.html" title="widget for placing a caption (text plus leader)">vtkCaptionWidget</a> in the scene
<p>
This class represents <a class="el" href="a00235.html" title="widget for placing a caption (text plus leader)">vtkCaptionWidget</a>. A caption is defined by some text with a leader (e.g., arrow) that points from the text to a point in the scene. The caption is defined by an instance of <a class="el" href="a00233.html" title="draw text label associated with a point">vtkCaptionActor2D</a>. It uses the event bindings of its superclass (<a class="el" href="a00192.html" title="place a border around a 2D rectangular region">vtkBorderWidget</a>) to control the placement of the text, and adds the ability to move the attachment point around. In addition, when the caption text is selected, the widget emits a ActivateEvent that observers can watch for. This is useful for opening GUI dialogoues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)<p>
Note that this widget extends the behavior of its superclass <a class="el" href="a00191.html" title="represent a vtkBorderWidget">vtkBorderRepresentation</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00235.html" title="widget for placing a caption (text plus leader)">vtkCaptionWidget</a> <a class="el" href="a00192.html" title="place a border around a 2D rectangular region">vtkBorderWidget</a> <a class="el" href="a00191.html" title="represent a vtkBorderWidget">vtkBorderRepresentation</a> vtkCaptionActor </dd></dl>
<p>Definition at line <a class="el" href="a05461.html#l00046">46</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.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="a00191.html">vtkBorderRepresentation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#a82ca3e89c6a3440950c426176287c4a">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="a00234.html#8145f9066052d4a30c435ece3eed0f5b">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00234.html">vtkCaptionRepresentation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#d7cd2ab67c0e2b5ca581ae372b789a15">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="a00234.html#488485238ffdfb3ce05e0ed804968e88">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="a00234.html#faa182bdd67815baf13a6ecede97e33b">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="a00234.html#a2ca91e5b48ed8000ccd3ce116eb5b7c">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 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="a00234.html#fa660cb5a48c5ad8335254ea93d1c8dd">SetAnchorPosition</a> (double pos[3])</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#e7c10df0180c0358ab185b34792a94fd">GetAnchorPosition</a> (double pos[3])</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="a00234.html#ffa17bebbc021589696242587518c6f4">SetCaptionActor2D</a> (<a class="el" href="a00233.html">vtkCaptionActor2D</a> *captionActor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00233.html">vtkCaptionActor2D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#c430c0785a9459f05d5c5f17fe887be1">GetCaptionActor2D</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="a00234.html#47e6d74e0b1fbfd043e618b40fa3602b">SetAnchorRepresentation</a> (<a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#94ac044048d9483213d560f2249f1e48">GetAnchorRepresentation</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#bd45f37f696021185c87bb27d67a2204">BuildRepresentation</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#72bc543b8f7174afa4e8b5ef3de65523">GetSize</a> (double size[2])</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#916210ee44ba53ce53112c0bd649a76d">GetActors2D</a> (<a class="el" href="a01321.html">vtkPropCollection</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#e2e38d108513d96169c47e62d91d65ef">ReleaseGraphicsResources</a> (<a class="el" href="a01886.html">vtkWindow</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#766403394d1329428bec493b00536493">RenderOverlay</a> (<a class="el" href="a01833.html">vtkViewport</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#8a423fea984c7a1d30737e080483294d">RenderOpaqueGeometry</a> (<a class="el" href="a01833.html">vtkViewport</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#64d52c1e3cbc3bd8bf0ee0c900cf3986">RenderTranslucentPolygonalGeometry</a> (<a class="el" href="a01833.html">vtkViewport</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#0cff9b2a3c327ea66a6e1b0ecae0cb41">HasTranslucentPolygonalGeometry</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#3e14ef91c1fb8e542e42c03bf9bc6a16">SetFontFactor</a> (double)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#64770c1d2f9564348670b6efac331a60">GetFontFactor</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="a00234.html">vtkCaptionRepresentation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#52e1666a18ccf781623391ed726317d1">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="a00234.html#50be0e87c85384e7705de09a1e75461a">vtkCaptionRepresentation</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#b54997f09925b23cfc216e96689b3736">~vtkCaptionRepresentation</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#57c5934b9f7aa18169e5d2b0429e252a">AdjustCaptionBoundary</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00233.html">vtkCaptionActor2D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#32459c6a472d83f108340fe0b292ca25">CaptionActor2D</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00316.html">vtkConeSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#e018f333dcaecad268d9073130a78098">CaptionGlyph</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#791fafada7edf952a14b48aedb9caab1">PointWidgetState</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#c4647ffe7f82342ccd12c7a0b77ebfe4">DisplayAttachmentPoint</a> [2]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#5f6255b5f92b4e4d7d70b794af033b7d">FontFactor</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00234.html#6bc89919d7657cdd9e29654555683f7f">AnchorRepresentation</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="a82ca3e89c6a3440950c426176287c4a"></a><!-- doxytag: member="vtkCaptionRepresentation::Superclass" ref="a82ca3e89c6a3440950c426176287c4a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00191.html">vtkBorderRepresentation</a> <a class="el" href="a00191.html">vtkCaptionRepresentation::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#0e71b6e6ffff5c3fe1c4114e5d4604b8">vtkBorderRepresentation</a>.</p>
<p>Definition at line <a class="el" href="a05461.html#l00054">54</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="50be0e87c85384e7705de09a1e75461a"></a><!-- doxytag: member="vtkCaptionRepresentation::vtkCaptionRepresentation" ref="50be0e87c85384e7705de09a1e75461a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCaptionRepresentation::vtkCaptionRepresentation </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="b54997f09925b23cfc216e96689b3736"></a><!-- doxytag: member="vtkCaptionRepresentation::~vtkCaptionRepresentation" ref="b54997f09925b23cfc216e96689b3736" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCaptionRepresentation::~vtkCaptionRepresentation </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="52e1666a18ccf781623391ed726317d1"></a><!-- doxytag: member="vtkCaptionRepresentation::New" ref="52e1666a18ccf781623391ed726317d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00234.html">vtkCaptionRepresentation</a>* vtkCaptionRepresentation::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="a00191.html#0ad7fa200f3d741e037b741bf764919a">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="488485238ffdfb3ce05e0ed804968e88"></a><!-- doxytag: member="vtkCaptionRepresentation::GetClassName" ref="488485238ffdfb3ce05e0ed804968e88" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkCaptionRepresentation::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#f6b780ee03cc3424a1050c553c85795c">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="8145f9066052d4a30c435ece3eed0f5b"></a><!-- doxytag: member="vtkCaptionRepresentation::IsTypeOf" ref="8145f9066052d4a30c435ece3eed0f5b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkCaptionRepresentation::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 VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#0dd1520da553c53f96ba662b57471c20">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="faa182bdd67815baf13a6ecede97e33b"></a><!-- doxytag: member="vtkCaptionRepresentation::IsA" ref="faa182bdd67815baf13a6ecede97e33b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionRepresentation::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 VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#f1d45e9d08fe3e3382be4fb078bea008">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="d7cd2ab67c0e2b5ca581ae372b789a15"></a><!-- doxytag: member="vtkCaptionRepresentation::SafeDownCast" ref="d7cd2ab67c0e2b5ca581ae372b789a15" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00234.html">vtkCaptionRepresentation</a>* vtkCaptionRepresentation::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 VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#ae3beb85793536f2289320ee25e0680d">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="a2ca91e5b48ed8000ccd3ce116eb5b7c"></a><!-- doxytag: member="vtkCaptionRepresentation::PrintSelf" ref="a2ca91e5b48ed8000ccd3ce116eb5b7c" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionRepresentation::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 VTK class methods.
<p>Reimplemented from <a class="el" href="a00191.html#45878f99c7a52222755ffbe708207135">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="fa660cb5a48c5ad8335254ea93d1c8dd"></a><!-- doxytag: member="vtkCaptionRepresentation::SetAnchorPosition" ref="fa660cb5a48c5ad8335254ea93d1c8dd" args="(double pos[3])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionRepresentation::SetAnchorPosition </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>pos</em>[3] </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the position of the anchor (i.e., the point that the caption is anchored to). Note that the position should be specified in world coordinates.
</div>
</div><p>
<a class="anchor" name="e7c10df0180c0358ab185b34792a94fd"></a><!-- doxytag: member="vtkCaptionRepresentation::GetAnchorPosition" ref="e7c10df0180c0358ab185b34792a94fd" args="(double pos[3])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionRepresentation::GetAnchorPosition </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>pos</em>[3] </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the position of the anchor (i.e., the point that the caption is anchored to). Note that the position should be specified in world coordinates.
</div>
</div><p>
<a class="anchor" name="ffa17bebbc021589696242587518c6f4"></a><!-- doxytag: member="vtkCaptionRepresentation::SetCaptionActor2D" ref="ffa17bebbc021589696242587518c6f4" args="(vtkCaptionActor2D *captionActor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionRepresentation::SetCaptionActor2D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00233.html">vtkCaptionActor2D</a> * </td>
<td class="paramname"> <em>captionActor</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the <a class="el" href="a00233.html" title="draw text label associated with a point">vtkCaptionActor2D</a> to manage. If not specified, then one is automatically created.
</div>
</div><p>
<a class="anchor" name="c430c0785a9459f05d5c5f17fe887be1"></a><!-- doxytag: member="vtkCaptionRepresentation::GetCaptionActor2D" ref="c430c0785a9459f05d5c5f17fe887be1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00233.html">vtkCaptionActor2D</a>* vtkCaptionRepresentation::GetCaptionActor2D </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Specify the <a class="el" href="a00233.html" title="draw text label associated with a point">vtkCaptionActor2D</a> to manage. If not specified, then one is automatically created.
</div>
</div><p>
<a class="anchor" name="47e6d74e0b1fbfd043e618b40fa3602b"></a><!-- doxytag: member="vtkCaptionRepresentation::SetAnchorRepresentation" ref="47e6d74e0b1fbfd043e618b40fa3602b" args="(vtkPointHandleRepresentation3D *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCaptionRepresentation::SetAnchorRepresentation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. Normally default representations are created, but you can specify the ones you want to use.
</div>
</div><p>
<a class="anchor" name="94ac044048d9483213d560f2249f1e48"></a><!-- doxytag: member="vtkCaptionRepresentation::GetAnchorRepresentation" ref="94ac044048d9483213d560f2249f1e48" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a>* vtkCaptionRepresentation::GetAnchorRepresentation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. Normally default representations are created, but you can specify the ones you want to use.
</div>
</div><p>
<a class="anchor" name="bd45f37f696021185c87bb27d67a2204"></a><!-- doxytag: member="vtkCaptionRepresentation::BuildRepresentation" ref="bd45f37f696021185c87bb27d67a2204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::BuildRepresentation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Satisfy the superclasses API.
<p>Reimplemented from <a class="el" href="a00191.html#f6d66949b28c13274e9f9b7ce9f6490c">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="72bc543b8f7174afa4e8b5ef3de65523"></a><!-- doxytag: member="vtkCaptionRepresentation::GetSize" ref="72bc543b8f7174afa4e8b5ef3de65523" args="(double size[2])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::GetSize </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>size</em>[2] </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Satisfy the superclasses API.
<p>Reimplemented from <a class="el" href="a00191.html#05011db793b24bea2b33def2fad40fff">vtkBorderRepresentation</a>.</p>
<p>Definition at line <a class="el" href="a05461.html#l00084">84</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="916210ee44ba53ce53112c0bd649a76d"></a><!-- doxytag: member="vtkCaptionRepresentation::GetActors2D" ref="916210ee44ba53ce53112c0bd649a76d" args="(vtkPropCollection *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::GetActors2D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01321.html">vtkPropCollection</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#d0efdc8a0fc7c07f0f9759199b728a18">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="e2e38d108513d96169c47e62d91d65ef"></a><!-- doxytag: member="vtkCaptionRepresentation::ReleaseGraphicsResources" ref="e2e38d108513d96169c47e62d91d65ef" args="(vtkWindow *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::ReleaseGraphicsResources </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01886.html">vtkWindow</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#e5c7416657788125c4d9d6ca7b244097">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="766403394d1329428bec493b00536493"></a><!-- doxytag: member="vtkCaptionRepresentation::RenderOverlay" ref="766403394d1329428bec493b00536493" args="(vtkViewport *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionRepresentation::RenderOverlay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01833.html">vtkViewport</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#2a4da3bfb25a0bd73bf489883158b551">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="8a423fea984c7a1d30737e080483294d"></a><!-- doxytag: member="vtkCaptionRepresentation::RenderOpaqueGeometry" ref="8a423fea984c7a1d30737e080483294d" args="(vtkViewport *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionRepresentation::RenderOpaqueGeometry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01833.html">vtkViewport</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#774f72e7e9172e8c1aa4e1e874be8a28">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="64d52c1e3cbc3bd8bf0ee0c900cf3986"></a><!-- doxytag: member="vtkCaptionRepresentation::RenderTranslucentPolygonalGeometry" ref="64d52c1e3cbc3bd8bf0ee0c900cf3986" args="(vtkViewport *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionRepresentation::RenderTranslucentPolygonalGeometry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01833.html">vtkViewport</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#0260457c73cd281b4255f88e1c77b53d">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="0cff9b2a3c327ea66a6e1b0ecae0cb41"></a><!-- doxytag: member="vtkCaptionRepresentation::HasTranslucentPolygonalGeometry" ref="0cff9b2a3c327ea66a6e1b0ecae0cb41" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCaptionRepresentation::HasTranslucentPolygonalGeometry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods are necessary to make this representation behave as a <a class="el" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a>.
<p>Reimplemented from <a class="el" href="a00191.html#ce2f3c6d80ceabf42ae79dbcb595e0e0">vtkBorderRepresentation</a>.</p>
</div>
</div><p>
<a class="anchor" name="3e14ef91c1fb8e542e42c03bf9bc6a16"></a><!-- doxytag: member="vtkCaptionRepresentation::SetFontFactor" ref="3e14ef91c1fb8e542e42c03bf9bc6a16" args="(double)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::SetFontFactor </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF
</div>
</div><p>
<a class="anchor" name="64770c1d2f9564348670b6efac331a60"></a><!-- doxytag: member="vtkCaptionRepresentation::GetFontFactor" ref="64770c1d2f9564348670b6efac331a60" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double vtkCaptionRepresentation::GetFontFactor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF
</div>
</div><p>
<a class="anchor" name="57c5934b9f7aa18169e5d2b0429e252a"></a><!-- doxytag: member="vtkCaptionRepresentation::AdjustCaptionBoundary" ref="57c5934b9f7aa18169e5d2b0429e252a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkCaptionRepresentation::AdjustCaptionBoundary </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="32459c6a472d83f108340fe0b292ca25"></a><!-- doxytag: member="vtkCaptionRepresentation::CaptionActor2D" ref="32459c6a472d83f108340fe0b292ca25" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00233.html">vtkCaptionActor2D</a>* <a class="el" href="a00234.html#32459c6a472d83f108340fe0b292ca25">vtkCaptionRepresentation::CaptionActor2D</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00111">111</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="e018f333dcaecad268d9073130a78098"></a><!-- doxytag: member="vtkCaptionRepresentation::CaptionGlyph" ref="e018f333dcaecad268d9073130a78098" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00316.html">vtkConeSource</a>* <a class="el" href="a00234.html#e018f333dcaecad268d9073130a78098">vtkCaptionRepresentation::CaptionGlyph</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00112">112</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="791fafada7edf952a14b48aedb9caab1"></a><!-- doxytag: member="vtkCaptionRepresentation::PointWidgetState" ref="791fafada7edf952a14b48aedb9caab1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00234.html#791fafada7edf952a14b48aedb9caab1">vtkCaptionRepresentation::PointWidgetState</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00114">114</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c4647ffe7f82342ccd12c7a0b77ebfe4"></a><!-- doxytag: member="vtkCaptionRepresentation::DisplayAttachmentPoint" ref="c4647ffe7f82342ccd12c7a0b77ebfe4" args="[2]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a00234.html#c4647ffe7f82342ccd12c7a0b77ebfe4">vtkCaptionRepresentation::DisplayAttachmentPoint</a>[2]<code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00115">115</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5f6255b5f92b4e4d7d70b794af033b7d"></a><!-- doxytag: member="vtkCaptionRepresentation::FontFactor" ref="5f6255b5f92b4e4d7d70b794af033b7d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="a00234.html#5f6255b5f92b4e4d7d70b794af033b7d">vtkCaptionRepresentation::FontFactor</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00116">116</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6bc89919d7657cdd9e29654555683f7f"></a><!-- doxytag: member="vtkCaptionRepresentation::AnchorRepresentation" ref="6bc89919d7657cdd9e29654555683f7f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01245.html">vtkPointHandleRepresentation3D</a>* <a class="el" href="a00234.html#6bc89919d7657cdd9e29654555683f7f">vtkCaptionRepresentation::AnchorRepresentation</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05461.html#l00119">119</a> of file <a class="el" href="a05461.html">vtkCaptionRepresentation.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="a05461.html">vtkCaptionRepresentation.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:55:52 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
>
237
