← Back to branch summary

~peekabot-devs/peekabot/peekabot.org

« back to all changes in this revision

Viewing changes to doc/0.8.x/classpeekabot_1_1client_1_1ScalableProxyBase.html

  • Committer: Staffan Gimåker
  • Date: 2011-01-30 20:22:14 UTC
  • Revision ID: staffan@gimaker.se-20110130202214-joasm9qvwni8n0g7
Add doxygen documentation for 0.8.x.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/0.8.x/classpeekabot_1_1client_1_1ScalableProxyBase.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>peekabot: ScalableProxyBase Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.1 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul class="tablist">
 
14
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
16
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
17
      <li><a href="files.html"><span>Files</span></a></li>
 
18
    </ul>
 
19
  </div>
 
20
  <div class="tabs2">
 
21
    <ul class="tablist">
 
22
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
23
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
 
24
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
25
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
26
    </ul>
 
27
  </div>
 
28
  <div class="navpath">
 
29
    <ul>
 
30
      <li><b>peekabot</b>      </li>
 
31
      <li><b>client</b>      </li>
 
32
      <li><a class="el" href="classpeekabot_1_1client_1_1ScalableProxyBase.html">ScalableProxyBase</a>      </li>
 
33
    </ul>
 
34
  </div>
 
35
</div>
 
36
<div class="header">
 
37
  <div class="summary">
 
38
<a href="#pub-methods">Public Member Functions</a>  </div>
 
39
  <div class="headertitle">
 
40
<h1>ScalableProxyBase Class Reference</h1>  </div>
 
41
</div>
 
42
<div class="contents">
 
43
<!-- doxytag: class="peekabot::client::ScalableProxyBase" --><!-- doxytag: inherits="peekabot::client::ObjectProxyBase" -->
 
44
<p>Base class for all scalable object proxies.  
 
45
<a href="#_details">More...</a></p>
 
46
<div class="dynheader">
 
47
Inheritance diagram for ScalableProxyBase:</div>
 
48
<div class="dyncontent">
 
49
<div class="center"><img src="classpeekabot_1_1client_1_1ScalableProxyBase__inherit__graph.png" border="0" usemap="#ScalableProxyBase_inherit__map" alt="Inheritance graph"/></div>
 
50
<map name="ScalableProxyBase_inherit__map" id="ScalableProxyBase_inherit__map">
 
51
<area shape="rect" id="node7" href="classpeekabot_1_1client_1_1CircleProxyBase.html" title="Base class for CircleProxy." alt="" coords="619,5,749,35"/><area shape="rect" id="node11" href="classpeekabot_1_1client_1_1CubeProxyBase.html" title="Base class for CubeProxy." alt="" coords="620,59,748,88"/><area shape="rect" id="node15" href="classpeekabot_1_1client_1_1CylinderProxyBase.html" title="Base class for CylinderProxy." alt="" coords="611,112,757,141"/><area shape="rect" id="node19" href="classpeekabot_1_1client_1_1GridProxyBase.html" title="Base class for GridProxy." alt="" coords="624,165,744,195"/><area shape="rect" id="node23" href="classpeekabot_1_1client_1_1LabelProxyBase.html" title="Base class for LabelProxy." alt="" coords="619,219,749,248"/><area shape="rect" id="node27" href="classpeekabot_1_1client_1_1LineCloudProxyBase.html" title="Base class for LineCloudProxy." alt="" coords="605,272,763,301"/><area shape="rect" id="node31" href="classpeekabot_1_1client_1_1ModelProxyBase.html" title="Base class for ModelProxy." alt="" coords="617,325,751,355"/><area shape="rect" id="node35" href="classpeekabot_1_1client_1_1PointCloudProxyBase.html" title="Base class for PointCloudProxy." alt="" coords="601,379,767,408"/><area shape="rect" id="node39" href="classpeekabot_1_1client_1_1PolygonProxyBase.html" title="Base class for PolygonProxy." alt="" coords="611,432,757,461"/><area shape="rect" id="node43" href="classpeekabot_1_1client_1_1PolylineProxyBase.html" title="Base class for PolylineProxy." alt="" coords="612,485,756,515"/><area shape="rect" id="node47" href="classpeekabot_1_1client_1_1ScalableProxy.html" title="Proxy class used to manipulate any type of scalable object." alt="" coords="627,539,741,568"/><area shape="rect" id="node49" href="classpeekabot_1_1client_1_1SphereProxyBase.html" title="Base class for SphereProxy." alt="" coords="613,592,755,621"/><area shape="rect" id="node53" href="classpeekabot_1_1client_1_1TriMeshProxyBase.html" title="Base class for TriMeshProxy." alt="" coords="612,645,756,675"/><area shape="rect" id="node2" href="classpeekabot_1_1client_1_1ObjectProxyBase.html" title="Base class for all client object proxies." alt="" coords="213,325,355,355"/><area shape="rect" id="node4" href="classpeekabot_1_1client_1_1PeekabotProxyBase.html" title="Base class for all client proxies." alt="" coords="7,325,164,355"/><area shape="rect" id="node9" href="classpeekabot_1_1client_1_1CircleProxy.html" title="Proxy class used to add and manipulate circles." alt="" coords="833,5,932,35"/><area shape="rect" id="node13" href="classpeekabot_1_1client_1_1CubeProxy.html" title="Proxy class used to add and manipulate cubes." alt="" coords="836,59,929,88"/><area shape="rect" id="node17" href="classpeekabot_1_1client_1_1CylinderProxy.html" title="Proxy class used to add and manipulate cylinders." alt="" coords="825,112,940,141"/><area shape="rect" id="node21" href="classpeekabot_1_1client_1_1GridProxy.html" title="Proxy class used to add and manipulate grids." alt="" coords="840,165,925,195"/><area shape="rect" id="node25" href="classpeekabot_1_1client_1_1LabelProxy.html" title="Proxy class used to add and manipulate orientable text labels." alt="" coords="835,219,931,248"/><area shape="rect" id="node29" href="classpeekabot_1_1client_1_1LineCloudProxy.html" title="Proxy class used to add and manipulate line clouds." alt="" coords="820,272,945,301"/><area shape="rect" id="node33" href="classpeekabot_1_1client_1_1ModelProxy.html" title="Proxy class used to add and manipulate models." alt="" coords="833,325,932,355"/><area shape="rect" id="node37" href="classpeekabot_1_1client_1_1PointCloudProxy.html" title="Proxy class used to add and manipulate point clouds." alt="" coords="817,379,948,408"/><area shape="rect" id="node41" href="classpeekabot_1_1client_1_1PolygonProxy.html" title="Proxy class used to add and manipulate polygons." alt="" coords="827,432,939,461"/><area shape="rect" id="node45" href="classpeekabot_1_1client_1_1PolylineProxy.html" title="Proxy class used to add and manipulate polylines." alt="" coords="828,485,937,515"/><area shape="rect" id="node51" href="classpeekabot_1_1client_1_1SphereProxy.html" title="Proxy class used to add and manipulate spheres." alt="" coords="829,592,936,621"/><area shape="rect" id="node55" href="classpeekabot_1_1client_1_1TriMeshProxy.html" title="Proxy class used to add and manipulate used&#45;specified triangular meshes." alt="" coords="828,645,937,675"/></map>
 
52
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
 
53
 
 
54
<p><a href="classpeekabot_1_1client_1_1ScalableProxyBase-members.html">List of all members.</a></p>
 
55
<table class="memberdecls">
 
56
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
57
Public Member Functions</h2></td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2550259b2505d42c48d14d207c22f90"></a><!-- doxytag: member="peekabot::client::ScalableProxyBase::ScalableProxyBase" ref="ae2550259b2505d42c48d14d207c22f90" args="(const ScalableProxyBase &amp;p)" -->
 
59
&nbsp;</td><td class="memItemRight" valign="bottom"><b>ScalableProxyBase</b> (const <a class="el" href="classpeekabot_1_1client_1_1ScalableProxyBase.html">ScalableProxyBase</a> &amp;p)</td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpeekabot_1_1client_1_1ScalableProxyBase.html#a4d8f310ac4e30eaa3161011eb4eee261">set_scale</a> (float scale)</td></tr>
 
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the scale of the object to <em>scale</em>, uniformly along all three axes.  <a href="#a4d8f310ac4e30eaa3161011eb4eee261"></a><br/></td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpeekabot_1_1client_1_1ScalableProxyBase.html#ab3939af16c3f4157c8467a5a4d343ee1">set_scale</a> (float x_scale, float y_scale, float z_scale)</td></tr>
 
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the object's scale along the three different axes.  <a href="#ab3939af16c3f4157c8467a5a4d343ee1"></a><br/></td></tr>
 
64
</table>
 
65
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
66
<p>Base class for all scalable object proxies. </p>
 
67
<hr/><h2>Member Function Documentation</h2>
 
68
<a class="anchor" id="a4d8f310ac4e30eaa3161011eb4eee261"></a><!-- doxytag: member="peekabot::client::ScalableProxyBase::set_scale" ref="a4d8f310ac4e30eaa3161011eb4eee261" args="(float scale)" -->
 
69
<div class="memitem">
 
70
<div class="memproto">
 
71
      <table class="memname">
 
72
        <tr>
 
73
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> set_scale </td>
 
74
          <td>(</td>
 
75
          <td class="paramtype">float&nbsp;</td>
 
76
          <td class="paramname"> <em>scale</em></td>
 
77
          <td>&nbsp;)&nbsp;</td>
 
78
          <td><code> [inline]</code></td>
 
79
        </tr>
 
80
      </table>
 
81
</div>
 
82
<div class="memdoc">
 
83
 
 
84
<p>Set the scale of the object to <em>scale</em>, uniformly along all three axes. </p>
 
85
<p>The scaling is performed along the local axes of the object.</p>
 
86
<dl class="pre"><dt><b>Precondition:</b></dt><dd>scale &gt; 0 </dd></dl>
 
87
 
 
88
</div>
 
89
</div>
 
90
<a class="anchor" id="ab3939af16c3f4157c8467a5a4d343ee1"></a><!-- doxytag: member="peekabot::client::ScalableProxyBase::set_scale" ref="ab3939af16c3f4157c8467a5a4d343ee1" args="(float x_scale, float y_scale, float z_scale)" -->
 
91
<div class="memitem">
 
92
<div class="memproto">
 
93
      <table class="memname">
 
94
        <tr>
 
95
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> set_scale </td>
 
96
          <td>(</td>
 
97
          <td class="paramtype">float&nbsp;</td>
 
98
          <td class="paramname"> <em>x_scale</em>, </td>
 
99
        </tr>
 
100
        <tr>
 
101
          <td class="paramkey"></td>
 
102
          <td></td>
 
103
          <td class="paramtype">float&nbsp;</td>
 
104
          <td class="paramname"> <em>y_scale</em>, </td>
 
105
        </tr>
 
106
        <tr>
 
107
          <td class="paramkey"></td>
 
108
          <td></td>
 
109
          <td class="paramtype">float&nbsp;</td>
 
110
          <td class="paramname"> <em>z_scale</em></td><td>&nbsp;</td>
 
111
        </tr>
 
112
        <tr>
 
113
          <td></td>
 
114
          <td>)</td>
 
115
          <td></td><td></td><td></td>
 
116
        </tr>
 
117
      </table>
 
118
</div>
 
119
<div class="memdoc">
 
120
 
 
121
<p>Set the object's scale along the three different axes. </p>
 
122
<p>The scaling is performed along the local axes of the object.</p>
 
123
<dl class="pre"><dt><b>Precondition:</b></dt><dd>x_scale, y_scale, z_scale &gt; 0 </dd></dl>
 
124
 
 
125
</div>
 
126
</div>
 
127
<hr/>The documentation for this class was generated from the following files:<ul>
 
128
<li>src/client/proxies/<a class="el" href="ScalableProxy_8hh_source.html">ScalableProxy.hh</a></li>
 
129
<li>src/client/proxies/ScalableProxy.cc</li>
 
130
</ul>
 
131
</div>
 
132
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 30 2011 for peekabot by&nbsp;
 
133
<a href="http://www.doxygen.org/index.html">
 
134
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
 
135
</body>
 
136
</html>