aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html
blob: 383ad38fe1bfd5f1319d35b421422a01fd1f532f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxController Class Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxBoxController Class Reference<br>
<small>
[<a class="el" href="group__character.html">Character</a>]</small>
</h1><!-- doxytag: class="PxBoxController" --><!-- doxytag: inherits="PxController" -->Box character controller.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxBoxController_8h-source.html">PxBoxController.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxBoxController:</div>
<div class="dynsection">
<p><center><img src="classPxBoxController__inherit__graph.png" border="0" usemap="#PxBoxController__inherit__map" alt="Inheritance graph"></center>
<map name="PxBoxController__inherit__map">
<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="17,16,100,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxBoxController:</div>
<div class="dynsection">
<p><center><img src="classPxBoxController__coll__graph.png" border="0" usemap="#PxBoxController__coll__map" alt="Collaboration graph"></center>
<map name="PxBoxController__coll__map">
<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="17,16,100,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxBoxController-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxF32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#25c66f4fabdb4d689bc77aba02f66ebd">getHalfHeight</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets controller's half height.  <a href="#25c66f4fabdb4d689bc77aba02f66ebd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxF32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#3e1de6ef41ef607c768012530931cb98">getHalfSideExtent</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets controller's half side extent.  <a href="#3e1de6ef41ef607c768012530931cb98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxF32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#ddbaf29dafa43422705e70449a62a8a1">getHalfForwardExtent</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets controller's half forward extent.  <a href="#ddbaf29dafa43422705e70449a62a8a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#f959bc51b41f2c00156cd28bd19fc240">setHalfHeight</a> (PxF32 halfHeight)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets controller's half height.  <a href="#f959bc51b41f2c00156cd28bd19fc240"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#f1b0b85810c79821ddb61cb42d0ef730">setHalfSideExtent</a> (PxF32 halfSideExtent)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets controller's half side extent.  <a href="#f1b0b85810c79821ddb61cb42d0ef730"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#cae44a6bab0ca9da6d47b84345d03e61">setHalfForwardExtent</a> (PxF32 halfForwardExtent)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets controller's half forward extent.  <a href="#cae44a6bab0ca9da6d47b84345d03e61"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#5182b7d6bd38b10d31ecdc6453b0ecbe">PxBoxController</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#792cdd51d6c3efdf97679f7afb399332">~PxBoxController</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Box character controller. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a> <a class="el" href="classPxController.html" title="Base class for character controllers.">PxController</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="5182b7d6bd38b10d31ecdc6453b0ecbe"></a><!-- doxytag: member="PxBoxController::PxBoxController" ref="5182b7d6bd38b10d31ecdc6453b0ecbe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxBoxController::PxBoxController           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="792cdd51d6c3efdf97679f7afb399332"></a><!-- doxytag: member="PxBoxController::~PxBoxController" ref="792cdd51d6c3efdf97679f7afb399332" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxBoxController::~PxBoxController           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ddbaf29dafa43422705e70449a62a8a1"></a><!-- doxytag: member="PxBoxController::getHalfForwardExtent" ref="ddbaf29dafa43422705e70449a62a8a1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxF32 PxBoxController::getHalfForwardExtent           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets controller's half forward extent. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half forward extent of the controller.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">PxBoxControllerDesc.halfForwardExtent</a> <a class="el" href="classPxBoxController.html#cae44a6bab0ca9da6d47b84345d03e61" title="Sets controller&#39;s half forward extent.">setHalfForwardExtent()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="25c66f4fabdb4d689bc77aba02f66ebd"></a><!-- doxytag: member="PxBoxController::getHalfHeight" ref="25c66f4fabdb4d689bc77aba02f66ebd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxF32 PxBoxController::getHalfHeight           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets controller's half height. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half height of the controller.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">PxBoxControllerDesc.halfHeight</a> <a class="el" href="classPxBoxController.html#f959bc51b41f2c00156cd28bd19fc240" title="Sets controller&#39;s half height.">setHalfHeight()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="3e1de6ef41ef607c768012530931cb98"></a><!-- doxytag: member="PxBoxController::getHalfSideExtent" ref="3e1de6ef41ef607c768012530931cb98" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxF32 PxBoxController::getHalfSideExtent           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets controller's half side extent. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half side extent of the controller.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">PxBoxControllerDesc.halfSideExtent</a> <a class="el" href="classPxBoxController.html#f1b0b85810c79821ddb61cb42d0ef730" title="Sets controller&#39;s half side extent.">setHalfSideExtent()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="cae44a6bab0ca9da6d47b84345d03e61"></a><!-- doxytag: member="PxBoxController::setHalfForwardExtent" ref="cae44a6bab0ca9da6d47b84345d03e61" args="(PxF32 halfForwardExtent)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxBoxController::setHalfForwardExtent           </td>
          <td>(</td>
          <td class="paramtype">PxF32&nbsp;</td>
          <td class="paramname"> <em>halfForwardExtent</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets controller's half forward extent. 
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this doesn't check for collisions.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>halfForwardExtent</em>&nbsp;</td><td>The new half forward extent for the controller. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Currently always true.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">PxBoxControllerDesc.halfForwardExtent</a> <a class="el" href="classPxBoxController.html#ddbaf29dafa43422705e70449a62a8a1" title="Gets controller&#39;s half forward extent.">getHalfForwardExtent()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="f959bc51b41f2c00156cd28bd19fc240"></a><!-- doxytag: member="PxBoxController::setHalfHeight" ref="f959bc51b41f2c00156cd28bd19fc240" args="(PxF32 halfHeight)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxBoxController::setHalfHeight           </td>
          <td>(</td>
          <td class="paramtype">PxF32&nbsp;</td>
          <td class="paramname"> <em>halfHeight</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets controller's half height. 
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this doesn't check for collisions.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>halfHeight</em>&nbsp;</td><td>The new half height for the controller. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Currently always true.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">PxBoxControllerDesc.halfHeight</a> <a class="el" href="classPxBoxController.html#25c66f4fabdb4d689bc77aba02f66ebd" title="Gets controller&#39;s half height.">getHalfHeight()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="f1b0b85810c79821ddb61cb42d0ef730"></a><!-- doxytag: member="PxBoxController::setHalfSideExtent" ref="f1b0b85810c79821ddb61cb42d0ef730" args="(PxF32 halfSideExtent)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PxBoxController::setHalfSideExtent           </td>
          <td>(</td>
          <td class="paramtype">PxF32&nbsp;</td>
          <td class="paramname"> <em>halfSideExtent</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets controller's half side extent. 
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this doesn't check for collisions.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>halfSideExtent</em>&nbsp;</td><td>The new half side extent for the controller. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Currently always true.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">PxBoxControllerDesc.halfSideExtent</a> <a class="el" href="classPxBoxController.html#3e1de6ef41ef607c768012530931cb98" title="Gets controller&#39;s half side extent.">getHalfSideExtent()</a> </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxBoxController_8h-source.html">PxBoxController.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>