diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html | 331 |
1 files changed, 331 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html new file mode 100644 index 00000000..264eb691 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxObstacleContext.html @@ -0,0 +1,331 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxObstacleContext 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> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxObstacleContext Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxObstacleContext" -->Context class for obstacles. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxControllerObstacles_8h-source.html">PxControllerObstacles.h</a>></code> +<p> + +<p> +<a href="classPxObstacleContext-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#53b1408cf617fc505dc1bbf19f94f1ff">PxObstacleContext</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#df341c13bb11532604ee7012228061f6">~PxObstacleContext</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#af653d99de6f092896cc1baa2a4e99c2">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases the context. <a href="#af653d99de6f092896cc1baa2a4e99c2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxControllerManager.html">PxControllerManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#9390f860fb489f283c9f872af2777123">getControllerManager</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the controller manager associated with this context. <a href="#9390f860fb489f283c9f872af2777123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#106c0261677ccf7ef0959e1fde761ef3">addObstacle</a> (const <a class="el" href="classPxObstacle.html">PxObstacle</a> &obstacle)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an obstacle to the context. <a href="#106c0261677ccf7ef0959e1fde761ef3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#3ea7ddb35145ea2ca1184ae7d8ce7b15">removeObstacle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an obstacle from the context. <a href="#3ea7ddb35145ea2ca1184ae7d8ce7b15"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#73ea47d73adaeda1228fd5030ee8cdd2">updateObstacle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle, const <a class="el" href="classPxObstacle.html">PxObstacle</a> &obstacle)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates data for an existing obstacle. <a href="#73ea47d73adaeda1228fd5030ee8cdd2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#e55da4495a10d1c310068e23d87ce7d5">getNbObstacles</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of obstacles in the context. <a href="#e55da4495a10d1c310068e23d87ce7d5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#228a7b8cb5900251d7888ee0f4d912cd">getObstacle</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> i) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves desired obstacle. <a href="#228a7b8cb5900251d7888ee0f4d912cd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxObstacleContext.html#fa8438d6cdc3d82375944d7ca126487a">getObstacleByHandle</a> (<a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> handle) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves desired obstacle by given handle. <a href="#fa8438d6cdc3d82375944d7ca126487a"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Context class for obstacles. +<p> +An obstacle context class contains and manages a set of user-defined obstacles.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxObstacle.html" title="A box obstacle.">PxBoxObstacle</a> <a class="el" href="classPxCapsuleObstacle.html" title="A capsule obstacle.">PxCapsuleObstacle</a> <a class="el" href="classPxObstacle.html" title="Base class for obstacles.">PxObstacle</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="53b1408cf617fc505dc1bbf19f94f1ff"></a><!-- doxytag: member="PxObstacleContext::PxObstacleContext" ref="53b1408cf617fc505dc1bbf19f94f1ff" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxObstacleContext::PxObstacleContext </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="df341c13bb11532604ee7012228061f6"></a><!-- doxytag: member="PxObstacleContext::~PxObstacleContext" ref="df341c13bb11532604ee7012228061f6" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxObstacleContext::~PxObstacleContext </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="106c0261677ccf7ef0959e1fde761ef3"></a><!-- doxytag: member="PxObstacleContext::addObstacle" ref="106c0261677ccf7ef0959e1fde761ef3" args="(const PxObstacle &obstacle)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> PxObstacleContext::addObstacle </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxObstacle.html">PxObstacle</a> & </td> + <td class="paramname"> <em>obstacle</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Adds an obstacle to the context. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>obstacle</em> </td><td>Obstacle data for the new obstacle. The data gets copied.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Handle for newly-added obstacle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9390f860fb489f283c9f872af2777123"></a><!-- doxytag: member="PxObstacleContext::getControllerManager" ref="9390f860fb489f283c9f872af2777123" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxControllerManager.html">PxControllerManager</a>& PxObstacleContext::getControllerManager </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the controller manager associated with this context. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The associated controller manager </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e55da4495a10d1c310068e23d87ce7d5"></a><!-- doxytag: member="PxObstacleContext::getNbObstacles" ref="e55da4495a10d1c310068e23d87ce7d5" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxObstacleContext::getNbObstacles </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves number of obstacles in the context. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of obstacles in the context </dd></dl> + +</div> +</div><p> +<a class="anchor" name="228a7b8cb5900251d7888ee0f4d912cd"></a><!-- doxytag: member="PxObstacleContext::getObstacle" ref="228a7b8cb5900251d7888ee0f4d912cd" args="(PxU32 i) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a>* PxObstacleContext::getObstacle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>i</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves desired obstacle. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>i</em> </td><td>Obstacle index</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired obstacle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fa8438d6cdc3d82375944d7ca126487a"></a><!-- doxytag: member="PxObstacleContext::getObstacleByHandle" ref="fa8438d6cdc3d82375944d7ca126487a" args="(ObstacleHandle handle) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const <a class="el" href="classPxObstacle.html">PxObstacle</a>* PxObstacleContext::getObstacleByHandle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves desired obstacle by given handle. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>handle</em> </td><td>Obstacle handle</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired obstacle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="af653d99de6f092896cc1baa2a4e99c2"></a><!-- doxytag: member="PxObstacleContext::release" ref="af653d99de6f092896cc1baa2a4e99c2" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxObstacleContext::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases the context. +<p> + +</div> +</div><p> +<a class="anchor" name="3ea7ddb35145ea2ca1184ae7d8ce7b15"></a><!-- doxytag: member="PxObstacleContext::removeObstacle" ref="3ea7ddb35145ea2ca1184ae7d8ce7b15" args="(ObstacleHandle handle)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxObstacleContext::removeObstacle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Removes an obstacle from the context. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>handle</em> </td><td>Handle for the obstacle object that needs to be removed.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl> + +</div> +</div><p> +<a class="anchor" name="73ea47d73adaeda1228fd5030ee8cdd2"></a><!-- doxytag: member="PxObstacleContext::updateObstacle" ref="73ea47d73adaeda1228fd5030ee8cdd2" args="(ObstacleHandle handle, const PxObstacle &obstacle)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxObstacleContext::updateObstacle </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__character.html#g55edbbb581808808c8e160e9608d8790">ObstacleHandle</a> </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxObstacle.html">PxObstacle</a> & </td> + <td class="paramname"> <em>obstacle</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Updates data for an existing obstacle. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>handle</em> </td><td>Handle for the obstacle object that needs to be updated. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>obstacle</em> </td><td>New obstacle data</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxControllerObstacles_8h-source.html">PxControllerObstacles.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 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> |