aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxUserControllerHitReport.html
blob: bd4966fe586689527c0beaa7b98088ff73101165 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxUserControllerHitReport 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>PxUserControllerHitReport Class Reference<br>
<small>
[<a class="el" href="group__character.html">Character</a>]</small>
</h1><!-- doxytag: class="PxUserControllerHitReport" -->User callback class for character controller events.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxController_8h-source.html">PxController.h</a>&gt;</code>
<p>

<p>
<a href="classPxUserControllerHitReport-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 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxUserControllerHitReport.html#4f12af437470d8c6dfb3bf8454f000d9">onShapeHit</a> (const <a class="el" href="structPxControllerShapeHit.html">PxControllerShapeHit</a> &amp;hit)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when current controller hits a shape.  <a href="#4f12af437470d8c6dfb3bf8454f000d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxUserControllerHitReport.html#b2340ac48d016da0481c6cb6efda97b9">onControllerHit</a> (const <a class="el" href="structPxControllersHit.html">PxControllersHit</a> &amp;hit)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when current controller hits another controller.  <a href="#b2340ac48d016da0481c6cb6efda97b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxUserControllerHitReport.html#b806ae70badbece00c364a37951cd9b1">onObstacleHit</a> (const <a class="el" href="structPxControllerObstacleHit.html">PxControllerObstacleHit</a> &amp;hit)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when current controller hits a user-defined obstacle.  <a href="#b806ae70badbece00c364a37951cd9b1"></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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxUserControllerHitReport.html#4c9fb318a01f7bc299c29d4ce8038058">~PxUserControllerHitReport</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
User callback class for character controller events. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Character controller hit reports are only generated when move is called.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>PxControllerDesc.callback </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4c9fb318a01f7bc299c29d4ce8038058"></a><!-- doxytag: member="PxUserControllerHitReport::~PxUserControllerHitReport" ref="4c9fb318a01f7bc299c29d4ce8038058" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxUserControllerHitReport::~PxUserControllerHitReport           </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="b2340ac48d016da0481c6cb6efda97b9"></a><!-- doxytag: member="PxUserControllerHitReport::onControllerHit" ref="b2340ac48d016da0481c6cb6efda97b9" args="(const PxControllersHit &amp;hit)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxUserControllerHitReport::onControllerHit           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structPxControllersHit.html">PxControllersHit</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>hit</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Called when current controller hits another controller. 
<p>
<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>hit</em>&nbsp;</td><td>Provides information about the hit.</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllersHit.html" title="Describes a hit between a CCT and another CCT. Passed to onControllerHit().">PxControllersHit</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="b806ae70badbece00c364a37951cd9b1"></a><!-- doxytag: member="PxUserControllerHitReport::onObstacleHit" ref="b806ae70badbece00c364a37951cd9b1" args="(const PxControllerObstacleHit &amp;hit)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxUserControllerHitReport::onObstacleHit           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structPxControllerObstacleHit.html">PxControllerObstacleHit</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>hit</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Called when current controller hits a user-defined obstacle. 
<p>
<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>hit</em>&nbsp;</td><td>Provides information about the hit.</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerObstacleHit.html" title="Describes a hit between a CCT and a user-defined obstacle. Passed to onObstacleHit()...">PxControllerObstacleHit</a> <a class="el" href="classPxObstacleContext.html" title="Context class for obstacles.">PxObstacleContext</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="4f12af437470d8c6dfb3bf8454f000d9"></a><!-- doxytag: member="PxUserControllerHitReport::onShapeHit" ref="4f12af437470d8c6dfb3bf8454f000d9" args="(const PxControllerShapeHit &amp;hit)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxUserControllerHitReport::onShapeHit           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structPxControllerShapeHit.html">PxControllerShapeHit</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>hit</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Called when current controller hits a shape. 
<p>
This is called when the CCT moves and hits a shape. This will not be called when a moving shape hits a non-moving CCT.<p>
<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>hit</em>&nbsp;</td><td>Provides information about the hit.</td></tr>
  </table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerShapeHit.html" title="Describes a hit between a CCT and a shape. Passed to onShapeHit().">PxControllerShapeHit</a> </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxController_8h-source.html">PxController.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>