diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html | 332 |
1 files changed, 332 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html new file mode 100644 index 00000000..e2c273f3 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPvdSceneClient.html @@ -0,0 +1,332 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPvdSceneClient 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>PxPvdSceneClient Class Reference<br> +<small> +[<a class="el" href="group__pvd.html">Pvd</a>]</small> +</h1><!-- doxytag: class="PxPvdSceneClient" -->Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxPvdSceneClient_8h-source.html">PxPvdSceneClient.h</a>></code> +<p> + +<p> +<a href="classPxPvdSceneClient-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#3b5e6327978fbe7a39fd53478da0c588">setScenePvdFlag</a> (<a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a> flag, bool value)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#74a77b0f48b6d0f9394ed7daa9c2c957">setScenePvdFlags</a> (<a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> flags)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#a001bda702ba5738c182358035f36cc3">getScenePvdFlags</a> () const =0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#566584e2c33cba879612c468a6703ca4">updateCamera</a> (const char *name, const <a class="el" href="classPxVec3.html">PxVec3</a> &origin, const <a class="el" href="classPxVec3.html">PxVec3</a> &up, const <a class="el" href="classPxVec3.html">PxVec3</a> &target)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#1f356a5ae75e8ec68026b3773f0e38ed">drawPoints</a> (const physx::pvdsdk::PvdDebugPoint *points, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#21e113d4a346e863848c6c30d53c594c">drawLines</a> (const physx::pvdsdk::PvdDebugLine *lines, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#2f6ba1cc210504c47594e2143cb64ec9">drawTriangles</a> (const physx::pvdsdk::PvdDebugTriangle *triangles, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#f78c548dbc479e5cc41cd6046f06d390">drawText</a> (const physx::pvdsdk::PvdDebugText &text)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual physx::pvdsdk::PvdClient * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#e1b5736b5b44f33705a406411e3926d2">getClientInternal</a> ()=0</td></tr> + +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPvdSceneClient.html#0f9c59a8675b10a72f6a31f4ebb35897">~PxPvdSceneClient</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Special client for <a class="el" href="classPxScene.html" title="A scene is a collection of bodies, particle systems and constraints which can interact...">PxScene</a>. It provides access to the <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. It also provides simple user debug services that associated scene position such as immediate rendering and camera updates. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="0f9c59a8675b10a72f6a31f4ebb35897"></a><!-- doxytag: member="PxPvdSceneClient::~PxPvdSceneClient" ref="0f9c59a8675b10a72f6a31f4ebb35897" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxPvdSceneClient::~PxPvdSceneClient </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </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="21e113d4a346e863848c6c30d53c594c"></a><!-- doxytag: member="PxPvdSceneClient::drawLines" ref="21e113d4a346e863848c6c30d53c594c" args="(const physx::pvdsdk::PvdDebugLine *lines, PxU32 count)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::drawLines </td> + <td>(</td> + <td class="paramtype">const physx::pvdsdk::PvdDebugLine * </td> + <td class="paramname"> <em>lines</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>count</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> +draw lines on PVD application's DirectX render window +</div> +</div><p> +<a class="anchor" name="1f356a5ae75e8ec68026b3773f0e38ed"></a><!-- doxytag: member="PxPvdSceneClient::drawPoints" ref="1f356a5ae75e8ec68026b3773f0e38ed" args="(const physx::pvdsdk::PvdDebugPoint *points, PxU32 count)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::drawPoints </td> + <td>(</td> + <td class="paramtype">const physx::pvdsdk::PvdDebugPoint * </td> + <td class="paramname"> <em>points</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>count</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> +draw points on PVD application's DirectX render window +</div> +</div><p> +<a class="anchor" name="f78c548dbc479e5cc41cd6046f06d390"></a><!-- doxytag: member="PxPvdSceneClient::drawText" ref="f78c548dbc479e5cc41cd6046f06d390" args="(const physx::pvdsdk::PvdDebugText &text)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::drawText </td> + <td>(</td> + <td class="paramtype">const physx::pvdsdk::PvdDebugText & </td> + <td class="paramname"> <em>text</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +draw text on PVD application's DirectX render window +</div> +</div><p> +<a class="anchor" name="2f6ba1cc210504c47594e2143cb64ec9"></a><!-- doxytag: member="PxPvdSceneClient::drawTriangles" ref="2f6ba1cc210504c47594e2143cb64ec9" args="(const physx::pvdsdk::PvdDebugTriangle *triangles, PxU32 count)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::drawTriangles </td> + <td>(</td> + <td class="paramtype">const physx::pvdsdk::PvdDebugTriangle * </td> + <td class="paramname"> <em>triangles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>count</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> +draw triangles on PVD application's DirectX render window +</div> +</div><p> +<a class="anchor" name="e1b5736b5b44f33705a406411e3926d2"></a><!-- doxytag: member="PxPvdSceneClient::getClientInternal" ref="e1b5736b5b44f33705a406411e3926d2" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual physx::pvdsdk::PvdClient* PxPvdSceneClient::getClientInternal </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +get the underlying client, for advanced users +</div> +</div><p> +<a class="anchor" name="a001bda702ba5738c182358035f36cc3"></a><!-- doxytag: member="PxPvdSceneClient::getScenePvdFlags" ref="a001bda702ba5738c182358035f36cc3" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> PxPvdSceneClient::getScenePvdFlags </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 PVD flags. See PxPvdSceneFlags. +</div> +</div><p> +<a class="anchor" name="3b5e6327978fbe7a39fd53478da0c588"></a><!-- doxytag: member="PxPvdSceneClient::setScenePvdFlag" ref="3b5e6327978fbe7a39fd53478da0c588" args="(PxPvdSceneFlag::Enum flag, bool value)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::setScenePvdFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxPvdSceneFlag.html#fa6d3e9f667028233457051fe78042bd">PxPvdSceneFlag::Enum</a> </td> + <td class="paramname"> <em>flag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>value</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> +Sets the PVD flag. See <a class="el" href="structPxPvdSceneFlag.html" title="PVD scene Flags.">PxPvdSceneFlag</a>. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>Flag to set. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value the flag gets set to. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="74a77b0f48b6d0f9394ed7daa9c2c957"></a><!-- doxytag: member="PxPvdSceneClient::setScenePvdFlags" ref="74a77b0f48b6d0f9394ed7daa9c2c957" args="(PxPvdSceneFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::setScenePvdFlags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxPvdSceneFlags</a> </td> + <td class="paramname"> <em>flags</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the PVD flags. See PxPvdSceneFlags. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Flags to set. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="566584e2c33cba879612c468a6703ca4"></a><!-- doxytag: member="PxPvdSceneClient::updateCamera" ref="566584e2c33cba879612c468a6703ca4" args="(const char *name, const PxVec3 &origin, const PxVec3 &up, const PxVec3 &target)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxPvdSceneClient::updateCamera </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>origin</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>up</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>target</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> +update camera on PVD application's DirectX render window +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxPvdSceneClient_8h-source.html">PxPvdSceneClient.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> |