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/classPxVehicleAutoBoxData.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/classPxVehicleAutoBoxData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleAutoBoxData.html | 338 |
1 files changed, 338 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleAutoBoxData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleAutoBoxData.html new file mode 100644 index 00000000..39ecc1fe --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleAutoBoxData.html @@ -0,0 +1,338 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleAutoBoxData 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>PxVehicleAutoBoxData Class Reference<br> +<small> +[<a class="el" href="group__vehicle.html">Vehicle</a>]</small> +</h1><!-- doxytag: class="PxVehicleAutoBoxData" --><code>#include <<a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.h</a>></code> +<p> + +<p> +<a href="classPxVehicleAutoBoxData-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="classPxVehicleAutoBoxData.html#7cb4c73cc1997ba805a79cb72f230d36">PxVehicleAutoBoxData</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#b58a308ce4750594e3335d953d70281c">setLatency</a> (const PxReal latency)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the latency time of the autobox. <a href="#b58a308ce4750594e3335d953d70281c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#15e62c013c05a2e492ab81144fb32e5c">getLatency</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the latency time of the autobox. <a href="#15e62c013c05a2e492ab81144fb32e5c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#4f2313daab10500b71271d46ebbd0fc5">PxVehicleAutoBoxData</a> (const <a class="el" href="group__foundation.html#g0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#c49aba5e4f725aa26137976c34dcb0d3">getUpRatios</a> (<a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> a) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#8fadedab89e26a913b7c24b312ccf106">setUpRatios</a> (<a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> a, PxReal ratio)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#4fb7d21937add9a843d54eed3161f3c8">getDownRatios</a> (<a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> a) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#a2353fe51236e4d02924eff9bccd94b2">setDownRatios</a> (<a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> a, PxReal ratio)</td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#696b7ff3f8fff200c7b9fc5d28b4bf5f">mUpRatios</a> [PxVehicleGearsData::eGEARSRATIO_COUNT]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Value of ( engineRotationSpeed / <a class="el" href="classPxVehicleEngineData.html#6c95aec1c84e0be6bf3422b5baf63b55" title="Maximum rotation speed of the engine.">PxVehicleEngineData::mMaxOmega</a> ) that is high enough to increment gear. <a href="#696b7ff3f8fff200c7b9fc5d28b4bf5f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#f6b4ebae3f2df08e54ae36406738ed1a">mDownRatios</a> [PxVehicleGearsData::eGEARSRATIO_COUNT]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Value of engineRevs/maxEngineRevs that is low enough to decrement gear. <a href="#f6b4ebae3f2df08e54ae36406738ed1a"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#53e404813e5a6d05f55ef1d2daaa2a79">isValid</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleAutoBoxData.html#a2f8773ce851c65e3c7d31b8991ea8f8">PxVehicleDriveSimData</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="7cb4c73cc1997ba805a79cb72f230d36"></a><!-- doxytag: member="PxVehicleAutoBoxData::PxVehicleAutoBoxData" ref="7cb4c73cc1997ba805a79cb72f230d36" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleAutoBoxData::PxVehicleAutoBoxData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxVehicleComponents_8h-source.html#l00282">PxVehicleGearsData::eGEARSRATIO_COUNT</a>, <a class="el" href="PxVehicleComponents_8h-source.html#l00251">PxVehicleGearsData::eNEUTRAL</a>, and <a class="el" href="PxVehicleComponents_8h-source.html#l00250">PxVehicleGearsData::eREVERSE</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4f2313daab10500b71271d46ebbd0fc5"></a><!-- doxytag: member="PxVehicleAutoBoxData::PxVehicleAutoBoxData" ref="4f2313daab10500b71271d46ebbd0fc5" args="(const PxEMPTY)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxVehicleAutoBoxData::PxVehicleAutoBoxData </td> + <td>(</td> + <td class="paramtype">const </td> + <td class="paramname"> <em>PxEMPTY</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="4fb7d21937add9a843d54eed3161f3c8"></a><!-- doxytag: member="PxVehicleAutoBoxData::getDownRatios" ref="4fb7d21937add9a843d54eed3161f3c8" args="(PxVehicleGearsData::Enum a) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal PxVehicleAutoBoxData::getDownRatios </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> </td> + <td class="paramname"> <em>a</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="15e62c013c05a2e492ab81144fb32e5c"></a><!-- doxytag: member="PxVehicleAutoBoxData::getLatency" ref="15e62c013c05a2e492ab81144fb32e5c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal PxVehicleAutoBoxData::getLatency </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the latency time of the autobox. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Specified in seconds (s).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleAutoBoxData.html#b58a308ce4750594e3335d953d70281c" title="Set the latency time of the autobox.">setLatency</a> </dd></dl> + +<p>References <a class="el" href="PxVehicleComponents_8h-source.html#l00250">PxVehicleGearsData::eREVERSE</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c49aba5e4f725aa26137976c34dcb0d3"></a><!-- doxytag: member="PxVehicleAutoBoxData::getUpRatios" ref="c49aba5e4f725aa26137976c34dcb0d3" args="(PxVehicleGearsData::Enum a) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal PxVehicleAutoBoxData::getUpRatios </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> </td> + <td class="paramname"> <em>a</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="53e404813e5a6d05f55ef1d2daaa2a79"></a><!-- doxytag: member="PxVehicleAutoBoxData::isValid" ref="53e404813e5a6d05f55ef1d2daaa2a79" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxVehicleAutoBoxData::isValid </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a2353fe51236e4d02924eff9bccd94b2"></a><!-- doxytag: member="PxVehicleAutoBoxData::setDownRatios" ref="a2353fe51236e4d02924eff9bccd94b2" args="(PxVehicleGearsData::Enum a, PxReal ratio)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleAutoBoxData::setDownRatios </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> </td> + <td class="paramname"> <em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>ratio</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b58a308ce4750594e3335d953d70281c"></a><!-- doxytag: member="PxVehicleAutoBoxData::setLatency" ref="b58a308ce4750594e3335d953d70281c" args="(const PxReal latency)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleAutoBoxData::setLatency </td> + <td>(</td> + <td class="paramtype">const PxReal </td> + <td class="paramname"> <em>latency</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the latency time of the autobox. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Latency time is the minimum time that must pass between each gear change that is initiated by the autobox. The auto-box will only attempt to initiate another gear change up or down if the simulation time that has passed since the most recent automated gear change is greater than the specified latency.<p> +Specified in seconds (s).</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxVehicleAutoBoxData.html#15e62c013c05a2e492ab81144fb32e5c" title="Get the latency time of the autobox.">getLatency</a> </dd></dl> + +<p>References <a class="el" href="PxVehicleComponents_8h-source.html#l00250">PxVehicleGearsData::eREVERSE</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8fadedab89e26a913b7c24b312ccf106"></a><!-- doxytag: member="PxVehicleAutoBoxData::setUpRatios" ref="8fadedab89e26a913b7c24b312ccf106" args="(PxVehicleGearsData::Enum a, PxReal ratio)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxVehicleAutoBoxData::setUpRatios </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVehicleGearsData.html#31359110050aad08510b99208a304cb7">PxVehicleGearsData::Enum</a> </td> + <td class="paramname"> <em>a</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>ratio</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="a2f8773ce851c65e3c7d31b8991ea8f8"></a><!-- doxytag: member="PxVehicleAutoBoxData::PxVehicleDriveSimData" ref="a2f8773ce851c65e3c7d31b8991ea8f8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="f6b4ebae3f2df08e54ae36406738ed1a"></a><!-- doxytag: member="PxVehicleAutoBoxData::mDownRatios" ref="f6b4ebae3f2df08e54ae36406738ed1a" args="[PxVehicleGearsData::eGEARSRATIO_COUNT]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleAutoBoxData.html#f6b4ebae3f2df08e54ae36406738ed1a">PxVehicleAutoBoxData::mDownRatios</a>[PxVehicleGearsData::eGEARSRATIO_COUNT] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Value of engineRevs/maxEngineRevs that is low enough to decrement gear. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>When ( engineRotationSpeed / <a class="el" href="classPxVehicleEngineData.html#6c95aec1c84e0be6bf3422b5baf63b55" title="Maximum rotation speed of the engine.">PxVehicleEngineData::mMaxOmega</a> ) < mDownRatios[currentGear] the autobox will begin a transition to currentGear-1 unless currentGear is first gear or neutral or reverse.</dd></dl> +<b>Range:</b> [0, 1]<br> + +</div> +</div><p> +<a class="anchor" name="696b7ff3f8fff200c7b9fc5d28b4bf5f"></a><!-- doxytag: member="PxVehicleAutoBoxData::mUpRatios" ref="696b7ff3f8fff200c7b9fc5d28b4bf5f" args="[PxVehicleGearsData::eGEARSRATIO_COUNT]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxReal <a class="el" href="classPxVehicleAutoBoxData.html#696b7ff3f8fff200c7b9fc5d28b4bf5f">PxVehicleAutoBoxData::mUpRatios</a>[PxVehicleGearsData::eGEARSRATIO_COUNT] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Value of ( engineRotationSpeed / <a class="el" href="classPxVehicleEngineData.html#6c95aec1c84e0be6bf3422b5baf63b55" title="Maximum rotation speed of the engine.">PxVehicleEngineData::mMaxOmega</a> ) that is high enough to increment gear. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>When ( engineRotationSpeed / <a class="el" href="classPxVehicleEngineData.html#6c95aec1c84e0be6bf3422b5baf63b55" title="Maximum rotation speed of the engine.">PxVehicleEngineData::mMaxOmega</a> ) > mUpRatios[currentGear] the autobox will begin a transition to currentGear+1 unless currentGear is the highest possible gear or neutral or reverse.</dd></dl> +<b>Range:</b> [0, 1]<br> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxVehicleComponents_8h-source.html">PxVehicleComponents.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> |