← 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_1SliderProxy.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_1SliderProxy.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: SliderProxy 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_1SliderProxy.html">SliderProxy</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>SliderProxy Class Reference</h1>  </div>
 
41
</div>
 
42
<div class="contents">
 
43
<!-- doxytag: class="peekabot::client::SliderProxy" --><!-- doxytag: inherits="peekabot::client::SliderProxyBase" -->
 
44
<p>Proxy class used manipulate sliders.  
 
45
<a href="#_details">More...</a></p>
 
46
<div class="dynheader">
 
47
Inheritance diagram for SliderProxy:</div>
 
48
<div class="dyncontent">
 
49
<div class="center"><img src="classpeekabot_1_1client_1_1SliderProxy__inherit__graph.png" border="0" usemap="#SliderProxy_inherit__map" alt="Inheritance graph"/></div>
 
50
<map name="SliderProxy_inherit__map" id="SliderProxy_inherit__map">
 
51
<area shape="rect" id="node2" href="classpeekabot_1_1client_1_1SliderProxyBase.html" title="Base class for SliderProxy." alt="" coords="19,237,149,267"/><area shape="rect" id="node4" href="classpeekabot_1_1client_1_1JointProxyBase.html" title="Base class for JointProxy." alt="" coords="23,160,145,189"/><area shape="rect" id="node6" href="classpeekabot_1_1client_1_1ObjectProxyBase.html" title="Base class for all client object proxies." alt="" coords="13,83,155,112"/><area shape="rect" id="node8" href="classpeekabot_1_1client_1_1PeekabotProxyBase.html" title="Base class for all client proxies." alt="" coords="5,5,163,35"/></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_1SliderProxy-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="a7c858e50f0c45d9f7c833a54f8f640ef"></a><!-- doxytag: member="peekabot::client::SliderProxy::SliderProxy" ref="a7c858e50f0c45d9f7c833a54f8f640ef" args="(const SliderProxyBase &amp;p)" -->
 
59
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SliderProxy</b> (const <a class="el" href="classpeekabot_1_1client_1_1SliderProxyBase.html">SliderProxyBase</a> &amp;p)</td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa24ad9d2e26b203d3ba66f4945a8e99"></a><!-- doxytag: member="peekabot::client::SliderProxy::operator=" ref="aaa24ad9d2e26b203d3ba66f4945a8e99" args="(const SliderProxy &amp;p)" -->
 
61
<a class="el" href="classpeekabot_1_1client_1_1SliderProxy.html">SliderProxy</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classpeekabot_1_1client_1_1SliderProxy.html">SliderProxy</a> &amp;p)</td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0d69989d01f8255f1aa914c861e2671"></a><!-- doxytag: member="peekabot::client::SliderProxy::operator=" ref="ae0d69989d01f8255f1aa914c861e2671" args="(const SliderProxyBase &amp;p)" -->
 
63
<a class="el" href="classpeekabot_1_1client_1_1SliderProxy.html">SliderProxy</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classpeekabot_1_1client_1_1SliderProxyBase.html">SliderProxyBase</a> &amp;p)</td></tr>
 
64
<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_1SliderProxy.html#ac68e8a0ca5d74961059f4b067f56949f">assign</a> (const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;p)</td></tr>
 
65
<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_1SliderProxy.html#a11ba902a669c337ff5f56517e2b19545">assign</a> (<a class="el" href="classpeekabot_1_1client_1_1PeekabotClient.html">PeekabotClient</a> &amp;client, const std::string &amp;path)</td></tr>
 
66
<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_1SliderProxy.html#a098cf4bcf4c3f7ddff655758d0807f84">assign</a> (const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;parent, const std::string &amp;rel_path)</td></tr>
 
67
<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_1SliderProxy.html#a490d4b278a48be0eff59052d549c9ffc">add</a> (<a class="el" href="classpeekabot_1_1client_1_1PeekabotClient.html">PeekabotClient</a> &amp;client, const std::string &amp;path, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)</td></tr>
 
68
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a slider joint.  <a href="#a490d4b278a48be0eff59052d549c9ffc"></a><br/></td></tr>
 
69
<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_1SliderProxy.html#a2a7d8edb1785e595fbdb128b64f50806">add</a> (const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;parent, const std::string &amp;name, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)</td></tr>
 
70
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a slider joint.  <a href="#a2a7d8edb1785e595fbdb128b64f50806"></a><br/></td></tr>
 
71
</table>
 
72
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
73
<p>Proxy class used manipulate sliders. </p>
 
74
<hr/><h2>Member Function Documentation</h2>
 
75
<a class="anchor" id="a490d4b278a48be0eff59052d549c9ffc"></a><!-- doxytag: member="peekabot::client::SliderProxy::add" ref="a490d4b278a48be0eff59052d549c9ffc" args="(PeekabotClient &amp;client, const std::string &amp;path, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)" -->
 
76
<div class="memitem">
 
77
<div class="memproto">
 
78
      <table class="memname">
 
79
        <tr>
 
80
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> add </td>
 
81
          <td>(</td>
 
82
          <td class="paramtype"><a class="el" href="classpeekabot_1_1client_1_1PeekabotClient.html">PeekabotClient</a> &amp;&nbsp;</td>
 
83
          <td class="paramname"> <em>client</em>, </td>
 
84
        </tr>
 
85
        <tr>
 
86
          <td class="paramkey"></td>
 
87
          <td></td>
 
88
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
89
          <td class="paramname"> <em>path</em>, </td>
 
90
        </tr>
 
91
        <tr>
 
92
          <td class="paramkey"></td>
 
93
          <td></td>
 
94
          <td class="paramtype">NameConflictPolicy&nbsp;</td>
 
95
          <td class="paramname"> <em>conflict_policy</em> = <code>AUTO_ENUMERATE_ON_CONFLICT</code></td><td>&nbsp;</td>
 
96
        </tr>
 
97
        <tr>
 
98
          <td></td>
 
99
          <td>)</td>
 
100
          <td></td><td></td><td></td>
 
101
        </tr>
 
102
      </table>
 
103
</div>
 
104
<div class="memdoc">
 
105
 
 
106
<p>Add a slider joint. </p>
 
107
<p>If an object already exists at the given path the outcome is governed by <em>conflict_policy</em>.</p>
 
108
<dl><dt><b>Parameters:</b></dt><dd>
 
109
  <table border="0" cellspacing="2" cellpadding="0">
 
110
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>The path where the object will be added, including the name of the object. </td></tr>
 
111
    <tr><td valign="top"></td><td valign="top"><em>conflict_policy</em>&nbsp;</td><td>Determines how name conflicts are handled. </td></tr>
 
112
  </table>
 
113
  </dd>
 
114
</dl>
 
115
 
 
116
</div>
 
117
</div>
 
118
<a class="anchor" id="a2a7d8edb1785e595fbdb128b64f50806"></a><!-- doxytag: member="peekabot::client::SliderProxy::add" ref="a2a7d8edb1785e595fbdb128b64f50806" args="(const ObjectProxyBase &amp;parent, const std::string &amp;name, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)" -->
 
119
<div class="memitem">
 
120
<div class="memproto">
 
121
      <table class="memname">
 
122
        <tr>
 
123
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> add </td>
 
124
          <td>(</td>
 
125
          <td class="paramtype">const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;&nbsp;</td>
 
126
          <td class="paramname"> <em>parent</em>, </td>
 
127
        </tr>
 
128
        <tr>
 
129
          <td class="paramkey"></td>
 
130
          <td></td>
 
131
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
132
          <td class="paramname"> <em>name</em>, </td>
 
133
        </tr>
 
134
        <tr>
 
135
          <td class="paramkey"></td>
 
136
          <td></td>
 
137
          <td class="paramtype">NameConflictPolicy&nbsp;</td>
 
138
          <td class="paramname"> <em>conflict_policy</em> = <code>AUTO_ENUMERATE_ON_CONFLICT</code></td><td>&nbsp;</td>
 
139
        </tr>
 
140
        <tr>
 
141
          <td></td>
 
142
          <td>)</td>
 
143
          <td></td><td></td><td></td>
 
144
        </tr>
 
145
      </table>
 
146
</div>
 
147
<div class="memdoc">
 
148
 
 
149
<p>Add a slider joint. </p>
 
150
<p>If an object already exists at the given path the outcome is governed by <em>conflict_policy</em>.</p>
 
151
<dl><dt><b>Parameters:</b></dt><dd>
 
152
  <table border="0" cellspacing="2" cellpadding="0">
 
153
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The parent under which the object will be added. </td></tr>
 
154
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name to assign to the created object. </td></tr>
 
155
    <tr><td valign="top"></td><td valign="top"><em>conflict_policy</em>&nbsp;</td><td>Determines how name conflicts are handled. </td></tr>
 
156
  </table>
 
157
  </dd>
 
158
</dl>
 
159
 
 
160
</div>
 
161
</div>
 
162
<a class="anchor" id="a11ba902a669c337ff5f56517e2b19545"></a><!-- doxytag: member="peekabot::client::SliderProxy::assign" ref="a11ba902a669c337ff5f56517e2b19545" args="(PeekabotClient &amp;client, const std::string &amp;path)" -->
 
163
<div class="memitem">
 
164
<div class="memproto">
 
165
      <table class="memname">
 
166
        <tr>
 
167
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> assign </td>
 
168
          <td>(</td>
 
169
          <td class="paramtype"><a class="el" href="classpeekabot_1_1client_1_1PeekabotClient.html">PeekabotClient</a> &amp;&nbsp;</td>
 
170
          <td class="paramname"> <em>client</em>, </td>
 
171
        </tr>
 
172
        <tr>
 
173
          <td class="paramkey"></td>
 
174
          <td></td>
 
175
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
176
          <td class="paramname"> <em>path</em></td><td>&nbsp;</td>
 
177
        </tr>
 
178
        <tr>
 
179
          <td></td>
 
180
          <td>)</td>
 
181
          <td></td><td></td><td></td>
 
182
        </tr>
 
183
      </table>
 
184
</div>
 
185
<div class="memdoc">
 
186
<p>Assign the proxy to the object with the given path. </p>
 
187
<dl><dt><b>Parameters:</b></dt><dd>
 
188
  <table border="0" cellspacing="2" cellpadding="0">
 
189
    <tr><td valign="top"></td><td valign="top"><em>client</em>&nbsp;</td><td>The client to use for this proxy. </td></tr>
 
190
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>The path of the object in the peeakbot scene. </td></tr>
 
191
  </table>
 
192
  </dd>
 
193
</dl>
 
194
 
 
195
</div>
 
196
</div>
 
197
<a class="anchor" id="a098cf4bcf4c3f7ddff655758d0807f84"></a><!-- doxytag: member="peekabot::client::SliderProxy::assign" ref="a098cf4bcf4c3f7ddff655758d0807f84" args="(const ObjectProxyBase &amp;parent, const std::string &amp;rel_path)" -->
 
198
<div class="memitem">
 
199
<div class="memproto">
 
200
      <table class="memname">
 
201
        <tr>
 
202
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> assign </td>
 
203
          <td>(</td>
 
204
          <td class="paramtype">const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;&nbsp;</td>
 
205
          <td class="paramname"> <em>parent</em>, </td>
 
206
        </tr>
 
207
        <tr>
 
208
          <td class="paramkey"></td>
 
209
          <td></td>
 
210
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
211
          <td class="paramname"> <em>rel_path</em></td><td>&nbsp;</td>
 
212
        </tr>
 
213
        <tr>
 
214
          <td></td>
 
215
          <td>)</td>
 
216
          <td></td><td></td><td></td>
 
217
        </tr>
 
218
      </table>
 
219
</div>
 
220
<div class="memdoc">
 
221
<p>Assign the proxy to the object with the given parent and name. </p>
 
222
<dl><dt><b>Parameters:</b></dt><dd>
 
223
  <table border="0" cellspacing="2" cellpadding="0">
 
224
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The parent of the object referred to by <em>name</em>. </td></tr>
 
225
    <tr><td valign="top"></td><td valign="top"><em>rel_path</em>&nbsp;</td><td>The path of the object, relative the parent object, to assign this proxy to. </td></tr>
 
226
  </table>
 
227
  </dd>
 
228
</dl>
 
229
 
 
230
</div>
 
231
</div>
 
232
<a class="anchor" id="ac68e8a0ca5d74961059f4b067f56949f"></a><!-- doxytag: member="peekabot::client::SliderProxy::assign" ref="ac68e8a0ca5d74961059f4b067f56949f" args="(const ObjectProxyBase &amp;p)" -->
 
233
<div class="memitem">
 
234
<div class="memproto">
 
235
      <table class="memname">
 
236
        <tr>
 
237
          <td class="memname"><a class="el" href="classpeekabot_1_1client_1_1DelayedDispatch.html">DelayedDispatch</a> assign </td>
 
238
          <td>(</td>
 
239
          <td class="paramtype">const <a class="el" href="classpeekabot_1_1client_1_1ObjectProxyBase.html">ObjectProxyBase</a> &amp;&nbsp;</td>
 
240
          <td class="paramname"> <em>p</em></td>
 
241
          <td>&nbsp;)&nbsp;</td>
 
242
          <td></td>
 
243
        </tr>
 
244
      </table>
 
245
</div>
 
246
<div class="memdoc">
 
247
<p>Upcast and assign from another proxy. </p>
 
248
<p>If the object pointed to by <em>p</em> is not of compatible type, the assignment will fail and subsequent operations performed on the proxy will fail. </p>
 
249
 
 
250
</div>
 
251
</div>
 
252
<hr/>The documentation for this class was generated from the following files:<ul>
 
253
<li>src/client/proxies/<a class="el" href="SliderProxy_8hh_source.html">SliderProxy.hh</a></li>
 
254
<li>src/client/proxies/SliderProxy.cc</li>
 
255
</ul>
 
256
</div>
 
257
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 30 2011 for peekabot by&nbsp;
 
258
<a href="http://www.doxygen.org/index.html">
 
259
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
 
260
</body>
 
261
</html>